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

docs: add config details for sending emails

Browse source
This commit is contained in:
Paul Campbell 2024-08-02 18:46:47 +01:00
parent 9fb70f98d6
commit 6bc4b7b143
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
crates/cli/README.md
View file

@ -118,11 +118,33 @@ The server should be able to notify the user when manual intervention is require
##### webhook ##### webhook
Will send a POST request for some events.
- **url** - the URL to POST the notification to and the - **url** - the URL to POST the notification to and the
- **secret** - the sync key used to sign the webhook payload - **secret** - the sync key used to sign the webhook payload
See [Notifications](#notifications) for more details. See [Notifications](#notifications) for more details.
##### email
Will send an email for some events.
- **from** - the email address to send the email from
- **to** - the email address to send the email to
With just `from` and `to` specified, `git-next` will attempt to send emails
with `sendmail` if it is configured.
Alternativly, you can use an SMTP relay.
###### smtp
Will send emails using an SMTP relay.
- **hostname** - the SMTP relay server
- **username** - the account to authenticate as
- **password** - the password to authenticate with
#### storage #### storage
`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