Update readme
Signed-off-by: Alexis Pentori <alexis@status.im>
This commit is contained in:
parent
8f12d0989b
commit
c44ac9d541
16
README.md
16
README.md
|
@ -4,6 +4,20 @@ This is a helper role that deploy a python server for github webhook
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
```yaml
|
The following parameter have to be added
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
github_webhook_service_user:
|
||||||
|
github_webhook_dest_path:
|
||||||
|
github_webhook_secret:
|
||||||
|
github_webhook_ssh_key:
|
||||||
|
github_webhook_repo_url:
|
||||||
|
github_webhook_repo_branch:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`github_webhook_dest_path` correspond to the base path where the repository will be cloned. The name of the repo owner and the repo name will be added to the path.
|
||||||
|
|
||||||
|
|
||||||
|
The `github_webhook_secret` is generated when configuring the webhook in the repository.
|
||||||
|
|
||||||
|
The public key associated to `github_webhook_ssh_key` has to be added as a Deploy key in the repository setting.
|
||||||
|
|
Loading…
Reference in New Issue