Laravel Envoy Deploy
This repository includes an Envoy.blade.php script that is designed to provide a basic "zero-downtime" deployment option using the open-source Laravel Envoy tool.
Requirements
This Envoy script is designed to be used with Laravel 5 projects and can be used within the Laravel root, or downloaded separately and included in your Laravel project.
Installation
Your must have Envoy installed using the Composer global command:
composer global require "laravel/envoy=~1.0"
Standalone
To download and run out-with your Laravel project, clone this directory and do a composer install.
Laravel
To use within an existing Laravel 5 project, you simply need to download the Envoy.blade.php file to your project root:
wget https://raw.githubusercontent.com/papertank/envoy-deploy/master/Envoy.blade.php
Setup
Config
Envoy Deploy uses DotEnv to fetch your server and repository details. If you are installing within a Laravel project, there will already be a .env file in the root, otherwise simply create one.
The following configuration items are required:
DEPLOY_SERVERDEPLOY_REPOSITORYDEPLOY_PATH
For example, deploying the standard Laravel repository on a Forge server, we might use:
DEPLOY_SERVER=forge@example.com
DEPLOY_REPOSITORY=https://github.com/laravel/laravel.git
DEPLOY_PATH=/home/forge/example.com
The DEPLOY_PATH (server path) should already be created in your server and must be a blank directory.
Host
Envoy Deploy uses symlinks to ensure that your server is always running from the latest deployment. As such you need to setup your Apache or Nginx host to point towards the host/current/public directory rather than simply host/public.
For example:
server {
listen 80;
server_name example.com;
root /home/forge/example.com/current/public;
location / {
try_files $uri $uri/ /index.php?$query_string;
}
location ~ \.php$ {
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
}
location ~ /\.ht {
deny all;
}
}
Usage
Init
When you're happy with the config, run the init task on your local machine by running the following.
envoy run init
You can specify the Laravel environment (for artisan:migrate command) and git branch as options
envoy run init --branch=develop --env=development
You only need to run the init task once.
The init task creates a .env file in your root path (from your .env.example file), so make sure and update the environment variables appropriately.
Deploy
Each time you want to deploy simply run the deploy task on your local machine in the repository direcory
envoy run deploy
You can specify the Laravel environment (for artisan:migrate command) and git branch as options
envoy run deploy --branch=develop --env=development
Deploy with Cleanup
If you could like to deploy your repository and cleanup any old deployments at the same time, you can run
envoy run deploy --cleanup
Or alternatively, if you need to:
This will run the deploy script and then delete any old deployments older than 48 hours, limiting the number deleted to 5.
You can also run the cleanup script independently (without deploying) using
envoy run deployment_cleanup
Commands
#### envoy run init
Initialise server for deployments
Options --env=ENVIRONMENT The environment to use. (Default: "production") --branch=BRANCH The git branch to use. (Default: "master")
envoy run deploy
Run new deployment
Options --env=ENVIRONMENT The environment to use. (Default: "production") --branch=BRANCH The git branch to use. (Default: "master") --cleanup Whether to cleanup old deployments
envoy run deployment_cleanup
Delete any old deployments older than 48 hours, limiting the number deleted to 5 (by default).
How it Works
Your $path directory will look something like this after you init and then deploy.
20150317110501/
20150317114500/
current -> ./20150317114500
storage/
.env
As you can see, the current directory is symlinked to the latest deployment folder
Inside one of your deployment folders looks like the following (excluded some laravel folders for space)
app/
artisan
boostrap/
composer.json
.env -> ../.env
storage -> ../storage
vendor/
The deployment folder .env file and storage directory are symlinked to the parent folders in the main (parent) path.
Disclaimer
Before using on live server, it is best to test on a local VM (like Laravel Hometead) first.
Changes
v2.0 - Switched to using DotEnv (removing envoy.config.php) and cleaned up tasks/stories.
v1.0.1 - Added cleanup task and deploy_cleanup macro after changing cleanup command.
Contributing
Please submit improvements and fixes :)
Credits
- Servers for Hackers for inspiration
- @noeldiaz on Laracasts for deployment cleanups idea
- Harmen Stoppels for cloning HEAD only