Compare commits

...

2 commits

Author SHA1 Message Date
f35ff77e48 docs: add example to readme for listen, shout & storage
All checks were successful
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
2024-08-02 18:59:39 +01:00
20f48ce3b1 fix: add example email config to server default tempalte
All checks were successful
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
2024-08-02 18:55:04 +01:00
2 changed files with 37 additions and 6 deletions

View file

@ -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

View file

@ -9,6 +9,15 @@ url = "https://localhost:8080" # don't include any query path or a trailing slas
[shout] # where updates from git-next should be sent to alert the user [shout] # where updates from git-next should be sent to alert the user
# webhook = { url = "https//localhost:9090", secret = "secret-password" } # 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"
[storage] # where local copies of repositories will be cloned (bare) into [storage] # where local copies of repositories will be cloned (bare) into
path = "./data" path = "./data"
@ -23,9 +32,3 @@ path = "./data"
# [forge.default.repos] # the repos at the forge to manage # [forge.default.repos] # the repos at the forge to manage
# hello = { repo = "bob/hello", branch = "main", gitdir = "/opt/git/projects/bob/hello.git" } # hello = { repo = "bob/hello", branch = "main", gitdir = "/opt/git/projects/bob/hello.git" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" } # world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }
# hello = { repo = "bob/hello", branch = "main", gitdir = "/opt/git/projects/bob/hello.git" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }
# world = { repo = "bob/world", branch = "master", main = "master", next = "upcoming", "dev" = "develop" }