Skip to content
Deploys apps using shell scripts, rsync, and tarballs.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.header.png
LICENSE
README.markdown
deploy-app
deploy.sh

README.markdown

close enough to a logo I guess

This builds, packages, and deploys software to servers using only a couple shell scripts, docker, tar, and rsync. It's a bit rough, and definitely not suitable for corporate use, but will get the job done if you have simple needs.

Prerequisites

  1. A server with all the proper runtimes, languages, and SSH keys you'd normally need to run and deploy your application.
  2. A deploy user which SSH access and a home directory.
  3. /srv/www, owned by deploy:deploy.
  4. The deploy-app script in this repo should be uploaded to every production server at /usr/local/bin/deploy-app, and should be executable.
  5. Another repo for project configuration. This repo should only ever contain the upstream deploy-app scripts; you should nest another git repo of your own as ./workspace in this directory (it is git-ignored) to hold your project configuration files.

For an example of what the workspace repo should look like, check out: blackieops/deploy-app-example

If you use Ansible, check out blackieops/deploy-app-ansible, which provides an Ansible role for configuring servers for deploy-app.

Configuration

First, fill out servers by providing a newline-separated list of server hostnames or IPs. These will be iterated through and deployed in order.

Each project is stored under the ./workspace directory. Configuring a project requires you to just create a directory with some scripts and files:

workspace/myproject/
├── Dockerfile
├── build.sh
├── postdeploy.sh
└── remote
  • The Dockerfile will be built on every run and the app will be built inside it. It should set up everything necessary to compile your software. If you do not need Docker, you can simply omit the Dockerfile and the build will execute locally instead.
  • build.sh will be invoked inside the container and should run all the necessary things to compile and/or release your software.
  • postdeploy.sh will be sent to the production server and executed in the root of your project code after it has been extracted; use this to install dependencies, restart services, notify load balancers, etc.
  • remote is a plain text file with nothing except a URL to the git remote we should clone to get your app's source code.

Usage

Once you have a project configured as per above, and you have servers that have been configured and are accessible in your servers manifest, then just:

./deploy.sh myproject

Where myproject is the name of the directory under workspace.

If you want to deploy from a specific branch, such as staging or production, for example, simply set BRANCH when calling deploy.sh:

BRANCH=staging ./deploy.sh myproject
You can’t perform that action at this time.