Documentation

• Installation
• User Guide
• API Reference

System Requirements

• Docker
• AUFS

We highly recommend running Docker with the AUFS storage driver. You can verify Docker is using the AUFS storage driver with the following command sudo docker info | grep Driver:

Upgrading

If you are upgrading from 0.2 I would recommend waiting a few weeks for the master branch to stabilize. There was a huge amount of refactoring that destabilized the codebase and I'd hate for that to impact any real world installations.

If you still want to upgrade to 0.2 please know that the databases are not compatible and there is no automated migration due to some fundamental structural changes. You will need to start with a fresh instance.

Installation

This is project is alpha stage. Consider yourself warned

We have optimized the installation process for Ubuntu since that is what we test with internally. You can run the following commands to quickly download an install Drone on an Ubuntu machine.

# Ubuntu, Debian
wget downloads.drone.io/master/drone.deb
sudo dpkg -i drone.deb

# CentOS, RedHat
wget downloads.drone.io/master/drone.rpm
sudo yum localinstall drone.rpm

Database

By default, Drone will create a SQLite database. Drone also supports Postgres and MySQL databases. You can customize the database settings using the configuration options described in the Setup section.

Below are some example configurations that you can use as reference:

# to use postgres
[database]
driver="postgres"
datasource="host=127.0.0.1 user=postgres dbname=drone sslmode=disable"

# to use mysql
[database]
driver="mysql"
datasource="root@tcp(127.0.0.1:3306)/drone"

Setup

We are in the process of moving configuration out of the UI and into configuration files and/or environment variables (your choice which). If you prefer configuration files you can provide Drone with the path to your configuration file:

droned --config=/path/to/drone.toml

The configuration file is in TOML format. If installed using the drone.deb file will be located in /etc/drone/drone.toml.

You can find the current config of the master branch here.

[server]
port=""

[server.ssl]
key=""
cert=""

[session]
secret=""
expires=""

[database]
driver=""
datasource=""

[github]
client=""
secret=""
orgs=[]
open=false

[github_enterprise]
client=""
secret=""
api=""
url=""
orgs=[]
private_mode=false
open=false

[bitbucket]
client=""
secret=""
open=false

[gitlab]
url=""
client=""
secret=""
skip_verify=false
open=false

[gogs]
url=""
secret=""
open=false

[stash]
url = ""
api = ""
secret = ""
private-key = ""
hook = "de.aeffle.stash.plugin.stash-http-get-post-receive-hook%3Ahttp-get-post-receive-hook"

[smtp]
host=""
port=""
from=""
user=""
pass=""

[docker]
cert=""
key=""

[worker]
nodes=[
"unix:///var/run/docker.sock",
"unix:///var/run/docker.sock"
]

Or you can use environment variables

# custom http server settings
export DRONE_SERVER_PORT=""
export DRONE_SERVER_SSL_KEY=""
export DRONE_SERVER_SSL_CERT=""

# session settings
export DRONE_SESSION_SECRET=""
export DRONE_SESSION_EXPIRES=""

# custom database settings
export DRONE_DATABASE_DRIVER=""
export DRONE_DATABASE_DATASOURCE=""

# github configuration
export DRONE_GITHUB_CLIENT=""
export DRONE_GITHUB_SECRET=""
export DRONE_GITHUB_OPEN=false

# github enterprise configuration
export DRONE_GITHUB_ENTERPRISE_CLIENT=""
export DRONE_GITHUB_ENTERPRISE_SECRET=""
export DRONE_GITHUB_ENTERPRISE_API=""
export DRONE_GITHUB_ENTERPRISE_URL=""
export DRONE_GITHUB_ENTERPRISE_PRIVATE_MODE=false
export DRONE_GITHUB_ENTERPRISE_OPEN=false

# bitbucket configuration
export DRONE_BITBUCKET_CLIENT=""
export DRONE_BITBUCKET_SECRET=""
export DRONE_BITBUCKET_OPEN=false


# gitlab configuration
export DRONE_GITLAB_URL=""
export DRONE_GITLAB_CLIENT=""
export DRONE_GITLAB_SECRET=""
export DRONE_GITLAB_SKIP_VERIFY=false
export DRONE_GITLAB_OPEN=false

# stash configuration
export DRONE_STASH_URL="http://localhost:7990"
export DRONE_STASH_API="ssh://localhost:7999"
export DRONE_STASH_SECRET="Drone"
export DRONE_STASH_PRIVATE_KEY="/stash.pem"
export DRONE_STASH_HOOK="de.aeffle.stash.plugin.stash-http-get-post-receive-hook%3Ahttp-get-post-receive-hook"

# email configuration
export DRONE_SMTP_HOST=""
export DRONE_SMTP_PORT=""
export DRONE_SMTP_FROM=""
export DRONE_SMTP_USER=""
export DRONE_SMTP_PASS=""

# worker nodes
# these are optional. If not specified Drone will add
# two worker nodes that connect to $DOCKER_HOST
export DRONE_WORKER_NODES="tcp://0.0.0.0:2375,tcp://0.0.0.0:2375"

Or a combination of the two:

DRONE_GITLAB_URL="https://gitlab.com" droned --config=/path/to/drone.conf

GitHub

In order to setup with GitHub you'll need to register your local Drone installation with GitHub (or GitHub Enterprise). You can read more about registering an application here: https://github.com/settings/applications/new

Below are example values when running Drone locally. If you are running Drone on a server you should replace localhost with your server hostname or address.

Homepage URL:

http://localhost:8000/

Authorization callback URL for github.com:

http://localhost:8000/api/auth/github.com

Authorization callback URL for GitHub Enterprise:

http://localhost:8000/api/auth/enterprise.github.com

## Stash

In order to setup with Stash you'll need to register your local Drone installation
with Stash. You can read more about registering an application here: https://confluence.atlassian.com/display/APPLINKS/Application+Links+Documentation

Below are example values when running Drone locally. If you are running Drone on a server
you should replace `localhost` with your server hostname or address. Also you should probably consider the security of using non-password protected keys.

First generate a private key:

openssl genrsa -aes256 -passout pass:password -out stash.pem.tmp 2048

Strip the password:

openssl rsa -passin pass:password -in stash.pem.tmp -out stash.pem.tmp

Now convert this to pkcs8 format:

openssl pkcs8 -topk8 -inform pem -in stash.pem.tmp -outform pem -nocrypt -out stash.pem ; rm stash.pem.tmp

Generate the public key:

openssl rsa -in stash.pem -pubout -out stash.pub

Set up the application link as a Stash Administrator with the following parameters:

Application:

http://localhost:8000

Create New Link and Continue

Application Name: Drone
Application Type: Generic Application
Service Provider Name: Drone
Consumer Key: Drone
Shared Secret: Drone
Authorize URL: http://localhost:8000/api/auth/stash.atlassian.com
Create incomming link: true

Consumer Key: Drone
Consumer Name: Drone
Public Key: text from stash.pub generated above

Customize drone.toml with the appropriate URL:port for stash (7990) and stash git (7999)

[stash] url = "http://localhost:7990" api = "ssh://localhost:7999" secret = "Drone" private-key = "/stash.pem hook = "de.aeffle.stash.plugin.stash-http-get-post-receive-hook%3Ahttp-get-post-receive-hook"

## Build Configuration

You will need to include a `.drone.yml` file in the root of your repository in order to
configure a build. I'm still working on updated documentation, so in the meantime please refer
to the `0.2` README to learn more about the `.drone.yml` format:

https://github.com/drone/drone/blob/v0.2.1/README.md#builds