docs: add example to readme for listen, shout & storage
This commit is contained in:
parent
637abb50cd
commit
dc3c55f570
1 changed files with 28 additions and 0 deletions
|
@ -89,6 +89,14 @@ The server is configured by the `git-next-server.toml` file.
|
||||||
|
|
||||||
#### listen
|
#### listen
|
||||||
|
|
||||||
|
The server should listen for webhook notifications from each forge.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[listen]
|
||||||
|
http = { addr = "0.0.0.0", port = 8080 }
|
||||||
|
url = "https://localhost:8080"
|
||||||
|
```
|
||||||
|
|
||||||
##### http
|
##### http
|
||||||
|
|
||||||
The server needs to be able to receive webhook notifications from your forge,
|
The server needs to be able to receive webhook notifications from your forge,
|
||||||
|
@ -116,6 +124,21 @@ forge is running on.
|
||||||
|
|
||||||
The server should be able to notify the user when manual intervention is required.
|
The server should be able to notify the user when manual intervention is required.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[shout.webhook]
|
||||||
|
url = "https//localhost:9090"
|
||||||
|
secret = "secret-password"
|
||||||
|
|
||||||
|
[shout.email]
|
||||||
|
from = "git-next@example.com"
|
||||||
|
to = "developer@example.com"
|
||||||
|
|
||||||
|
[shout.email.smtp]
|
||||||
|
hostname = "smtp.example.com"
|
||||||
|
username = "git-next@example.com"
|
||||||
|
password = "MySecretEmailPassword42"
|
||||||
|
```
|
||||||
|
|
||||||
##### webhook
|
##### webhook
|
||||||
|
|
||||||
Will send a POST request for some events.
|
Will send a POST request for some events.
|
||||||
|
@ -147,6 +170,11 @@ Will send emails using an SMTP relay.
|
||||||
|
|
||||||
#### storage
|
#### storage
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[storage]
|
||||||
|
path = "./data"
|
||||||
|
```
|
||||||
|
|
||||||
`git-next` will create a bare clone of each repo that you configure it to
|
`git-next` will create a bare clone of each repo that you configure it to
|
||||||
monitor. They will all be created in the directory specified here. This data
|
monitor. They will all be created in the directory specified here. This data
|
||||||
does not need to be backed up, as any missing information will be cloned when
|
does not need to be backed up, as any missing information will be cloned when
|
||||||
|
|
Loading…
Reference in a new issue