Automate

Automate allows you to automate your deployments to remote Linux servers simply. You can use Automate from your workstation or through an integration server like Github or Gitlab-ci.

1. Installation

You can download the latest version of Automate with the following command:

curl -sS https://www.automate-deployer.com/install | bash

The command will verify your PHP settings and launch the download in the current directory.

Please note that this command is compatible with Linux and macOS systems. If you are using Windows, you will need to download the .phar file manually from github.

2. Creating your configuration file

Foremost, you have to create a configuration file for Automate. This file is usually located at the root of your project. The name of this file must be .automate.yml.

Here is an example file:

repository: git@github.com:symfony/symfony-demo.git
platforms:
    development:
        default_branch: dev
        max_releases: 3
        servers:
            dev-exemple-front-01:
                host: dev.exemple.com
                user: automate
                password: "%dev_password%"
                path: /home/wwwroot/
                port: 22
    production:
        default_branch: master
        max_releases: 3
        servers:
            prod-exemple-front-01:
                host: prod-1.exemple.com
                user: automate
                password: "%prod_password%"
                path: /home/wwwroot/
            prod-exemple-front-02:
                host: prod-2.exemple.com
                user: automate
                ssh_key: /path/to/key
                path: /home/wwwroot/
shared_files:
    - .env.local
shared_folders:
    - app/data
pre_deploy:
    - "php -v"
on_deploy:
    - "composer install"
post_deploy:
    - cmd: "php bin/console doctrine:schema:update --force"
      only: [ dev-exemple-front-01, prod-exemple-front-01]

3. Launching a deployment

The following command allows you to launch the deployment on remote server(s)

automate deploy development master

automate deploy ‹platform› [gitref] -c [path_of_config_file]

• platform

The target platform name (e.g. development)

• gitref (optional)

The branch, the tag, or the commit to be deployed.
By default Automate will use the « default_branch » in the configuration file

• -c [path_of_config_file] (optional)

By default, Automate will search for the file .automate.yml in the current directory. You can specify it with the option -c /path/to/.automate.yml

4. Server Configuration

Automate will create the following directory structure to the remote server:

/your/project/path
   /releases
      /2024.04.22-1302.159
         .env.local --> /your/project/path/shared/.env.local
         /app
            /data --> /your/project/path/shared/app/data

   /shared_files
         .env.local #the real file is here
         /app
            /data #the real folder is here

   current -> /your/project/path/releases/2024.04.22-1302.159

This is the schema of all your project’s architecture
You have to target your domain name inside the folder /your/project/path/current/.