On this page

Deploy a Laravel application

Overview

Laravel applications almost work out of the box on Clever Cloud, you just have a few adjustments to make.

Create an application on Clever Cloud

via the web console

Refer to our getting started for more details on application creation via the console.

via the Clever Tools CLI

  1. Make sure you have clever-tools installed locally or follow our CLI getting started guide.
  2. In your code folder, do clever create --type <type> <app-name> --region <zone> --org <org> where :
    1. type is the type of technology you rely on
    2. app-name the name you want for your application,
    3. zone deployment zone (par for Paris and mtl for Montreal)
    4. org the organization ID the application will be created under.

Refer to clever create for more details on application creation with Clever Tools.

Setting up environment variables on Clever Cloud

With the Clever Cloud console

  1. Go to the Clever Cloud console, and find the app you want to fine tune under it’s organization.
  2. Find the Environment variables menu and select it.
  3. In this menu, you will see a form with VARIABLE_NAME and variable value fields.
  4. Fill them with the desired values then select Add.
  5. Don’t forget to “Update Changes” at the end of the menu.

With the Clever Tools CLI

  1. Make sure you have clever-tools installed locally. Refer to our CLI getting started.
  2. In your code folder, do clever env set <variable-name> <variable-value>

Refer to environment variables reference for more details on available environment variables on Clever Cloud.

You can of course create custom ones with the interface we just demonstrated, they will be available for your application.

Configure your Laravel application

Configure DocumentRoot

Add a new environment variable called CC_WEBROOT and set /public as its value.

clever env set CC_WEBROOT /public

Configure your application key

Locally, run php artisan key:generate. It should output something like base64:tQbFzxwUfOfKKqNlbjXuduwaUFDQUy+NL8DBfgb3o3s=. Copy this value and add an environment variable named APP_KEY, with this value.

Make sure config/app.php contains the following line:

  'key' => env('APP_KEY'),

Configure monolog to use syslog

In your environment variables, add the LOG_CHANNEL=syslog environment variable. This will allow you to read your application logs directly from the console or the CLI tool.

Make sure config/logging.php contains the following line:

  'default' => env('LOG_CHANNEL', 'stack'),

Optional: configure the front-end build

If you need to build your frontend assets (eg. javascript or CSS files), you can either add it as a step in your composer file, or you can add a post build hook with the CC_POST_BUILD_HOOK environment variable.

For example, if you launch the build with npm run prod: CC_POST_BUILD_HOOK=npm install && npm run prod.

Monitor your application with New Relic

You can use New Relic to monitor your application on Clever Cloud.

Please refer to our New Relic documentation to configure it for your application.

Environment injection

Clever Cloud injects environment variables from your application settings as mentioned in setting up environment variables and is also injecting in your application production environment, those from your linked add-ons.

Linking a database or any other add-on to your application

By linking an application to an add-on, the application has the add-on environment variables in its own environment by default.

On add-on creation

Many add-ons do exist on Clever Cloud, please refer to the full list and check add-ons dedicated pages for full instructions.

During add-on creation, you will see Applications screen, with a list of your applications. You can toggle the button to Link and click next. If you finish the process of add-on creation, the application will automatically be linked to it.

Add-on already exists

In the Clever Cloud console, under the Service Dependencies menu of your application, you can use the Link addons dropdown menu to select the name of the add-on you want to link and use the add button to finish the process.

You can also link another application from the same page in the Clever Cloud console, using the Link applications dropdown menu.

Configure your database

Make sure you have created a database add-on in the Clever Cloud console, and that it’s linked to your application. When it’s done, edit config/database.php to set the correct environment variable names (MYSQL_ADDON_xxx instead of DB_xxx for a mysql database).

For instance for MySQL:

   // ...
   'connections' => [
     // ...
        'mysql' => [
            'driver' => 'mysql',
            'host' => env('MYSQL_ADDON_HOST', '127.0.0.1'),
            'port' => env('MYSQL_ADDON_PORT', '3306'),
            'database' => env('MYSQL_ADDON_DB', 'forge'),
            'username' => env('MYSQL_ADDON_USER', 'forge'),
            'password' => env('MYSQL_ADDON_PASSWORD', ''),
            'unix_socket' => env('DB_SOCKET', ''),
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
            'prefix' => '',
            'strict' => true,
            'engine' => null,
        ],
    // ...
    ]
  // ...

Optional: automatically run migrations upon deployment

If you want to have database migrations automatically run during each deployment, add this hook instruction to the application’s environment variables CC_POST_BUILD_HOOK=php artisan migrate --force

Configure storage

Create a FS Bucket add-on and link it to your application. Note its host (you can see it from the addon configuration panel, or in the environment variables exported by the addon). It looks like bucket-01234567-0123-0123-0123-012345678987-fsbucket.services.clever-cloud.com.

Create a new environment variable called CC_FS_BUCKET and set /storage/app:<bucket-host> as its value.

Optional: configure task scheduling

If your app uses task scheduling, you need to configure a cron to run the scheduling process:

  1. Create a clevercloud/cron.json file in your project, containing:
[
    "* * * * * $ROOT/clevercloud/cron.sh"
]

This installs a cron that will run clevercloud/cron.sh every minute.

  1. Create a clevercloud/cron.sh file in your project (with execute permissions), containing:
#!/bin/bash -l
set -euo pipefail

pushd "$APP_HOME"
php artisan schedule:run >> /dev/null 2>&1

Note: the PHP CLI process will use a memory_limit configuration value that depends on the instance’s size (you can check it by connecting to your app using SSH and running php -i). If one of your scheduled tasks needs to allocate more memory than this limit, the php artisan schedule:run process will silently crash. To allow it to use more memory, you can call ini_set() inside a php_sapi_name() === 'cli' condition from an early hook to the app’s lifecycle (like the AppServiceProvider). See this Gist for an example implementation.

Git Deployment on Clever Cloud

You need Git on your computer to deploy via this tool. Here is the official website of Git to get more information: git-scm.com

Setting up your remotes

  1. The “Information” page of your app gives you your Git deployment URL, it looks like this:

    1. git+ssh://[email protected]/<your_app_id>.git
    2. Copy it in your clipboard

  2. Locally, under your code folder, type in git init to set up a new git repository or skip this step if you already have one

  3. Add the deploy URL with git remote add <name> <your-git-deployment-url>

  4. Add your files via git add <files path> and commit them via git commit -m <your commit message>

  5. Now push your application on Clever Cloud with git push <name> master

Refer to git deployments for more details.

FTP Deployment

Make sure you have Filezilla or an other FTP software installed in your machine.

When you have chosen to deploy your application via FTP at the application creation, a free FS Bucket has been created with an ID matching your application’s ID.

You will find the FTP credentials in the configuration tab of this particular FS Bucket.

Just follow the instructions of your FTP Software to send code to Clever Cloud.

Refer to our Quick Start - FTP deployment for more details.

More configuration

Need more configuration? To run a script at the end of your deployment? To add your private SSH key to access private dependencies?

Go check the Common configuration page.

You may want to have an advanced usage of your application, in which case we recommend you to read the Administrate documentation section.

If you can’t find something or have a specific need like using a non supported version of a particular software, please reach out to the support.

Comments