Cronfig within Mautic

Cron job configuration made easy

Mautic requires to trigger the background tasks. If you hate crontab configuration or you always forget what cron service you've used and how to edit it after a couple of months, welcome on board. That's the reason why I created Cronfig!

With the Mautic plugin you can configure, maintain and see the logs directly within your Mautic. No advanced technical skills required. The plugin will communicate with our Cronfig API server and the server will then trigger the tasks for you.

Cronig Monitoring

Monitoring

Because Cronfig triggers your Mautic tasks every few minutes, it knows when something goes wrong. If your Mautic will not be available for whatever reason, Cronfig will send you an email about it. If there will be an error while running some background task, Cronfig will scan the output and if it will look like an error message, Cronfig will let you know about it. This way you will find out that your campaign stopped working before your leads do.

(Monitoring is still under development)

Cronfig is secure

All communication between Cronfig.io and your Mautic is secured via HTTPS. The Mautic plugin provides a public URL address to run the Mautic background tasks, but it is protected with a unique hash. This hash is generated the first time you log into the Cronfig dashboard.

The Cronfig account registration doesn't require any username or password. It will generate an API key to log in and send it to your inbox. So the API key is as secure as your email inbox.

Cronfig is simple

Creating tasks is as simple as click on a button. Everything else is pre-defined by the Mautic plugin and prepared for you to send those information to Cronfig server to start periodically executing the tasks.

The authorization process was made as simple as possible. The Cronfig account requires only your email address. The Cronfig API key will be sent to your email address and you'll be able to log in to your Cronfig account within the Mautic-Cronfig plugin. Your Mautic will remember the API key for the future logins.

If you no longer want to use Cronfig, the account and all automated tasks can be deleted for good with a link provided in the registration email.

Cronfig is free

The basic usage is free forever. That requires 3 cron tasks running every 30 minutes. That is all you need for the basic Mautic functionality. The plugin is open source () so you can see how it works and even suggest some code changes. Advanced paid plans will come soon.

Plans

  • Free
  • $ 0 / year
  • 3 taks
  • 30 min period
  • 1,000 chars log lenth
  • 5 s request timeout
  • 10 errors in the row
  • Install
  • Basic
  • $ 40 / year
  • 10 taks
  • 5 min period
  • 5,000 chars log lenth
  • 30 s request timeout
  • 50 errors in the row
  • Upgrade
  • Pro
  • $ 60 / year
  • 100 taks
  • 1 min period
  • 10,000 chars log lenth
  • 240 s request timeout
  • 100 errors in the row
  • Upgrade

How to integrate your Mautic with Cronfig

Plugin installation

  1. Download the plugin
  2. Unzip the downloaded package.
  3. Upload the unzipped folder to the plugins folder and rename it to CronfigBundle the way you could locate CronfigBundle.php file on this path: plugins/CronfigBundle/CronfigBundle.php.
  4. Clear Mautic's cache. Either run app/console cache:clear command in the Mautic's root dir or simply delete the content of app/cache dir.
  5. Go to the right hand side Mautic menu (click the cog icon in the top right corner to slide the menu out) and go to Plugins.
  6. Click the Install/Upgrade Plugins button. The Cronfig icon should appear in the list of plugins.
  7. Go to the right hand side Mautic menu again. A new menu item called Cronfig should be there. Hit it. A register/login screen should appear.
  8. Your email should be prefilled. Click on the Register button and check your email inbox. Your API key should appear in your inbox any second.
  9. If you received the Cronfig registration email, copy the API key from it, insert it to the Log in input and log in.

Cronfig configuration

After the successful plugin installation create a Cronfig Account. All you need is an email address which is pre-filled from your Mautic user account for convenience. When you click the Register button, you'll get your API key to your inbox. Copy that API key and log in with it.

Cronfig login/registration

When you log in, you'll see your account details and predefined tasks prepared for your Mautic instance. You can activate them with a click to the Create button.

Cronfig pre-defined tasks

That's pretty much it. Then you can watch when the task will run and you'll see log of last 10 jobs. Each job shows details like when, how long it was running, if the execution was successful and what was the output.

Cronfig running tasks with jobs

How it works?

Mautic needs to be poked periodically so it could perform background tasks which does the automation tasks like executing campaign actions in the right time or tasks which would take too long to perform when clicking in the UI like import or email sending. But you already know that and that's why you are interested in Cronfig.

  1. When you install the Cronfig plugin to your Mautic it will allow you to create a new account and tasks which you want to execute periodically.
  2. The information will get stored into database server.
  3. A worker is periodically checking if there is some task which should be triggered at the moment.
  4. If there is some, it will create a HTTP call to the Cronfig plugin installed in your Mautic.
  5. Cronfig plugin will trigger the task similarily like you would do executing the command via CLI.
  6. Cronfig worker waits for certain time for a response of the command. If there is, it will store it to Cronfig database server so you could view it in the Cronfig plugin user interface or get notified if it fails for several times in the row.

Contact

John Linhart

John

Maybe you know me from the Mautic community. I'm one of the Mautic core developers and I created Cronfig as a side project because I saw how many Mauticans struggle with the cron configuration.

Contact form