Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2025-09-21 21:30:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(docs): correct formatting and punctuation in documentation files

Browse source
This commit is contained in:
Jan Rundshagen 2025-03-19 15:12:36 +01:00 • committed by Jan O. Rundshagen
parent 149af7827b
commit 6a9b1967da
3 changed files with 24 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/notifications.md
View file

@ -249,6 +249,7 @@ You can then copy this file from the container (a message with the full command
To receive notifications by email, the following command-line options, or their corresponding environment variables, can be set:
- `--notification-email-from` (env. `WATCHTOWER_NOTIFICATION_EMAIL_FROM`): The e-mail address from which notifications will be sent.
- `--notification-email-from-name` (env. `WATCHTOWER_NOTIFICATION_EMAIL_FROM_NAME`): The name from which notifications will be sent.
- `--notification-email-to` (env. `WATCHTOWER_NOTIFICATION_EMAIL_TO`): The e-mail address to which notifications will be sent.
- `--notification-email-server` (env. `WATCHTOWER_NOTIFICATION_EMAIL_SERVER`): The SMTP server to send e-mails through.
- `--notification-email-server-tls-skip-verify` (env. `WATCHTOWER_NOTIFICATION_EMAIL_SERVER_TLS_SKIP_VERIFY`): Do not verify the TLS certificate of the mail server. This should be used only for testing.
@ -387,4 +388,3 @@ docker run -d \
`-e WATCHTOWER_NOTIFICATION_GOTIFY_TOKEN` or `--notification-gotify-token` can also reference a file, in which case the contents of the file are used.
If you want to disable TLS verification for the Gotify instance, you can use either `-e WATCHTOWER_NOTIFICATION_GOTIFY_TLS_SKIP_VERIFY=true` or `--notification-gotify-tls-skip-verify`.

8
pkg/notifications/notifier_test.go
View file

@ -308,6 +308,8 @@ var _ = Describe("notifications", func() {
"email",
"--notification-email-from",
fromAddress,
"--notification-email-from-name",
"Watchtower1",
"--notification-email-to",
"mail@example.com",
"--notification-email-server-user",
@ -334,6 +336,8 @@ var _ = Describe("notifications", func() {
"email",
"--notification-email-from",
fromAddress,
"--notification-email-from-name",
"Watchtower1",
"--notification-email-to",
toAddress,
"--notification-email-server-user",
@ -342,7 +346,7 @@ var _ = Describe("notifications", func() {
"secret-password",
"--notification-email-server",
"mail.containrrr.dev",
"--notification-email-delay",
"--notifications-delay",
fmt.Sprint(expectedDelay.Seconds()),
}
@ -353,7 +357,7 @@ var _ = Describe("notifications", func() {
})
func buildExpectedURL(username string, password string, host string, port int, from string, to string, auth string) string {
var template = "smtp://%s:%s@%s:%d/?auth=%s&fromaddress=%s&fromname=Watchtower&subject=&toaddresses=%s"
var template = "smtp://%s:%s@%s:%d/?auth=%s&fromaddress=%s&fromname=Watchtower1&subject=&toaddresses=%s"
return fmt.Sprintf(template,
url.QueryEscape(username),
url.QueryEscape(password),