Installation


Requirements

Requirements for your server environment and Laravel application.

  • PHP >= 7.1
  • Laravel >= 5.5

Setting up your first project

First you'll need to create an account with Cronboard. You can visit https://cronboard.io/register to register a new account.

After your account has created you'll be able to see an API token that has been generated for you. Copy that and keep it handy for the next step in the installation.

Installing the package

First you need to pull in the package using Composer:

composer require cronboard-io/cronboard-laravel

Once the package has been installed you can login to your Cronboard account. You'll see instructions on how to install your first project.

The one and only step is to run the provided installation command e.g.

php artisan cronboard:install [token]

This will create a new project in Cronboard for your Laravel application. Your application's name app.name will be used to initialize the project, but you can change that at any later point though the Cronboard interface.

{info} You can always create a new project manually, generate a token for it and add it as CRONBOARD_TOKEN in your .env file.

Checking the integration status

You can always check the status of your Cronboard integration by running:

php artisan cronboard:status

It is recommended that you publish the configuration using:

php artisan vendor:publish --provider="Cronboard\CronboardServiceProvider"

That will add a config/cronboard.php file in your Laravel configuration directory.