deployer/docs/getting-started.md

Getting Started

What are we going to do in this tutorial:

• Provision a new server.
• Configure a deployment.
• Automate deployment via GitHub Actions.

Tutorial duration: 10 min

First, install the Deployer:

curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep

Now lets cd into the project repo and run following command:

dep init

Deployer will ask you a few question and after finishing you will have a deploy.php or deploy.yaml file.

All framework recipes based on common recipe.

Provision

:::note If you already have configured webserver you may skip to deployment. :::

Now let's create a new VPS on Linode, DigitalOcean, Vultr, AWS, GCP, etc.

Make sure what image is Ubuntu 20.04 LTS as this version is supported via Deployer provision recipe.

Configure Reverse DNS or RDNS on your server, this will allow you to ssh into server using domain name instead of IP address.

Now let's provision our server.

dep provision -o remote_user=root

We added -o remote_user=root to make Deployer use root user to connect to host for provisioning.

Deployer will ask you a few questions during provisioning like php version, database type, etc.

Provision will take around ~5min and install everything we need to run a site. Also, it will configure deployer user what we need to use to ssh to our host and a new website was configured at deploy_path.

After we have configured webserver let's deploy the project.

Deploy

To deploy the project:

dep deploy

Ssh to host, for example, for editing .env file.

dep ssh

Let's add a build step on our host:

task('build', function () {
    cd('{{release_path}}');
    run('npm install');
    run('npm run prod');
});

after('deploy:update_code', 'build');

Deployer has a useful task for examine what is currently deployed.

$ dep releases
task releases
+---------------------+--------- deployer.org -------+--------+-----------+
| Date (UTC)          | Release     | Author         | Target | Commit    |
+---------------------+-------------+----------------+--------+-----------+
| 2021-11-05 14:00:22 | 1 (current) | Anton Medvedev | HEAD   | 943ded2be |
+---------------------+-------------+----------------+--------+-----------+

:::tip During development dep push task maybe useful. :::

Deploy on push

Not let's use GitHub Action for Deployer.

Create .github/workflows/deploy.yml file with following content:

name: deploy

on:
  push:
    branches: [ master ]

concurrency: production_environment

jobs:
  deploy:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v2
  
    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: '8.0' 

    - name: Deploy
      uses: deployphp/action@v1
      with:
        private-key: ${{ secrets.PRIVATE_KEY }}
        dep: deploy

:::warning The concurrency: production_environment is important as it prevents concurrent deploys. :::