feat: allow configurable web push expiry duration #1212
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wunter8
reviewed
Nov 2, 2024
cmd/serve.go
Outdated
| @@ -100,6 +100,8 @@ var flagsServe = append( | |||
| altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-file", Aliases: []string{"web_push_file"}, EnvVars: []string{"NTFY_WEB_PUSH_FILE"}, Usage: "file used to store web push subscriptions"}), | |||
| altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-email-address", Aliases: []string{"web_push_email_address"}, EnvVars: []string{"NTFY_WEB_PUSH_EMAIL_ADDRESS"}, Usage: "e-mail address of sender, required to use browser push services"}), | |||
| altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-startup-queries", Aliases: []string{"web_push_startup_queries"}, EnvVars: []string{"NTFY_WEB_PUSH_STARTUP_QUERIES"}, Usage: "queries run when the web push database is initialized"}), | |||
| altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-expiry-duration", Aliases: []string{"web_push_expiry_duration"}, EnvVars: []string{"NTFY_WEB_PUSH_EXPIRY_DURATION"}, Value: util.FormatDuration(server.DefaultWebPushExpiryDuration), Usage: "send web push warning notification after this time before expiring unused subscriptions"}), | |||
| altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-expiry-warning-duration", Aliases: []string{"web_push_expiry_warning_duration"}, EnvVars: []string{"NTFY_WEB_PUSH_EXPIRY_WARNING_DURATION"}, Value: util.FormatDuration(server.DefaultWebPushExpiryWarningDuration), Usage: "automatically expire unused subscriptions after this time"}), | |||
There was a problem hiding this comment.
Looks like this "usage" description and the next one got switched
wunter8
reviewed
Nov 2, 2024
docs/config.md
Outdated
| @@ -876,7 +876,9 @@ a database to keep track of the browser's subscriptions, and an admin email addr | |||
| - `web-push-private-key` is the generated VAPID private key, e.g. AA2BB1234567890abcdefzxcvbnm1234567890 | |||
| - `web-push-file` is a database file to keep track of browser subscription endpoints, e.g. `/var/cache/ntfy/webpush.db` | |||
| - `web-push-email-address` is the admin email address send to the push provider, e.g. `sysadmin@example.com` | |||
| - `web-push-startup-queries` is an optional list of queries to run on startup` | |||
| - `web-push-startup-queries` is an optional list of queries to run on startup` | |||
| - `web-push-expiry-warning-duration` defines the duration for which unused subscriptions are sent a warning (default is `7d`) | |||
There was a problem hiding this comment.
nit: "defines the duration after which ..."
wunter8
reviewed
Nov 2, 2024
docs/config.md
Outdated
| - `web-push-startup-queries` is an optional list of queries to run on startup` | ||
| - `web-push-startup-queries` is an optional list of queries to run on startup` | ||
| - `web-push-expiry-warning-duration` defines the duration for which unused subscriptions are sent a warning (default is `7d`) | ||
| - `web-push-expiry-duration` defines the duration for which unused subscriptions will expire (default is `9d`) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow the config settings
DefaultWebPushExpiryWarningDurationandDefaultWebPushExpiryDurationto be configurable.Closes #1211