woodpecker/README.md
Jean Mertz 2f4e2803e7 update README to mention remote section
Also adds example of `access_token` becoming `ACCESSTOKEN` as an environment
variable.
2015-06-06 01:57:30 +02:00

2.1 KiB

Highly experimental branch that implements the following features:

  • Pluggable database backends
  • Pluggable queue
  • Matrix builds
  • Build plugins
  • New Yaml syntax
  • and more ...

Running Drone:

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

Configuring Drone:

[server]
addr = ":80"
cert = ""
key = ""

[session]
secret = ""
expires = ""

[database]
path = "/etc/drone/drone.db"

[docker]
cert = ""
key = ""
addr = "unix:///var/run/docker.sock"
swarm = ""

[remote]
kind = "github"
base = "https://github.com"
orgs = []
open = false
private = false
skip_verify = true

[auth]
client = ""
secret = ""
authorize = "https://github.com/login/oauth/authorize"
access_token = "https://github.com/login/oauth/access_token"
request_token = ""

[agents]
secret = ""

Configuration settings can also be set by environment variables using the scheme DRONE_<section>_<confkey>, substituting the section title for <section> and the key for <confkey>, in all caps. For example:

#!/bin/bash
# prepare environment for executing drone
DRONE_REMOTE_BASE="https://github.com"      # for [remote] section, 'base' setting
DRONE_DOCKER_ADDR="tcp://10.0.0.1:2375"     # for [docker] section, 'addr' setting
DRONE_AUTH_CLIENT="0123456789abcdef0123AA"  # for [auth] section, 'client' setting
DRONE_AUTH_SECRET="<sha-1 hash secret>"     # for [auth] section, 'secret' setting
DRONE_AUTH_ACCESSTOKEN="<url>"              # for [auth] section, 'access_token' setting

exec ./drone -config=drone.toml

NOTE: Configuration settings from environment variables override values set in the TOML file.

From Source

Commands to build from source:

make bindata # create .go files for web assets
make         # create binary files in ./bin
make test    # execute unit tests

Commands to run:

bin/drone
bin/drone --debug # debug mode loads static content from filesystem

NOTE if you are seeing slow compile times you can try running go install for the vendored go-sqlite3 library:

go install github.com/drone/drone/Godeps/_workspace/src/github.com/mattn/go-sqlite3