mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-01-11 10:05:27 +00:00
Code Issues Projects Releases Wiki Activity

link to docs in README

Browse source
This commit is contained in:
Brad Rydzewski 2015-07-09 20:15:29 -07:00
parent 183fce0535
commit f3ea6dbdc5
1 changed files with 7 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
README.md
View file

@ -1,8 +1,10 @@
# Drone
Drone is a Continuous Integration platform built on container technology. Every build is executed inside an ephemeral Docker container, giving developers complete control over their build environment with guaranteed isolation.
## Documentation
### Goals
Drone's prime directive is to help teams [ship code like GitHub](https://github.com/blog/1241-deploying-at-github#always-be-shipping). Drone is easy to install, setup and maintain and offers a powerful container-based plugin system. Drone aspires to be an industry-wide replacement for Jenkins.
### Documentation
Drone documentation is organized into several categories:
@ -10,99 +12,6 @@ Drone documentation is organized into several categories:
* [Build Guide](http://readme.drone.io/docs/build/)
* [API Reference](http://readme.drone.io/docs/api/)
## Community
### Community
Contributions, questions, and comments are all welcomed and encouraged! Drone developers hang out in the [drone/drone](https://gitter.im/drone/drone) room on [gitter](https://gitter.im/drone/drone).
---
Running Drone:
```
./drone --config="/path/to/config.toml"
```
Configuring Drone:
```toml
[server]
addr = ":80"
cert = ""
key = ""
[session]
secret = ""
expires = ""
[database]
driver="sqlite3"
datasource="/var/lib/drone/drone.sqlite"
[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:
```shell
#!/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:
```sh
make bindata # create .go files for web assets
make # create binary files in ./bin
make test # execute unit tests
```
Commands to run:
```sh
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:
```sh
go install github.com/drone/drone/Godeps/_workspace/src/github.com/mattn/go-sqlite3
```
Contributions, questions, and comments are welcomed and encouraged. Drone developers hang out in the [drone/drone](https://gitter.im/drone/drone) room on [gitter](https://gitter.im/drone/drone).