docs: add required variables to readme
This commit is contained in:
parent
99816a8cb0
commit
ccf43e23d9
1 changed files with 18 additions and 0 deletions
18
readme.md
18
readme.md
|
|
@ -1,3 +1,21 @@
|
|||
# Ansible Role: Woodpecker CI
|
||||
|
||||
Install and configure [Woodpecker CI](https://woodpecker-ci.org) - a simple yet powerful CI/CD engine with great extensibility.
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|----------|----------|---------|-------------|
|
||||
| `woodpecker_forgejo_client` | Yes | - | Forgejo OAuth2 client ID |
|
||||
| `woodpecker_forgejo_secret` | Yes | - | Forgejo OAuth2 client secret |
|
||||
| `woodpecker_agent_secret` | Yes | - | Shared secret for agent authentication |
|
||||
| `timezone` | No | - | Timezone for the container |
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
woodpecker_forgejo_client: "your-oauth2-client-id"
|
||||
woodpecker_forgejo_secret: "your-oauth2-client-secret"
|
||||
woodpecker_agent_secret: "your-agent-secret"
|
||||
timezone: "Europe/Amsterdam"
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue