Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
foosinn committed Mar 11, 2019
1 parent 3d4eb04 commit e30ad14
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@ The extension checks each changed file and look for a `.drone.yml` in the direct

## Limitations

Currently supports only Github and a single `.drone.yml`. The first one that matches will be used.
Currently supports only Github.

## Usage

Environment variables:

- `PLUGIN_DEBUG`: Set this to `yes` to enable debug messages.
- `PLUGIN_CONCAT`: Concats all found configs to a multi-machine build. Defaults to `false`.
- `PLUGIN_DEBUG`: Set this to `true` to enable debug messages.
- `PLUGIN_ADDRESS`: Listen address for the plugins webserver. Defaults to `:3000`.
- `PLUGIN_SECRET`: Shared secret with drone. You can generate the token using `openssl rand -hex 16`.
- `GITHUB_TOKEN`: Github personal access token. Only needs repo rights. See [here][1].
- `GITHUB_SERVER`: Custom Github server for Github Enterprise

If `PLUGIN_CONCAT` is not set, the first `.drone.yml` whill be used.

Example docker-compose:

```yaml
Expand Down

0 comments on commit e30ad14

Please sign in to comment.