README

A tool for automated deployment of Laravel applications using HTTP.

This library is for those that have to deploy Laravel applications on shared hosting without SSH access and don't want to use FTP or GIT.

If you want to use FTP and/or GIT check these libraries:

Remote Installation

On the server where the application is going to be deployed, you need to drop the deploy.php file at a public accessible directory (e.g. public_html) with 0644 permissions.

You will also need to create a configuration file. By default the file should be called deploy_config.ini and be located in the same directory as the script. Example configuration file:

auth_key = YOUR_AUTH_KEY

Where auth_key is a unique key that will be used for authentication. So, your configuration file should have 0640 permissions.

Local Installation

In order to install Laravel HTTP Deployer locally (development environment), just add

"mayconbordin/laravel-http-deployer": "0.1"

to your composer.json. Then run composer install or composer update.

Then in your config/app.php add

'Mayconbordin\LaravelHttpDeployer\LaravelHttpDeployerServiceProvider'

in the providers array.

Configuration

You will also need to create a file with the deployment configuration. It's a YAML file that should look something like this:

deployments:
  application:
    auth_key: AUTH_KEY
    version_filename: version
    
    remote:
      url: http://localhost
      endpoint: /deploy.php
      target: /home/user/app
      temp_dir: /home/user/tmp
      history_dir: /home/user/tmp/old_deployments

    local:
      path: .
      temp_dir: /tmp

    ignore:
      - .git*
      - bower_components
      - node_modules
      - .idea
      - deploy
      - deployment.*
      - storage/app/*
      - storage/framework/cache/*
      - storage/framework/sessions/*
      - storage/framework/views/*
      - storage/logs/*
      - .env*

    extra_files:
      'deploy/env_file': ./.env
      
    before_scripts:
      - composer install --no-dev
      - php artisan optimize
      - grunt

The deployments section can have multiple entries, each one describing one deployment configuration. The auth_key is a string that will be used to authenticate the deployment with the server, choose it carefully. The version_filename is the name of the version file used to control the deployment version.

In the remote section you specify the host where the deployment is going to occurr by setting the url, whereas the endpoint points to the path where the deploy.php can be accessed externally. The target is the full path to the installation directory on the server. The temp_dir will be used for extracting the package prior to installation and the history_dir is going to store the older deployment versions.

In the local section you only specify the path to the application, the default value is the current directory (.), and the temp_dir for storing the packaged application for deployment.

Files can be excluded from the package by using the ignore list, the patterns are those from the tar command.

The extra_files is a list of key/value pairs, where the key is the current file location and the value is the location of the file in the package. You can use it to include configuration files only meant for deployment, like the .env file. You have to prefix the target location with ./.

The before_scripts can be used to run commands locally before packaging the application for deployment, like tasks for compressing CSS and JS files, removing development libraries, etc.

Obs.: all paths are relative to the current working directory. Preferably the root of your project.

Usage

Deploy

To deploy your application run:

php artisan deploy deployment.yaml

You can also choose which deployment you want to execute:

php artisan deploy deployment.yaml application

And if you only want to package the application without deploying it:

php artisan deploy --package-only deployment.yaml

Rollback

To rollback to a previous deployment version:

php artisan deploy:rollback deployment.yaml

And to rollback (or forward) to a specific version:

php artisan deploy:rollback deployment.yaml 5

You can also choose which deployment you want to rollback:

php artisan deploy deployment.yaml 5 application

Status

To see which version is deployed on the remote server as well as all available versions in the history directory: