cossmass/git-next
1
0
Fork 0
forked from kemitix/git-next
Code Pull requests Activity

docs: add example to readme for listen, shout & storage

Browse source
This commit is contained in:
Paul Campbell 2024-08-02 18:59:39 +01:00
parent 637abb50cd
commit dc3c55f570
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
crates/cli/README.md
View file

@ -89,6 +89,14 @@ The server is configured by the `git-next-server.toml` file.
#### 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
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.
```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
Will send a POST request for some events.
@ -147,6 +170,11 @@ Will send emails using an SMTP relay.
#### storage
```toml
[storage]
path = "./data"
```
`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
does not need to be backed up, as any missing information will be cloned when