serve.go 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  1. //go:build !noserver
  2. package cmd
  3. import (
  4. "errors"
  5. "fmt"
  6. "github.com/stripe/stripe-go/v74"
  7. "github.com/urfave/cli/v2"
  8. "github.com/urfave/cli/v2/altsrc"
  9. "heckel.io/ntfy/v2/log"
  10. "heckel.io/ntfy/v2/server"
  11. "heckel.io/ntfy/v2/user"
  12. "heckel.io/ntfy/v2/util"
  13. "io/fs"
  14. "math"
  15. "net"
  16. "net/netip"
  17. "os"
  18. "os/signal"
  19. "strings"
  20. "syscall"
  21. "time"
  22. )
  23. func init() {
  24. commands = append(commands, cmdServe)
  25. }
  26. const (
  27. defaultServerConfigFile = "/etc/ntfy/server.yml"
  28. )
  29. var flagsServe = append(
  30. append([]cli.Flag{}, flagsDefault...),
  31. &cli.StringFlag{Name: "config", Aliases: []string{"c"}, EnvVars: []string{"NTFY_CONFIG_FILE"}, Value: defaultServerConfigFile, Usage: "config file"},
  32. altsrc.NewStringFlag(&cli.StringFlag{Name: "base-url", Aliases: []string{"base_url", "B"}, EnvVars: []string{"NTFY_BASE_URL"}, Usage: "externally visible base URL for this host (e.g. https://ntfy.sh)"}),
  33. altsrc.NewStringFlag(&cli.StringFlag{Name: "listen-http", Aliases: []string{"listen_http", "l"}, EnvVars: []string{"NTFY_LISTEN_HTTP"}, Value: server.DefaultListenHTTP, Usage: "ip:port used as HTTP listen address"}),
  34. altsrc.NewStringFlag(&cli.StringFlag{Name: "listen-https", Aliases: []string{"listen_https", "L"}, EnvVars: []string{"NTFY_LISTEN_HTTPS"}, Usage: "ip:port used as HTTPS listen address"}),
  35. altsrc.NewStringFlag(&cli.StringFlag{Name: "listen-unix", Aliases: []string{"listen_unix", "U"}, EnvVars: []string{"NTFY_LISTEN_UNIX"}, Usage: "listen on unix socket path"}),
  36. altsrc.NewIntFlag(&cli.IntFlag{Name: "listen-unix-mode", Aliases: []string{"listen_unix_mode"}, EnvVars: []string{"NTFY_LISTEN_UNIX_MODE"}, DefaultText: "system default", Usage: "file permissions of unix socket, e.g. 0700"}),
  37. altsrc.NewStringFlag(&cli.StringFlag{Name: "key-file", Aliases: []string{"key_file", "K"}, EnvVars: []string{"NTFY_KEY_FILE"}, Usage: "private key file, if listen-https is set"}),
  38. altsrc.NewStringFlag(&cli.StringFlag{Name: "cert-file", Aliases: []string{"cert_file", "E"}, EnvVars: []string{"NTFY_CERT_FILE"}, Usage: "certificate file, if listen-https is set"}),
  39. altsrc.NewStringFlag(&cli.StringFlag{Name: "firebase-key-file", Aliases: []string{"firebase_key_file", "F"}, EnvVars: []string{"NTFY_FIREBASE_KEY_FILE"}, Usage: "Firebase credentials file; if set additionally publish to FCM topic"}),
  40. altsrc.NewStringFlag(&cli.StringFlag{Name: "cache-file", Aliases: []string{"cache_file", "C"}, EnvVars: []string{"NTFY_CACHE_FILE"}, Usage: "cache file used for message caching"}),
  41. altsrc.NewStringFlag(&cli.StringFlag{Name: "cache-duration", Aliases: []string{"cache_duration", "b"}, EnvVars: []string{"NTFY_CACHE_DURATION"}, Value: util.FormatDuration(server.DefaultCacheDuration), Usage: "buffer messages for this time to allow `since` requests"}),
  42. altsrc.NewIntFlag(&cli.IntFlag{Name: "cache-batch-size", Aliases: []string{"cache_batch_size"}, EnvVars: []string{"NTFY_BATCH_SIZE"}, Usage: "max size of messages to batch together when writing to message cache (if zero, writes are synchronous)"}),
  43. altsrc.NewStringFlag(&cli.StringFlag{Name: "cache-batch-timeout", Aliases: []string{"cache_batch_timeout"}, EnvVars: []string{"NTFY_CACHE_BATCH_TIMEOUT"}, Value: util.FormatDuration(server.DefaultCacheBatchTimeout), Usage: "timeout for batched async writes to the message cache (if zero, writes are synchronous)"}),
  44. altsrc.NewStringFlag(&cli.StringFlag{Name: "cache-startup-queries", Aliases: []string{"cache_startup_queries"}, EnvVars: []string{"NTFY_CACHE_STARTUP_QUERIES"}, Usage: "queries run when the cache database is initialized"}),
  45. altsrc.NewStringFlag(&cli.StringFlag{Name: "auth-file", Aliases: []string{"auth_file", "H"}, EnvVars: []string{"NTFY_AUTH_FILE"}, Usage: "auth database file used for access control"}),
  46. altsrc.NewStringFlag(&cli.StringFlag{Name: "auth-startup-queries", Aliases: []string{"auth_startup_queries"}, EnvVars: []string{"NTFY_AUTH_STARTUP_QUERIES"}, Usage: "queries run when the auth database is initialized"}),
  47. altsrc.NewStringFlag(&cli.StringFlag{Name: "auth-default-access", Aliases: []string{"auth_default_access", "p"}, EnvVars: []string{"NTFY_AUTH_DEFAULT_ACCESS"}, Value: "read-write", Usage: "default permissions if no matching entries in the auth database are found"}),
  48. altsrc.NewStringFlag(&cli.StringFlag{Name: "attachment-cache-dir", Aliases: []string{"attachment_cache_dir"}, EnvVars: []string{"NTFY_ATTACHMENT_CACHE_DIR"}, Usage: "cache directory for attached files"}),
  49. altsrc.NewStringFlag(&cli.StringFlag{Name: "attachment-total-size-limit", Aliases: []string{"attachment_total_size_limit", "A"}, EnvVars: []string{"NTFY_ATTACHMENT_TOTAL_SIZE_LIMIT"}, Value: util.FormatSize(server.DefaultAttachmentTotalSizeLimit), Usage: "limit of the on-disk attachment cache"}),
  50. altsrc.NewStringFlag(&cli.StringFlag{Name: "attachment-file-size-limit", Aliases: []string{"attachment_file_size_limit", "Y"}, EnvVars: []string{"NTFY_ATTACHMENT_FILE_SIZE_LIMIT"}, Value: util.FormatSize(server.DefaultAttachmentFileSizeLimit), Usage: "per-file attachment size limit (e.g. 300k, 2M, 100M)"}),
  51. altsrc.NewStringFlag(&cli.StringFlag{Name: "attachment-expiry-duration", Aliases: []string{"attachment_expiry_duration", "X"}, EnvVars: []string{"NTFY_ATTACHMENT_EXPIRY_DURATION"}, Value: util.FormatDuration(server.DefaultAttachmentExpiryDuration), Usage: "duration after which uploaded attachments will be deleted (e.g. 3h, 20h)"}),
  52. altsrc.NewStringFlag(&cli.StringFlag{Name: "keepalive-interval", Aliases: []string{"keepalive_interval", "k"}, EnvVars: []string{"NTFY_KEEPALIVE_INTERVAL"}, Value: util.FormatDuration(server.DefaultKeepaliveInterval), Usage: "interval of keepalive messages"}),
  53. altsrc.NewStringFlag(&cli.StringFlag{Name: "manager-interval", Aliases: []string{"manager_interval", "m"}, EnvVars: []string{"NTFY_MANAGER_INTERVAL"}, Value: util.FormatDuration(server.DefaultManagerInterval), Usage: "interval of for message pruning and stats printing"}),
  54. altsrc.NewStringSliceFlag(&cli.StringSliceFlag{Name: "disallowed-topics", Aliases: []string{"disallowed_topics"}, EnvVars: []string{"NTFY_DISALLOWED_TOPICS"}, Usage: "topics that are not allowed to be used"}),
  55. altsrc.NewStringFlag(&cli.StringFlag{Name: "web-root", Aliases: []string{"web_root"}, EnvVars: []string{"NTFY_WEB_ROOT"}, Value: "/", Usage: "sets root of the web app (e.g. /, or /app), or disables it (disable)"}),
  56. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "enable-signup", Aliases: []string{"enable_signup"}, EnvVars: []string{"NTFY_ENABLE_SIGNUP"}, Value: false, Usage: "allows users to sign up via the web app, or API"}),
  57. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "enable-login", Aliases: []string{"enable_login"}, EnvVars: []string{"NTFY_ENABLE_LOGIN"}, Value: false, Usage: "allows users to log in via the web app, or API"}),
  58. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "enable-reservations", Aliases: []string{"enable_reservations"}, EnvVars: []string{"NTFY_ENABLE_RESERVATIONS"}, Value: false, Usage: "allows users to reserve topics (if their tier allows it)"}),
  59. altsrc.NewStringFlag(&cli.StringFlag{Name: "upstream-base-url", Aliases: []string{"upstream_base_url"}, EnvVars: []string{"NTFY_UPSTREAM_BASE_URL"}, Value: "", Usage: "forward poll request to an upstream server, this is needed for iOS push notifications for self-hosted servers"}),
  60. altsrc.NewStringFlag(&cli.StringFlag{Name: "upstream-access-token", Aliases: []string{"upstream_access_token"}, EnvVars: []string{"NTFY_UPSTREAM_ACCESS_TOKEN"}, Value: "", Usage: "access token to use for the upstream server; needed only if upstream rate limits are exceeded or upstream server requires auth"}),
  61. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-sender-addr", Aliases: []string{"smtp_sender_addr"}, EnvVars: []string{"NTFY_SMTP_SENDER_ADDR"}, Usage: "SMTP server address (host:port) for outgoing emails"}),
  62. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-sender-user", Aliases: []string{"smtp_sender_user"}, EnvVars: []string{"NTFY_SMTP_SENDER_USER"}, Usage: "SMTP user (if e-mail sending is enabled)"}),
  63. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-sender-pass", Aliases: []string{"smtp_sender_pass"}, EnvVars: []string{"NTFY_SMTP_SENDER_PASS"}, Usage: "SMTP password (if e-mail sending is enabled)"}),
  64. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-sender-from", Aliases: []string{"smtp_sender_from"}, EnvVars: []string{"NTFY_SMTP_SENDER_FROM"}, Usage: "SMTP sender address (if e-mail sending is enabled)"}),
  65. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-server-listen", Aliases: []string{"smtp_server_listen"}, EnvVars: []string{"NTFY_SMTP_SERVER_LISTEN"}, Usage: "SMTP server address (ip:port) for incoming emails, e.g. :25"}),
  66. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-server-domain", Aliases: []string{"smtp_server_domain"}, EnvVars: []string{"NTFY_SMTP_SERVER_DOMAIN"}, Usage: "SMTP domain for incoming e-mail, e.g. ntfy.sh"}),
  67. altsrc.NewStringFlag(&cli.StringFlag{Name: "smtp-server-addr-prefix", Aliases: []string{"smtp_server_addr_prefix"}, EnvVars: []string{"NTFY_SMTP_SERVER_ADDR_PREFIX"}, Usage: "SMTP email address prefix for topics to prevent spam (e.g. 'ntfy-')"}),
  68. altsrc.NewStringFlag(&cli.StringFlag{Name: "twilio-account", Aliases: []string{"twilio_account"}, EnvVars: []string{"NTFY_TWILIO_ACCOUNT"}, Usage: "Twilio account SID, used for phone calls, e.g. AC123..."}),
  69. altsrc.NewStringFlag(&cli.StringFlag{Name: "twilio-auth-token", Aliases: []string{"twilio_auth_token"}, EnvVars: []string{"NTFY_TWILIO_AUTH_TOKEN"}, Usage: "Twilio auth token"}),
  70. altsrc.NewStringFlag(&cli.StringFlag{Name: "twilio-phone-number", Aliases: []string{"twilio_phone_number"}, EnvVars: []string{"NTFY_TWILIO_PHONE_NUMBER"}, Usage: "Twilio number to use for outgoing calls"}),
  71. altsrc.NewStringFlag(&cli.StringFlag{Name: "twilio-verify-service", Aliases: []string{"twilio_verify_service"}, EnvVars: []string{"NTFY_TWILIO_VERIFY_SERVICE"}, Usage: "Twilio Verify service ID, used for phone number verification"}),
  72. altsrc.NewStringFlag(&cli.StringFlag{Name: "message-size-limit", Aliases: []string{"message_size_limit"}, EnvVars: []string{"NTFY_MESSAGE_SIZE_LIMIT"}, Value: util.FormatSize(server.DefaultMessageSizeLimit), Usage: "size limit for the message (see docs for limitations)"}),
  73. altsrc.NewStringFlag(&cli.StringFlag{Name: "message-delay-limit", Aliases: []string{"message_delay_limit"}, EnvVars: []string{"NTFY_MESSAGE_DELAY_LIMIT"}, Value: util.FormatDuration(server.DefaultMessageDelayMax), Usage: "max duration a message can be scheduled into the future"}),
  74. altsrc.NewIntFlag(&cli.IntFlag{Name: "global-topic-limit", Aliases: []string{"global_topic_limit", "T"}, EnvVars: []string{"NTFY_GLOBAL_TOPIC_LIMIT"}, Value: server.DefaultTotalTopicLimit, Usage: "total number of topics allowed"}),
  75. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-subscription-limit", Aliases: []string{"visitor_subscription_limit"}, EnvVars: []string{"NTFY_VISITOR_SUBSCRIPTION_LIMIT"}, Value: server.DefaultVisitorSubscriptionLimit, Usage: "number of subscriptions per visitor"}),
  76. altsrc.NewStringFlag(&cli.StringFlag{Name: "visitor-attachment-total-size-limit", Aliases: []string{"visitor_attachment_total_size_limit"}, EnvVars: []string{"NTFY_VISITOR_ATTACHMENT_TOTAL_SIZE_LIMIT"}, Value: util.FormatSize(server.DefaultVisitorAttachmentTotalSizeLimit), Usage: "total storage limit used for attachments per visitor"}),
  77. altsrc.NewStringFlag(&cli.StringFlag{Name: "visitor-attachment-daily-bandwidth-limit", Aliases: []string{"visitor_attachment_daily_bandwidth_limit"}, EnvVars: []string{"NTFY_VISITOR_ATTACHMENT_DAILY_BANDWIDTH_LIMIT"}, Value: "500M", Usage: "total daily attachment download/upload bandwidth limit per visitor"}),
  78. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-request-limit-burst", Aliases: []string{"visitor_request_limit_burst"}, EnvVars: []string{"NTFY_VISITOR_REQUEST_LIMIT_BURST"}, Value: server.DefaultVisitorRequestLimitBurst, Usage: "initial limit of requests per visitor"}),
  79. altsrc.NewStringFlag(&cli.StringFlag{Name: "visitor-request-limit-replenish", Aliases: []string{"visitor_request_limit_replenish"}, EnvVars: []string{"NTFY_VISITOR_REQUEST_LIMIT_REPLENISH"}, Value: util.FormatDuration(server.DefaultVisitorRequestLimitReplenish), Usage: "interval at which burst limit is replenished (one per x)"}),
  80. altsrc.NewStringFlag(&cli.StringFlag{Name: "visitor-request-limit-exempt-hosts", Aliases: []string{"visitor_request_limit_exempt_hosts"}, EnvVars: []string{"NTFY_VISITOR_REQUEST_LIMIT_EXEMPT_HOSTS"}, Value: "", Usage: "hostnames and/or IP addresses of hosts that will be exempt from the visitor request limit"}),
  81. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-message-daily-limit", Aliases: []string{"visitor_message_daily_limit"}, EnvVars: []string{"NTFY_VISITOR_MESSAGE_DAILY_LIMIT"}, Value: server.DefaultVisitorMessageDailyLimit, Usage: "max messages per visitor per day, derived from request limit if unset"}),
  82. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-email-limit-burst", Aliases: []string{"visitor_email_limit_burst"}, EnvVars: []string{"NTFY_VISITOR_EMAIL_LIMIT_BURST"}, Value: server.DefaultVisitorEmailLimitBurst, Usage: "initial limit of e-mails per visitor"}),
  83. altsrc.NewStringFlag(&cli.StringFlag{Name: "visitor-email-limit-replenish", Aliases: []string{"visitor_email_limit_replenish"}, EnvVars: []string{"NTFY_VISITOR_EMAIL_LIMIT_REPLENISH"}, Value: util.FormatDuration(server.DefaultVisitorEmailLimitReplenish), Usage: "interval at which burst limit is replenished (one per x)"}),
  84. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "visitor-subscriber-rate-limiting", Aliases: []string{"visitor_subscriber_rate_limiting"}, EnvVars: []string{"NTFY_VISITOR_SUBSCRIBER_RATE_LIMITING"}, Value: false, Usage: "enables subscriber-based rate limiting"}),
  85. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "behind-proxy", Aliases: []string{"behind_proxy", "P"}, EnvVars: []string{"NTFY_BEHIND_PROXY"}, Value: false, Usage: "if set, use X-Forwarded-For header to determine visitor IP address (for rate limiting)"}),
  86. altsrc.NewStringFlag(&cli.StringFlag{Name: "stripe-secret-key", Aliases: []string{"stripe_secret_key"}, EnvVars: []string{"NTFY_STRIPE_SECRET_KEY"}, Value: "", Usage: "key used for the Stripe API communication, this enables payments"}),
  87. altsrc.NewStringFlag(&cli.StringFlag{Name: "stripe-webhook-key", Aliases: []string{"stripe_webhook_key"}, EnvVars: []string{"NTFY_STRIPE_WEBHOOK_KEY"}, Value: "", Usage: "key required to validate the authenticity of incoming webhooks from Stripe"}),
  88. altsrc.NewStringFlag(&cli.StringFlag{Name: "billing-contact", Aliases: []string{"billing_contact"}, EnvVars: []string{"NTFY_BILLING_CONTACT"}, Value: "", Usage: "e-mail or website to display in upgrade dialog (only if payments are enabled)"}),
  89. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "enable-metrics", Aliases: []string{"enable_metrics"}, EnvVars: []string{"NTFY_ENABLE_METRICS"}, Value: false, Usage: "if set, Prometheus metrics are exposed via the /metrics endpoint"}),
  90. altsrc.NewStringFlag(&cli.StringFlag{Name: "metrics-listen-http", Aliases: []string{"metrics_listen_http"}, EnvVars: []string{"NTFY_METRICS_LISTEN_HTTP"}, Usage: "ip:port used to expose the metrics endpoint (implicitly enables metrics)"}),
  91. altsrc.NewStringFlag(&cli.StringFlag{Name: "profile-listen-http", Aliases: []string{"profile_listen_http"}, EnvVars: []string{"NTFY_PROFILE_LISTEN_HTTP"}, Usage: "ip:port used to expose the profiling endpoints (implicitly enables profiling)"}),
  92. altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-public-key", Aliases: []string{"web_push_public_key"}, EnvVars: []string{"NTFY_WEB_PUSH_PUBLIC_KEY"}, Usage: "public key used for web push notifications"}),
  93. altsrc.NewStringFlag(&cli.StringFlag{Name: "web-push-private-key", Aliases: []string{"web_push_private_key"}, EnvVars: []string{"NTFY_WEB_PUSH_PRIVATE_KEY"}, Usage: "private key used for web push notifications"}),
  94. 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"}),
  95. 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"}),
  96. 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"}),
  97. )
  98. var cmdServe = &cli.Command{
  99. Name: "serve",
  100. Usage: "Run the ntfy server",
  101. UsageText: "ntfy serve [OPTIONS..]",
  102. Action: execServe,
  103. Category: categoryServer,
  104. Flags: flagsServe,
  105. Before: initConfigFileInputSourceFunc("config", flagsServe, initLogFunc),
  106. Description: `Run the ntfy server and listen for incoming requests
  107. The command will load the configuration from /etc/ntfy/server.yml. Config options can
  108. be overridden using the command line options.
  109. Examples:
  110. ntfy serve # Starts server in the foreground (on port 80)
  111. ntfy serve --listen-http :8080 # Starts server with alternate port`,
  112. }
  113. func execServe(c *cli.Context) error {
  114. if c.NArg() > 0 {
  115. return errors.New("no arguments expected, see 'ntfy serve --help' for help")
  116. }
  117. // Read all the options
  118. config := c.String("config")
  119. baseURL := c.String("base-url")
  120. listenHTTP := c.String("listen-http")
  121. listenHTTPS := c.String("listen-https")
  122. listenUnix := c.String("listen-unix")
  123. listenUnixMode := c.Int("listen-unix-mode")
  124. keyFile := c.String("key-file")
  125. certFile := c.String("cert-file")
  126. firebaseKeyFile := c.String("firebase-key-file")
  127. webPushPrivateKey := c.String("web-push-private-key")
  128. webPushPublicKey := c.String("web-push-public-key")
  129. webPushFile := c.String("web-push-file")
  130. webPushEmailAddress := c.String("web-push-email-address")
  131. webPushStartupQueries := c.String("web-push-startup-queries")
  132. cacheFile := c.String("cache-file")
  133. cacheDurationStr := c.String("cache-duration")
  134. cacheStartupQueries := c.String("cache-startup-queries")
  135. cacheBatchSize := c.Int("cache-batch-size")
  136. cacheBatchTimeoutStr := c.String("cache-batch-timeout")
  137. authFile := c.String("auth-file")
  138. authStartupQueries := c.String("auth-startup-queries")
  139. authDefaultAccess := c.String("auth-default-access")
  140. attachmentCacheDir := c.String("attachment-cache-dir")
  141. attachmentTotalSizeLimitStr := c.String("attachment-total-size-limit")
  142. attachmentFileSizeLimitStr := c.String("attachment-file-size-limit")
  143. attachmentExpiryDurationStr := c.String("attachment-expiry-duration")
  144. keepaliveIntervalStr := c.String("keepalive-interval")
  145. managerIntervalStr := c.String("manager-interval")
  146. disallowedTopics := c.StringSlice("disallowed-topics")
  147. webRoot := c.String("web-root")
  148. enableSignup := c.Bool("enable-signup")
  149. enableLogin := c.Bool("enable-login")
  150. enableReservations := c.Bool("enable-reservations")
  151. upstreamBaseURL := c.String("upstream-base-url")
  152. upstreamAccessToken := c.String("upstream-access-token")
  153. smtpSenderAddr := c.String("smtp-sender-addr")
  154. smtpSenderUser := c.String("smtp-sender-user")
  155. smtpSenderPass := c.String("smtp-sender-pass")
  156. smtpSenderFrom := c.String("smtp-sender-from")
  157. smtpServerListen := c.String("smtp-server-listen")
  158. smtpServerDomain := c.String("smtp-server-domain")
  159. smtpServerAddrPrefix := c.String("smtp-server-addr-prefix")
  160. twilioAccount := c.String("twilio-account")
  161. twilioAuthToken := c.String("twilio-auth-token")
  162. twilioPhoneNumber := c.String("twilio-phone-number")
  163. twilioVerifyService := c.String("twilio-verify-service")
  164. messageSizeLimitStr := c.String("message-size-limit")
  165. messageDelayLimitStr := c.String("message-delay-limit")
  166. totalTopicLimit := c.Int("global-topic-limit")
  167. visitorSubscriptionLimit := c.Int("visitor-subscription-limit")
  168. visitorSubscriberRateLimiting := c.Bool("visitor-subscriber-rate-limiting")
  169. visitorAttachmentTotalSizeLimitStr := c.String("visitor-attachment-total-size-limit")
  170. visitorAttachmentDailyBandwidthLimitStr := c.String("visitor-attachment-daily-bandwidth-limit")
  171. visitorRequestLimitBurst := c.Int("visitor-request-limit-burst")
  172. visitorRequestLimitReplenishStr := c.String("visitor-request-limit-replenish")
  173. visitorRequestLimitExemptHosts := util.SplitNoEmpty(c.String("visitor-request-limit-exempt-hosts"), ",")
  174. visitorMessageDailyLimit := c.Int("visitor-message-daily-limit")
  175. visitorEmailLimitBurst := c.Int("visitor-email-limit-burst")
  176. visitorEmailLimitReplenishStr := c.String("visitor-email-limit-replenish")
  177. behindProxy := c.Bool("behind-proxy")
  178. stripeSecretKey := c.String("stripe-secret-key")
  179. stripeWebhookKey := c.String("stripe-webhook-key")
  180. billingContact := c.String("billing-contact")
  181. metricsListenHTTP := c.String("metrics-listen-http")
  182. enableMetrics := c.Bool("enable-metrics") || metricsListenHTTP != ""
  183. profileListenHTTP := c.String("profile-listen-http")
  184. // Convert durations
  185. cacheDuration, err := util.ParseDuration(cacheDurationStr)
  186. if err != nil {
  187. return fmt.Errorf("invalid cache duration: %s", cacheDurationStr)
  188. }
  189. cacheBatchTimeout, err := util.ParseDuration(cacheBatchTimeoutStr)
  190. if err != nil {
  191. return fmt.Errorf("invalid cache batch timeout: %s", cacheBatchTimeoutStr)
  192. }
  193. attachmentExpiryDuration, err := util.ParseDuration(attachmentExpiryDurationStr)
  194. if err != nil {
  195. return fmt.Errorf("invalid attachment expiry duration: %s", attachmentExpiryDurationStr)
  196. }
  197. keepaliveInterval, err := util.ParseDuration(keepaliveIntervalStr)
  198. if err != nil {
  199. return fmt.Errorf("invalid keepalive interval: %s", keepaliveIntervalStr)
  200. }
  201. managerInterval, err := util.ParseDuration(managerIntervalStr)
  202. if err != nil {
  203. return fmt.Errorf("invalid manager interval: %s", managerIntervalStr)
  204. }
  205. messageDelayLimit, err := util.ParseDuration(messageDelayLimitStr)
  206. if err != nil {
  207. return fmt.Errorf("invalid message delay limit: %s", messageDelayLimitStr)
  208. }
  209. visitorRequestLimitReplenish, err := util.ParseDuration(visitorRequestLimitReplenishStr)
  210. if err != nil {
  211. return fmt.Errorf("invalid visitor request limit replenish: %s", visitorRequestLimitReplenishStr)
  212. }
  213. visitorEmailLimitReplenish, err := util.ParseDuration(visitorEmailLimitReplenishStr)
  214. if err != nil {
  215. return fmt.Errorf("invalid visitor email limit replenish: %s", visitorEmailLimitReplenishStr)
  216. }
  217. // Convert sizes to bytes
  218. messageSizeLimit, err := util.ParseSize(messageSizeLimitStr)
  219. if err != nil {
  220. return fmt.Errorf("invalid message size limit: %s", messageSizeLimitStr)
  221. }
  222. attachmentTotalSizeLimit, err := util.ParseSize(attachmentTotalSizeLimitStr)
  223. if err != nil {
  224. return fmt.Errorf("invalid attachment total size limit: %s", attachmentTotalSizeLimitStr)
  225. }
  226. attachmentFileSizeLimit, err := util.ParseSize(attachmentFileSizeLimitStr)
  227. if err != nil {
  228. return fmt.Errorf("invalid attachment file size limit: %s", attachmentFileSizeLimitStr)
  229. }
  230. visitorAttachmentTotalSizeLimit, err := util.ParseSize(visitorAttachmentTotalSizeLimitStr)
  231. if err != nil {
  232. return fmt.Errorf("invalid visitor attachment total size limit: %s", visitorAttachmentTotalSizeLimitStr)
  233. }
  234. visitorAttachmentDailyBandwidthLimit, err := util.ParseSize(visitorAttachmentDailyBandwidthLimitStr)
  235. if err != nil {
  236. return fmt.Errorf("invalid visitor attachment daily bandwidth limit: %s", visitorAttachmentDailyBandwidthLimitStr)
  237. } else if visitorAttachmentDailyBandwidthLimit > math.MaxInt {
  238. return fmt.Errorf("config option visitor-attachment-daily-bandwidth-limit must be lower than %d", math.MaxInt)
  239. }
  240. // Check values
  241. if firebaseKeyFile != "" && !util.FileExists(firebaseKeyFile) {
  242. return errors.New("if set, FCM key file must exist")
  243. } else if webPushPublicKey != "" && (webPushPrivateKey == "" || webPushFile == "" || webPushEmailAddress == "" || baseURL == "") {
  244. return errors.New("if web push is enabled, web-push-private-key, web-push-public-key, web-push-file, web-push-email-address, and base-url should be set. run 'ntfy webpush keys' to generate keys")
  245. } else if keepaliveInterval < 5*time.Second {
  246. return errors.New("keepalive interval cannot be lower than five seconds")
  247. } else if managerInterval < 5*time.Second {
  248. return errors.New("manager interval cannot be lower than five seconds")
  249. } else if cacheDuration > 0 && cacheDuration < managerInterval {
  250. return errors.New("cache duration cannot be lower than manager interval")
  251. } else if keyFile != "" && !util.FileExists(keyFile) {
  252. return errors.New("if set, key file must exist")
  253. } else if certFile != "" && !util.FileExists(certFile) {
  254. return errors.New("if set, certificate file must exist")
  255. } else if listenHTTPS != "" && (keyFile == "" || certFile == "") {
  256. return errors.New("if listen-https is set, both key-file and cert-file must be set")
  257. } else if smtpSenderAddr != "" && (baseURL == "" || smtpSenderFrom == "") {
  258. return errors.New("if smtp-sender-addr is set, base-url, and smtp-sender-from must also be set")
  259. } else if smtpServerListen != "" && smtpServerDomain == "" {
  260. return errors.New("if smtp-server-listen is set, smtp-server-domain must also be set")
  261. } else if attachmentCacheDir != "" && baseURL == "" {
  262. return errors.New("if attachment-cache-dir is set, base-url must also be set")
  263. } else if baseURL != "" && !strings.HasPrefix(baseURL, "http://") && !strings.HasPrefix(baseURL, "https://") {
  264. return errors.New("if set, base-url must start with http:// or https://")
  265. } else if baseURL != "" && strings.HasSuffix(baseURL, "/") {
  266. return errors.New("if set, base-url must not end with a slash (/)")
  267. } else if upstreamBaseURL != "" && !strings.HasPrefix(upstreamBaseURL, "http://") && !strings.HasPrefix(upstreamBaseURL, "https://") {
  268. return errors.New("if set, upstream-base-url must start with http:// or https://")
  269. } else if upstreamBaseURL != "" && strings.HasSuffix(upstreamBaseURL, "/") {
  270. return errors.New("if set, upstream-base-url must not end with a slash (/)")
  271. } else if upstreamBaseURL != "" && baseURL == "" {
  272. return errors.New("if upstream-base-url is set, base-url must also be set")
  273. } else if upstreamBaseURL != "" && baseURL != "" && baseURL == upstreamBaseURL {
  274. return errors.New("base-url and upstream-base-url cannot be identical, you'll likely want to set upstream-base-url to https://ntfy.sh, see https://ntfy.sh/docs/config/#ios-instant-notifications")
  275. } else if authFile == "" && (enableSignup || enableLogin || enableReservations || stripeSecretKey != "") {
  276. return errors.New("cannot set enable-signup, enable-login, enable-reserve-topics, or stripe-secret-key if auth-file is not set")
  277. } else if enableSignup && !enableLogin {
  278. return errors.New("cannot set enable-signup without also setting enable-login")
  279. } else if stripeSecretKey != "" && (stripeWebhookKey == "" || baseURL == "") {
  280. return errors.New("if stripe-secret-key is set, stripe-webhook-key and base-url must also be set")
  281. } else if twilioAccount != "" && (twilioAuthToken == "" || twilioPhoneNumber == "" || twilioVerifyService == "" || baseURL == "" || authFile == "") {
  282. return errors.New("if twilio-account is set, twilio-auth-token, twilio-phone-number, twilio-verify-service, base-url, and auth-file must also be set")
  283. } else if messageSizeLimit > server.DefaultMessageSizeLimit {
  284. log.Warn("message-size-limit is greater than 4K, this is not recommended and largely untested, and may lead to issues with some clients")
  285. if messageSizeLimit > 5*1024*1024 {
  286. return errors.New("message-size-limit cannot be higher than 5M")
  287. }
  288. }
  289. // Backwards compatibility
  290. if webRoot == "app" {
  291. webRoot = "/"
  292. } else if webRoot == "home" {
  293. webRoot = "/app"
  294. } else if webRoot == "disable" {
  295. webRoot = ""
  296. } else if !strings.HasPrefix(webRoot, "/") {
  297. webRoot = "/" + webRoot
  298. }
  299. // Default auth permissions
  300. authDefault, err := user.ParsePermission(authDefaultAccess)
  301. if err != nil {
  302. return errors.New("if set, auth-default-access must start set to 'read-write', 'read-only', 'write-only' or 'deny-all'")
  303. }
  304. // Special case: Unset default
  305. if listenHTTP == "-" {
  306. listenHTTP = ""
  307. }
  308. // Resolve hosts
  309. visitorRequestLimitExemptIPs := make([]netip.Prefix, 0)
  310. for _, host := range visitorRequestLimitExemptHosts {
  311. ips, err := parseIPHostPrefix(host)
  312. if err != nil {
  313. log.Warn("cannot resolve host %s: %s, ignoring visitor request exemption", host, err.Error())
  314. continue
  315. }
  316. visitorRequestLimitExemptIPs = append(visitorRequestLimitExemptIPs, ips...)
  317. }
  318. // Stripe things
  319. if stripeSecretKey != "" {
  320. stripe.EnableTelemetry = false // Whoa!
  321. stripe.Key = stripeSecretKey
  322. }
  323. // Add default forbidden topics
  324. disallowedTopics = append(disallowedTopics, server.DefaultDisallowedTopics...)
  325. // Run server
  326. conf := server.NewConfig()
  327. conf.File = config
  328. conf.BaseURL = baseURL
  329. conf.ListenHTTP = listenHTTP
  330. conf.ListenHTTPS = listenHTTPS
  331. conf.ListenUnix = listenUnix
  332. conf.ListenUnixMode = fs.FileMode(listenUnixMode)
  333. conf.KeyFile = keyFile
  334. conf.CertFile = certFile
  335. conf.FirebaseKeyFile = firebaseKeyFile
  336. conf.CacheFile = cacheFile
  337. conf.CacheDuration = cacheDuration
  338. conf.CacheStartupQueries = cacheStartupQueries
  339. conf.CacheBatchSize = cacheBatchSize
  340. conf.CacheBatchTimeout = cacheBatchTimeout
  341. conf.AuthFile = authFile
  342. conf.AuthStartupQueries = authStartupQueries
  343. conf.AuthDefault = authDefault
  344. conf.AttachmentCacheDir = attachmentCacheDir
  345. conf.AttachmentTotalSizeLimit = attachmentTotalSizeLimit
  346. conf.AttachmentFileSizeLimit = attachmentFileSizeLimit
  347. conf.AttachmentExpiryDuration = attachmentExpiryDuration
  348. conf.KeepaliveInterval = keepaliveInterval
  349. conf.ManagerInterval = managerInterval
  350. conf.DisallowedTopics = disallowedTopics
  351. conf.WebRoot = webRoot
  352. conf.UpstreamBaseURL = upstreamBaseURL
  353. conf.UpstreamAccessToken = upstreamAccessToken
  354. conf.SMTPSenderAddr = smtpSenderAddr
  355. conf.SMTPSenderUser = smtpSenderUser
  356. conf.SMTPSenderPass = smtpSenderPass
  357. conf.SMTPSenderFrom = smtpSenderFrom
  358. conf.SMTPServerListen = smtpServerListen
  359. conf.SMTPServerDomain = smtpServerDomain
  360. conf.SMTPServerAddrPrefix = smtpServerAddrPrefix
  361. conf.TwilioAccount = twilioAccount
  362. conf.TwilioAuthToken = twilioAuthToken
  363. conf.TwilioPhoneNumber = twilioPhoneNumber
  364. conf.TwilioVerifyService = twilioVerifyService
  365. conf.MessageSizeLimit = int(messageSizeLimit)
  366. conf.MessageDelayMax = messageDelayLimit
  367. conf.TotalTopicLimit = totalTopicLimit
  368. conf.VisitorSubscriptionLimit = visitorSubscriptionLimit
  369. conf.VisitorAttachmentTotalSizeLimit = visitorAttachmentTotalSizeLimit
  370. conf.VisitorAttachmentDailyBandwidthLimit = visitorAttachmentDailyBandwidthLimit
  371. conf.VisitorRequestLimitBurst = visitorRequestLimitBurst
  372. conf.VisitorRequestLimitReplenish = visitorRequestLimitReplenish
  373. conf.VisitorRequestExemptIPAddrs = visitorRequestLimitExemptIPs
  374. conf.VisitorMessageDailyLimit = visitorMessageDailyLimit
  375. conf.VisitorEmailLimitBurst = visitorEmailLimitBurst
  376. conf.VisitorEmailLimitReplenish = visitorEmailLimitReplenish
  377. conf.VisitorSubscriberRateLimiting = visitorSubscriberRateLimiting
  378. conf.BehindProxy = behindProxy
  379. conf.StripeSecretKey = stripeSecretKey
  380. conf.StripeWebhookKey = stripeWebhookKey
  381. conf.BillingContact = billingContact
  382. conf.EnableSignup = enableSignup
  383. conf.EnableLogin = enableLogin
  384. conf.EnableReservations = enableReservations
  385. conf.EnableMetrics = enableMetrics
  386. conf.MetricsListenHTTP = metricsListenHTTP
  387. conf.ProfileListenHTTP = profileListenHTTP
  388. conf.Version = c.App.Version
  389. conf.WebPushPrivateKey = webPushPrivateKey
  390. conf.WebPushPublicKey = webPushPublicKey
  391. conf.WebPushFile = webPushFile
  392. conf.WebPushEmailAddress = webPushEmailAddress
  393. conf.WebPushStartupQueries = webPushStartupQueries
  394. // Set up hot-reloading of config
  395. go sigHandlerConfigReload(config)
  396. // Run server
  397. s, err := server.New(conf)
  398. if err != nil {
  399. log.Fatal(err.Error())
  400. } else if err := s.Run(); err != nil {
  401. log.Fatal(err.Error())
  402. }
  403. log.Info("Exiting.")
  404. return nil
  405. }
  406. func parseSize(s string, defaultValue int64) (v int64, err error) {
  407. if s == "" {
  408. return defaultValue, nil
  409. }
  410. v, err = util.ParseSize(s)
  411. if err != nil {
  412. return 0, err
  413. }
  414. return v, nil
  415. }
  416. func sigHandlerConfigReload(config string) {
  417. sigs := make(chan os.Signal, 1)
  418. signal.Notify(sigs, syscall.SIGHUP)
  419. for range sigs {
  420. log.Info("Partially hot reloading configuration ...")
  421. inputSource, err := newYamlSourceFromFile(config, flagsServe)
  422. if err != nil {
  423. log.Warn("Hot reload failed: %s", err.Error())
  424. continue
  425. }
  426. if err := reloadLogLevel(inputSource); err != nil {
  427. log.Warn("Reloading log level failed: %s", err.Error())
  428. }
  429. }
  430. }
  431. func parseIPHostPrefix(host string) (prefixes []netip.Prefix, err error) {
  432. // Try parsing as prefix, e.g. 10.0.1.0/24
  433. prefix, err := netip.ParsePrefix(host)
  434. if err == nil {
  435. prefixes = append(prefixes, prefix.Masked())
  436. return prefixes, nil
  437. }
  438. // Not a prefix, parse as host or IP (LookupHost passes through an IP as is)
  439. ips, err := net.LookupHost(host)
  440. if err != nil {
  441. return nil, err
  442. }
  443. for _, ipStr := range ips {
  444. ip, err := netip.ParseAddr(ipStr)
  445. if err == nil {
  446. prefix, err := ip.Prefix(ip.BitLen())
  447. if err != nil {
  448. return nil, fmt.Errorf("%s successfully parsed but unable to make prefix: %s", ip.String(), err.Error())
  449. }
  450. prefixes = append(prefixes, prefix.Masked())
  451. }
  452. }
  453. return
  454. }
  455. func reloadLogLevel(inputSource altsrc.InputSourceContext) error {
  456. newLevelStr, err := inputSource.String("log-level")
  457. if err != nil {
  458. return fmt.Errorf("cannot load log level: %s", err.Error())
  459. }
  460. overrides, err := inputSource.StringSlice("log-level-overrides")
  461. if err != nil {
  462. return fmt.Errorf("cannot load log level overrides (1): %s", err.Error())
  463. }
  464. log.ResetLevelOverrides()
  465. if err := applyLogLevelOverrides(overrides); err != nil {
  466. return fmt.Errorf("cannot load log level overrides (2): %s", err.Error())
  467. }
  468. log.SetLevel(log.ToLevel(newLevelStr))
  469. if len(overrides) > 0 {
  470. log.Info("Log level is %v, %d override(s) in place", strings.ToUpper(newLevelStr), len(overrides))
  471. } else {
  472. log.Info("Log level is %v", strings.ToUpper(newLevelStr))
  473. }
  474. return nil
  475. }