# Bootleg

[![CircleCI](]( [![](]( [![Packagist](](

Simple deployment and server automation for Elixir.

 * [Documentation](
 * [Phoenix support](
 * [Contributing](

**Bootleg** is an Elixir application that attempts to simplify the building and deploying of Elixir application releases. The goal of this project is to provide an extensible framework that can support many different deployment scenarios with one common set of commands.

## Installation

Add [Distillery]( and Bootleg as dependencies to `mix.exs`:

def deps do
  [{:distillery, "~> 2.1.0", runtime: false},
   {:bootleg, "~> 0.13.0", runtime: false}]

## Quick start

### Create release configuration

If you're new to [Distillery](, run the init command to generate a `rel/` folder and configuration:

mix distillery.init

### Create deploy configuration

Similarly, Bootleg configuration can be generated:

mix bootleg.init

### Configure the deploy configuration

First define a build server in `config/deploy.exs`:

use Bootleg.DSL

role :build, "", 
  workspace: "/home/acme/build",
  user: "acme",
  identity: "~/.ssh/id_acme_rsa",
  silently_accept_hosts: true


Next, define application server(s) in `config/deploy/production.exs`:

use Bootleg.DSL

role :app, ["", ""],
  workspace: "/opt/acme",
  user: "acme",
  identity: "~/.ssh/id_acme_rsa",
  silently_accept_hosts: true

### Build, deploy and start your application   
Now you can proceed to build, deploy and start your application:

mix bootleg.deploy
mix bootleg.start
This example was for building on a remote build server and deploying to one or more remote application servers, but Bootleg supports several other [build]( and [deployment strategies](

## Help

Bootleg has [online documentation]( available.

For detailed information about the Bootleg commands and their options, try `mix bootleg help <command>`.

The authors and contributors are frequently found on *elixir-lang*'s Slack in the [#bootleg]( channel. Come say hello!


## Acknowledgments

Bootleg makes heavy use of the [bitcrowd/SSHKit.ex](
library under the hood. We are very appreciative of the efforts of the bitcrowd team for both creating SSHKit.ex and being so attentive to our requests. We're also grateful for the opportunity to collaborate
on ideas for both projects!

## Contributing

We welcome all contributions to Bootleg, whether they're improving the documentation, implementing features, reporting issues or suggesting new features.

If you'd like to contribute documentation, please check
[the best practices for writing documentation][writing-docs].


Bootleg source code is released under the MIT License.
Check the [LICENSE](LICENSE) file for more information.