serve.go 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673
  1. //go:build !noserver
  2. package cmd
  3. import (
  4. "errors"
  5. "fmt"
  6. "io/fs"
  7. "math"
  8. "net"
  9. "net/netip"
  10. "net/url"
  11. "os"
  12. "os/signal"
  13. "strings"
  14. "syscall"
  15. "time"
  16. "github.com/urfave/cli/v2"
  17. "github.com/urfave/cli/v2/altsrc"
  18. "heckel.io/ntfy/v2/log"
  19. "heckel.io/ntfy/v2/payments"
  20. "heckel.io/ntfy/v2/server"
  21. "heckel.io/ntfy/v2/user"
  22. "heckel.io/ntfy/v2/util"
  23. )
  24. func init() {
  25. commands = append(commands, cmdServe)
  26. }
  27. var flagsServe = append(
  28. append([]cli.Flag{}, flagsDefault...),
  29. &cli.StringFlag{Name: "config", Aliases: []string{"c"}, EnvVars: []string{"NTFY_CONFIG_FILE"}, Value: server.DefaultConfigFile, Usage: "config file"},
  30. 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)"}),
  31. 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"}),
  32. 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"}),
  33. altsrc.NewStringFlag(&cli.StringFlag{Name: "listen-unix", Aliases: []string{"listen_unix", "U"}, EnvVars: []string{"NTFY_LISTEN_UNIX"}, Usage: "listen on unix socket path"}),
  34. 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"}),
  35. 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"}),
  36. 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"}),
  37. 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"}),
  38. altsrc.NewStringFlag(&cli.StringFlag{Name: "cache-file", Aliases: []string{"cache_file", "C"}, EnvVars: []string{"NTFY_CACHE_FILE"}, Usage: "cache file used for message caching"}),
  39. 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"}),
  40. 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)"}),
  41. 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)"}),
  42. 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"}),
  43. 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"}),
  44. 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"}),
  45. 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"}),
  46. altsrc.NewStringSliceFlag(&cli.StringSliceFlag{Name: "auth-users", Aliases: []string{"auth_users"}, EnvVars: []string{"NTFY_AUTH_USERS"}, Usage: "pre-provisioned declarative users"}),
  47. altsrc.NewStringSliceFlag(&cli.StringSliceFlag{Name: "auth-access", Aliases: []string{"auth_access"}, EnvVars: []string{"NTFY_AUTH_ACCESS"}, Usage: "pre-provisioned declarative access control entries"}),
  48. altsrc.NewStringSliceFlag(&cli.StringSliceFlag{Name: "auth-tokens", Aliases: []string{"auth_tokens"}, EnvVars: []string{"NTFY_AUTH_TOKENS"}, Usage: "pre-provisioned declarative access tokens"}),
  49. 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"}),
  50. 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"}),
  51. 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)"}),
  52. 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)"}),
  53. altsrc.NewStringFlag(&cli.StringFlag{Name: "template-dir", Aliases: []string{"template_dir"}, EnvVars: []string{"NTFY_TEMPLATE_DIR"}, Value: server.DefaultTemplateDir, Usage: "directory to load named message templates from"}),
  54. 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"}),
  55. 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"}),
  56. 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"}),
  57. 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)"}),
  58. 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"}),
  59. 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"}),
  60. 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)"}),
  61. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "require-login", Aliases: []string{"require_login"}, EnvVars: []string{"NTFY_REQUIRE_LOGIN"}, Value: false, Usage: "all actions via the web app requires a login"}),
  62. 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"}),
  63. 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"}),
  64. 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"}),
  65. 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)"}),
  66. 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)"}),
  67. 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)"}),
  68. 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"}),
  69. 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"}),
  70. 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-')"}),
  71. 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..."}),
  72. altsrc.NewStringFlag(&cli.StringFlag{Name: "twilio-auth-token", Aliases: []string{"twilio_auth_token"}, EnvVars: []string{"NTFY_TWILIO_AUTH_TOKEN"}, Usage: "Twilio auth token"}),
  73. 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"}),
  74. 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"}),
  75. 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)"}),
  76. 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"}),
  77. 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"}),
  78. 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"}),
  79. 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"}),
  80. 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"}),
  81. 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"}),
  82. 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"}),
  83. 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)"}),
  84. 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"}),
  85. 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"}),
  86. 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"}),
  87. 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)"}),
  88. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-prefix-bits-ipv4", Aliases: []string{"visitor_prefix_bits_ipv4"}, EnvVars: []string{"NTFY_VISITOR_PREFIX_BITS_IPV4"}, Value: server.DefaultVisitorPrefixBitsIPv4, Usage: "number of bits of the IPv4 address to use for rate limiting (default: 32, full address)"}),
  89. altsrc.NewIntFlag(&cli.IntFlag{Name: "visitor-prefix-bits-ipv6", Aliases: []string{"visitor_prefix_bits_ipv6"}, EnvVars: []string{"NTFY_VISITOR_PREFIX_BITS_IPV6"}, Value: server.DefaultVisitorPrefixBitsIPv6, Usage: "number of bits of the IPv6 address to use for rate limiting (default: 64, /64 subnet)"}),
  90. altsrc.NewBoolFlag(&cli.BoolFlag{Name: "behind-proxy", Aliases: []string{"behind_proxy", "P"}, EnvVars: []string{"NTFY_BEHIND_PROXY"}, Value: false, Usage: "if set, use forwarded header (e.g. X-Forwarded-For, X-Client-IP) to determine visitor IP address (for rate limiting)"}),
  91. altsrc.NewStringFlag(&cli.StringFlag{Name: "proxy-forwarded-header", Aliases: []string{"proxy_forwarded_header"}, EnvVars: []string{"NTFY_PROXY_FORWARDED_HEADER"}, Value: "X-Forwarded-For", Usage: "use specified header to determine visitor IP address (for rate limiting)"}),
  92. altsrc.NewStringFlag(&cli.StringFlag{Name: "proxy-trusted-hosts", Aliases: []string{"proxy_trusted_hosts"}, EnvVars: []string{"NTFY_PROXY_TRUSTED_HOSTS"}, Value: "", Usage: "comma-separated list of trusted IP addresses, hosts, or CIDRs to remove from forwarded header"}),
  93. 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"}),
  94. 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"}),
  95. 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)"}),
  96. 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"}),
  97. 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)"}),
  98. 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)"}),
  99. 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"}),
  100. 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"}),
  101. 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"}),
  102. 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"}),
  103. 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"}),
  104. 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: "automatically expire unused subscriptions after this time"}),
  105. 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: "send web push warning notification after this time before expiring unused subscriptions"}),
  106. )
  107. var cmdServe = &cli.Command{
  108. Name: "serve",
  109. Usage: "Run the ntfy server",
  110. UsageText: "ntfy serve [OPTIONS..]",
  111. Action: execServe,
  112. Category: categoryServer,
  113. Flags: flagsServe,
  114. Before: initConfigFileInputSourceFunc("config", flagsServe, initLogFunc),
  115. Description: `Run the ntfy server and listen for incoming requests
  116. The command will load the configuration from /etc/ntfy/server.yml. Config options can
  117. be overridden using the command line options.
  118. Examples:
  119. ntfy serve # Starts server in the foreground (on port 80)
  120. ntfy serve --listen-http :8080 # Starts server with alternate port`,
  121. }
  122. func execServe(c *cli.Context) error {
  123. if c.NArg() > 0 {
  124. return errors.New("no arguments expected, see 'ntfy serve --help' for help")
  125. }
  126. // Read all the options
  127. config := c.String("config")
  128. baseURL := strings.TrimSuffix(c.String("base-url"), "/")
  129. listenHTTP := c.String("listen-http")
  130. listenHTTPS := c.String("listen-https")
  131. listenUnix := c.String("listen-unix")
  132. listenUnixMode := c.Int("listen-unix-mode")
  133. keyFile := c.String("key-file")
  134. certFile := c.String("cert-file")
  135. firebaseKeyFile := c.String("firebase-key-file")
  136. webPushPrivateKey := c.String("web-push-private-key")
  137. webPushPublicKey := c.String("web-push-public-key")
  138. webPushFile := c.String("web-push-file")
  139. webPushEmailAddress := c.String("web-push-email-address")
  140. webPushStartupQueries := c.String("web-push-startup-queries")
  141. webPushExpiryDurationStr := c.String("web-push-expiry-duration")
  142. webPushExpiryWarningDurationStr := c.String("web-push-expiry-warning-duration")
  143. cacheFile := c.String("cache-file")
  144. cacheDurationStr := c.String("cache-duration")
  145. cacheStartupQueries := c.String("cache-startup-queries")
  146. cacheBatchSize := c.Int("cache-batch-size")
  147. cacheBatchTimeoutStr := c.String("cache-batch-timeout")
  148. authFile := c.String("auth-file")
  149. authStartupQueries := c.String("auth-startup-queries")
  150. authDefaultAccess := c.String("auth-default-access")
  151. authUsersRaw := c.StringSlice("auth-users")
  152. authAccessRaw := c.StringSlice("auth-access")
  153. authTokensRaw := c.StringSlice("auth-tokens")
  154. attachmentCacheDir := c.String("attachment-cache-dir")
  155. attachmentTotalSizeLimitStr := c.String("attachment-total-size-limit")
  156. attachmentFileSizeLimitStr := c.String("attachment-file-size-limit")
  157. attachmentExpiryDurationStr := c.String("attachment-expiry-duration")
  158. templateDir := c.String("template-dir")
  159. keepaliveIntervalStr := c.String("keepalive-interval")
  160. managerIntervalStr := c.String("manager-interval")
  161. disallowedTopics := c.StringSlice("disallowed-topics")
  162. webRoot := c.String("web-root")
  163. enableSignup := c.Bool("enable-signup")
  164. enableLogin := c.Bool("enable-login")
  165. enableReservations := c.Bool("enable-reservations")
  166. upstreamBaseURL := c.String("upstream-base-url")
  167. upstreamAccessToken := c.String("upstream-access-token")
  168. smtpSenderAddr := c.String("smtp-sender-addr")
  169. smtpSenderUser := c.String("smtp-sender-user")
  170. smtpSenderPass := c.String("smtp-sender-pass")
  171. smtpSenderFrom := c.String("smtp-sender-from")
  172. smtpServerListen := c.String("smtp-server-listen")
  173. smtpServerDomain := c.String("smtp-server-domain")
  174. smtpServerAddrPrefix := c.String("smtp-server-addr-prefix")
  175. twilioAccount := c.String("twilio-account")
  176. twilioAuthToken := c.String("twilio-auth-token")
  177. twilioPhoneNumber := c.String("twilio-phone-number")
  178. twilioVerifyService := c.String("twilio-verify-service")
  179. messageSizeLimitStr := c.String("message-size-limit")
  180. messageDelayLimitStr := c.String("message-delay-limit")
  181. totalTopicLimit := c.Int("global-topic-limit")
  182. visitorSubscriptionLimit := c.Int("visitor-subscription-limit")
  183. visitorSubscriberRateLimiting := c.Bool("visitor-subscriber-rate-limiting")
  184. visitorAttachmentTotalSizeLimitStr := c.String("visitor-attachment-total-size-limit")
  185. visitorAttachmentDailyBandwidthLimitStr := c.String("visitor-attachment-daily-bandwidth-limit")
  186. visitorRequestLimitBurst := c.Int("visitor-request-limit-burst")
  187. visitorRequestLimitReplenishStr := c.String("visitor-request-limit-replenish")
  188. visitorRequestLimitExemptHosts := util.SplitNoEmpty(c.String("visitor-request-limit-exempt-hosts"), ",")
  189. visitorMessageDailyLimit := c.Int("visitor-message-daily-limit")
  190. visitorEmailLimitBurst := c.Int("visitor-email-limit-burst")
  191. visitorEmailLimitReplenishStr := c.String("visitor-email-limit-replenish")
  192. visitorPrefixBitsIPv4 := c.Int("visitor-prefix-bits-ipv4")
  193. visitorPrefixBitsIPv6 := c.Int("visitor-prefix-bits-ipv6")
  194. behindProxy := c.Bool("behind-proxy")
  195. proxyForwardedHeader := c.String("proxy-forwarded-header")
  196. proxyTrustedHosts := util.SplitNoEmpty(c.String("proxy-trusted-hosts"), ",")
  197. stripeSecretKey := c.String("stripe-secret-key")
  198. stripeWebhookKey := c.String("stripe-webhook-key")
  199. billingContact := c.String("billing-contact")
  200. metricsListenHTTP := c.String("metrics-listen-http")
  201. enableMetrics := c.Bool("enable-metrics") || metricsListenHTTP != ""
  202. profileListenHTTP := c.String("profile-listen-http")
  203. // Convert durations
  204. cacheDuration, err := util.ParseDuration(cacheDurationStr)
  205. if err != nil {
  206. return fmt.Errorf("invalid cache duration: %s", cacheDurationStr)
  207. }
  208. cacheBatchTimeout, err := util.ParseDuration(cacheBatchTimeoutStr)
  209. if err != nil {
  210. return fmt.Errorf("invalid cache batch timeout: %s", cacheBatchTimeoutStr)
  211. }
  212. attachmentExpiryDuration, err := util.ParseDuration(attachmentExpiryDurationStr)
  213. if err != nil {
  214. return fmt.Errorf("invalid attachment expiry duration: %s", attachmentExpiryDurationStr)
  215. }
  216. keepaliveInterval, err := util.ParseDuration(keepaliveIntervalStr)
  217. if err != nil {
  218. return fmt.Errorf("invalid keepalive interval: %s", keepaliveIntervalStr)
  219. }
  220. managerInterval, err := util.ParseDuration(managerIntervalStr)
  221. if err != nil {
  222. return fmt.Errorf("invalid manager interval: %s", managerIntervalStr)
  223. }
  224. messageDelayLimit, err := util.ParseDuration(messageDelayLimitStr)
  225. if err != nil {
  226. return fmt.Errorf("invalid message delay limit: %s", messageDelayLimitStr)
  227. }
  228. visitorRequestLimitReplenish, err := util.ParseDuration(visitorRequestLimitReplenishStr)
  229. if err != nil {
  230. return fmt.Errorf("invalid visitor request limit replenish: %s", visitorRequestLimitReplenishStr)
  231. }
  232. visitorEmailLimitReplenish, err := util.ParseDuration(visitorEmailLimitReplenishStr)
  233. if err != nil {
  234. return fmt.Errorf("invalid visitor email limit replenish: %s", visitorEmailLimitReplenishStr)
  235. }
  236. webPushExpiryDuration, err := util.ParseDuration(webPushExpiryDurationStr)
  237. if err != nil {
  238. return fmt.Errorf("invalid web push expiry duration: %s", webPushExpiryDurationStr)
  239. }
  240. webPushExpiryWarningDuration, err := util.ParseDuration(webPushExpiryWarningDurationStr)
  241. if err != nil {
  242. return fmt.Errorf("invalid web push expiry warning duration: %s", webPushExpiryWarningDurationStr)
  243. }
  244. // Convert sizes to bytes
  245. messageSizeLimit, err := util.ParseSize(messageSizeLimitStr)
  246. if err != nil {
  247. return fmt.Errorf("invalid message size limit: %s", messageSizeLimitStr)
  248. }
  249. attachmentTotalSizeLimit, err := util.ParseSize(attachmentTotalSizeLimitStr)
  250. if err != nil {
  251. return fmt.Errorf("invalid attachment total size limit: %s", attachmentTotalSizeLimitStr)
  252. }
  253. attachmentFileSizeLimit, err := util.ParseSize(attachmentFileSizeLimitStr)
  254. if err != nil {
  255. return fmt.Errorf("invalid attachment file size limit: %s", attachmentFileSizeLimitStr)
  256. }
  257. visitorAttachmentTotalSizeLimit, err := util.ParseSize(visitorAttachmentTotalSizeLimitStr)
  258. if err != nil {
  259. return fmt.Errorf("invalid visitor attachment total size limit: %s", visitorAttachmentTotalSizeLimitStr)
  260. }
  261. visitorAttachmentDailyBandwidthLimit, err := util.ParseSize(visitorAttachmentDailyBandwidthLimitStr)
  262. if err != nil {
  263. return fmt.Errorf("invalid visitor attachment daily bandwidth limit: %s", visitorAttachmentDailyBandwidthLimitStr)
  264. } else if visitorAttachmentDailyBandwidthLimit > math.MaxInt {
  265. return fmt.Errorf("config option visitor-attachment-daily-bandwidth-limit must be lower than %d", math.MaxInt)
  266. }
  267. // Check values
  268. if firebaseKeyFile != "" && !util.FileExists(firebaseKeyFile) {
  269. return errors.New("if set, FCM key file must exist")
  270. } else if firebaseKeyFile != "" && !server.FirebaseAvailable {
  271. return errors.New("cannot set firebase-key-file, support for Firebase is not available (nofirebase)")
  272. } else if webPushPublicKey != "" && (webPushPrivateKey == "" || webPushFile == "" || webPushEmailAddress == "" || baseURL == "") {
  273. 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")
  274. } else if keepaliveInterval < 5*time.Second {
  275. return errors.New("keepalive interval cannot be lower than five seconds")
  276. } else if managerInterval < 5*time.Second {
  277. return errors.New("manager interval cannot be lower than five seconds")
  278. } else if cacheDuration > 0 && cacheDuration < managerInterval {
  279. return errors.New("cache duration cannot be lower than manager interval")
  280. } else if keyFile != "" && !util.FileExists(keyFile) {
  281. return errors.New("if set, key file must exist")
  282. } else if certFile != "" && !util.FileExists(certFile) {
  283. return errors.New("if set, certificate file must exist")
  284. } else if listenHTTPS != "" && (keyFile == "" || certFile == "") {
  285. return errors.New("if listen-https is set, both key-file and cert-file must be set")
  286. } else if smtpSenderAddr != "" && (baseURL == "" || smtpSenderFrom == "") {
  287. return errors.New("if smtp-sender-addr is set, base-url, and smtp-sender-from must also be set")
  288. } else if smtpServerListen != "" && smtpServerDomain == "" {
  289. return errors.New("if smtp-server-listen is set, smtp-server-domain must also be set")
  290. } else if attachmentCacheDir != "" && baseURL == "" {
  291. return errors.New("if attachment-cache-dir is set, base-url must also be set")
  292. } else if baseURL != "" {
  293. u, err := url.Parse(baseURL)
  294. if err != nil {
  295. return fmt.Errorf("if set, base-url must be a valid URL, e.g. https://ntfy.mydomain.com: %v", err)
  296. } else if u.Scheme != "http" && u.Scheme != "https" {
  297. return errors.New("if set, base-url must be a valid URL starting with http:// or https://, e.g. https://ntfy.mydomain.com")
  298. } else if u.Path != "" {
  299. return fmt.Errorf("if set, base-url must not have a path (%s), as hosting ntfy on a sub-path is not supported, e.g. https://ntfy.mydomain.com", u.Path)
  300. }
  301. } else if upstreamBaseURL != "" && !strings.HasPrefix(upstreamBaseURL, "http://") && !strings.HasPrefix(upstreamBaseURL, "https://") {
  302. return errors.New("if set, upstream-base-url must start with http:// or https://")
  303. } else if upstreamBaseURL != "" && strings.HasSuffix(upstreamBaseURL, "/") {
  304. return errors.New("if set, upstream-base-url must not end with a slash (/)")
  305. } else if upstreamBaseURL != "" && baseURL == "" {
  306. return errors.New("if upstream-base-url is set, base-url must also be set")
  307. } else if upstreamBaseURL != "" && baseURL != "" && baseURL == upstreamBaseURL {
  308. 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")
  309. } else if authFile == "" && (enableSignup || enableLogin || enableReservations || stripeSecretKey != "") {
  310. return errors.New("cannot set enable-signup, enable-login, enable-reserve-topics, or stripe-secret-key if auth-file is not set")
  311. } else if enableSignup && !enableLogin {
  312. return errors.New("cannot set enable-signup without also setting enable-login")
  313. } else if !payments.Available && (stripeSecretKey != "" || stripeWebhookKey != "") {
  314. return errors.New("cannot set stripe-secret-key or stripe-webhook-key, support for payments is not available in this build (nopayments)")
  315. } else if stripeSecretKey != "" && (stripeWebhookKey == "" || baseURL == "") {
  316. return errors.New("if stripe-secret-key is set, stripe-webhook-key and base-url must also be set")
  317. } else if twilioAccount != "" && (twilioAuthToken == "" || twilioPhoneNumber == "" || twilioVerifyService == "" || baseURL == "" || authFile == "") {
  318. 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")
  319. } else if messageSizeLimit > server.DefaultMessageSizeLimit {
  320. log.Warn("message-size-limit is greater than 4K, this is not recommended and largely untested, and may lead to issues with some clients")
  321. if messageSizeLimit > 5*1024*1024 {
  322. return errors.New("message-size-limit cannot be higher than 5M")
  323. }
  324. } else if !server.WebPushAvailable && (webPushPrivateKey != "" || webPushPublicKey != "" || webPushFile != "") {
  325. return errors.New("cannot enable WebPush, support is not available in this build (nowebpush)")
  326. } else if webPushExpiryWarningDuration > 0 && webPushExpiryWarningDuration > webPushExpiryDuration {
  327. return errors.New("web push expiry warning duration cannot be higher than web push expiry duration")
  328. } else if behindProxy && proxyForwardedHeader == "" {
  329. return errors.New("if behind-proxy is set, proxy-forwarded-header must also be set")
  330. } else if visitorPrefixBitsIPv4 < 1 || visitorPrefixBitsIPv4 > 32 {
  331. return errors.New("visitor-prefix-bits-ipv4 must be between 1 and 32")
  332. } else if visitorPrefixBitsIPv6 < 1 || visitorPrefixBitsIPv6 > 128 {
  333. return errors.New("visitor-prefix-bits-ipv6 must be between 1 and 128")
  334. }
  335. // Backwards compatibility
  336. if webRoot == "app" {
  337. webRoot = "/"
  338. } else if webRoot == "home" {
  339. webRoot = "/app"
  340. } else if webRoot == "disable" {
  341. webRoot = ""
  342. } else if !strings.HasPrefix(webRoot, "/") {
  343. webRoot = "/" + webRoot
  344. }
  345. // Convert default auth permission, read provisioned users
  346. authDefault, err := user.ParsePermission(authDefaultAccess)
  347. if err != nil {
  348. return errors.New("if set, auth-default-access must start set to 'read-write', 'read-only', 'write-only' or 'deny-all'")
  349. }
  350. authUsers, err := parseUsers(authUsersRaw)
  351. if err != nil {
  352. return err
  353. }
  354. authAccess, err := parseAccess(authUsers, authAccessRaw)
  355. if err != nil {
  356. return err
  357. }
  358. authTokens, err := parseTokens(authUsers, authTokensRaw)
  359. if err != nil {
  360. return err
  361. }
  362. // Special case: Unset default
  363. if listenHTTP == "-" {
  364. listenHTTP = ""
  365. }
  366. // Resolve hosts
  367. visitorRequestLimitExemptPrefixes := make([]netip.Prefix, 0)
  368. for _, host := range visitorRequestLimitExemptHosts {
  369. prefixes, err := parseIPHostPrefix(host)
  370. if err != nil {
  371. log.Warn("cannot resolve host %s: %s, ignoring visitor request exemption", host, err.Error())
  372. continue
  373. }
  374. visitorRequestLimitExemptPrefixes = append(visitorRequestLimitExemptPrefixes, prefixes...)
  375. }
  376. // Parse trusted prefixes
  377. trustedProxyPrefixes := make([]netip.Prefix, 0)
  378. for _, host := range proxyTrustedHosts {
  379. prefixes, err := parseIPHostPrefix(host)
  380. if err != nil {
  381. return fmt.Errorf("cannot resolve trusted proxy host %s: %s", host, err.Error())
  382. }
  383. trustedProxyPrefixes = append(trustedProxyPrefixes, prefixes...)
  384. }
  385. // Stripe things
  386. if stripeSecretKey != "" {
  387. payments.Setup(stripeSecretKey)
  388. }
  389. // Add default forbidden topics
  390. disallowedTopics = append(disallowedTopics, server.DefaultDisallowedTopics...)
  391. // Run server
  392. conf := server.NewConfig()
  393. conf.File = config
  394. conf.BaseURL = baseURL
  395. conf.ListenHTTP = listenHTTP
  396. conf.ListenHTTPS = listenHTTPS
  397. conf.ListenUnix = listenUnix
  398. conf.ListenUnixMode = fs.FileMode(listenUnixMode)
  399. conf.KeyFile = keyFile
  400. conf.CertFile = certFile
  401. conf.FirebaseKeyFile = firebaseKeyFile
  402. conf.CacheFile = cacheFile
  403. conf.CacheDuration = cacheDuration
  404. conf.CacheStartupQueries = cacheStartupQueries
  405. conf.CacheBatchSize = cacheBatchSize
  406. conf.CacheBatchTimeout = cacheBatchTimeout
  407. conf.AuthFile = authFile
  408. conf.AuthStartupQueries = authStartupQueries
  409. conf.AuthDefault = authDefault
  410. conf.AuthUsers = authUsers
  411. conf.AuthAccess = authAccess
  412. conf.AuthTokens = authTokens
  413. conf.AttachmentCacheDir = attachmentCacheDir
  414. conf.AttachmentTotalSizeLimit = attachmentTotalSizeLimit
  415. conf.AttachmentFileSizeLimit = attachmentFileSizeLimit
  416. conf.AttachmentExpiryDuration = attachmentExpiryDuration
  417. conf.TemplateDir = templateDir
  418. conf.KeepaliveInterval = keepaliveInterval
  419. conf.ManagerInterval = managerInterval
  420. conf.DisallowedTopics = disallowedTopics
  421. conf.WebRoot = webRoot
  422. conf.UpstreamBaseURL = upstreamBaseURL
  423. conf.UpstreamAccessToken = upstreamAccessToken
  424. conf.SMTPSenderAddr = smtpSenderAddr
  425. conf.SMTPSenderUser = smtpSenderUser
  426. conf.SMTPSenderPass = smtpSenderPass
  427. conf.SMTPSenderFrom = smtpSenderFrom
  428. conf.SMTPServerListen = smtpServerListen
  429. conf.SMTPServerDomain = smtpServerDomain
  430. conf.SMTPServerAddrPrefix = smtpServerAddrPrefix
  431. conf.TwilioAccount = twilioAccount
  432. conf.TwilioAuthToken = twilioAuthToken
  433. conf.TwilioPhoneNumber = twilioPhoneNumber
  434. conf.TwilioVerifyService = twilioVerifyService
  435. conf.MessageSizeLimit = int(messageSizeLimit)
  436. conf.MessageDelayMax = messageDelayLimit
  437. conf.TotalTopicLimit = totalTopicLimit
  438. conf.VisitorSubscriptionLimit = visitorSubscriptionLimit
  439. conf.VisitorSubscriberRateLimiting = visitorSubscriberRateLimiting
  440. conf.VisitorAttachmentTotalSizeLimit = visitorAttachmentTotalSizeLimit
  441. conf.VisitorAttachmentDailyBandwidthLimit = visitorAttachmentDailyBandwidthLimit
  442. conf.VisitorRequestLimitBurst = visitorRequestLimitBurst
  443. conf.VisitorRequestLimitReplenish = visitorRequestLimitReplenish
  444. conf.VisitorRequestExemptPrefixes = visitorRequestLimitExemptPrefixes
  445. conf.VisitorMessageDailyLimit = visitorMessageDailyLimit
  446. conf.VisitorEmailLimitBurst = visitorEmailLimitBurst
  447. conf.VisitorEmailLimitReplenish = visitorEmailLimitReplenish
  448. conf.VisitorPrefixBitsIPv4 = visitorPrefixBitsIPv4
  449. conf.VisitorPrefixBitsIPv6 = visitorPrefixBitsIPv6
  450. conf.BehindProxy = behindProxy
  451. conf.ProxyForwardedHeader = proxyForwardedHeader
  452. conf.ProxyTrustedPrefixes = trustedProxyPrefixes
  453. conf.StripeSecretKey = stripeSecretKey
  454. conf.StripeWebhookKey = stripeWebhookKey
  455. conf.BillingContact = billingContact
  456. conf.EnableSignup = enableSignup
  457. conf.EnableLogin = enableLogin
  458. conf.EnableReservations = enableReservations
  459. conf.EnableMetrics = enableMetrics
  460. conf.MetricsListenHTTP = metricsListenHTTP
  461. conf.ProfileListenHTTP = profileListenHTTP
  462. conf.WebPushPrivateKey = webPushPrivateKey
  463. conf.WebPushPublicKey = webPushPublicKey
  464. conf.WebPushFile = webPushFile
  465. conf.WebPushEmailAddress = webPushEmailAddress
  466. conf.WebPushStartupQueries = webPushStartupQueries
  467. conf.WebPushExpiryDuration = webPushExpiryDuration
  468. conf.WebPushExpiryWarningDuration = webPushExpiryWarningDuration
  469. conf.Version = c.App.Version
  470. // Set up hot-reloading of config
  471. go sigHandlerConfigReload(config)
  472. // Run server
  473. s, err := server.New(conf)
  474. if err != nil {
  475. log.Fatal("%s", err.Error())
  476. } else if err := s.Run(); err != nil {
  477. log.Fatal("%s", err.Error())
  478. }
  479. log.Info("Exiting.")
  480. return nil
  481. }
  482. func sigHandlerConfigReload(config string) {
  483. sigs := make(chan os.Signal, 1)
  484. signal.Notify(sigs, syscall.SIGHUP)
  485. for range sigs {
  486. log.Info("Partially hot reloading configuration ...")
  487. inputSource, err := newYamlSourceFromFile(config, flagsServe)
  488. if err != nil {
  489. log.Warn("Hot reload failed: %s", err.Error())
  490. continue
  491. }
  492. if err := reloadLogLevel(inputSource); err != nil {
  493. log.Warn("Reloading log level failed: %s", err.Error())
  494. }
  495. }
  496. }
  497. func parseIPHostPrefix(host string) (prefixes []netip.Prefix, err error) {
  498. // Try parsing as prefix, e.g. 10.0.1.0/24 or 2001:db8::/32
  499. prefix, err := netip.ParsePrefix(host)
  500. if err == nil {
  501. prefixes = append(prefixes, prefix.Masked())
  502. return prefixes, nil
  503. }
  504. // Not a prefix, parse as host or IP (LookupHost passes through an IP as is)
  505. ips, err := net.LookupHost(host)
  506. if err != nil {
  507. return nil, err
  508. }
  509. for _, ipStr := range ips {
  510. ip, err := netip.ParseAddr(ipStr)
  511. if err == nil {
  512. prefix, err := ip.Prefix(ip.BitLen())
  513. if err != nil {
  514. return nil, fmt.Errorf("%s successfully parsed but unable to make prefix: %s", ip.String(), err.Error())
  515. }
  516. prefixes = append(prefixes, prefix.Masked())
  517. }
  518. }
  519. return
  520. }
  521. func parseUsers(usersRaw []string) ([]*user.User, error) {
  522. users := make([]*user.User, 0)
  523. for _, userLine := range usersRaw {
  524. parts := strings.Split(userLine, ":")
  525. if len(parts) != 3 {
  526. return nil, fmt.Errorf("invalid auth-users: %s, expected format: 'name:hash:role'", userLine)
  527. }
  528. username := strings.TrimSpace(parts[0])
  529. passwordHash := strings.TrimSpace(parts[1])
  530. role := user.Role(strings.TrimSpace(parts[2]))
  531. if !user.AllowedUsername(username) {
  532. return nil, fmt.Errorf("invalid auth-users: %s, username invalid", userLine)
  533. } else if err := user.ValidPasswordHash(passwordHash, user.DefaultUserPasswordBcryptCost); err != nil {
  534. return nil, fmt.Errorf("invalid auth-users: %s, password hash invalid, %s", userLine, err.Error())
  535. } else if !user.AllowedRole(role) {
  536. return nil, fmt.Errorf("invalid auth-users: %s, role %s is not allowed, allowed roles are 'admin' or 'user'", userLine, role)
  537. }
  538. users = append(users, &user.User{
  539. Name: username,
  540. Hash: passwordHash,
  541. Role: role,
  542. Provisioned: true,
  543. })
  544. }
  545. return users, nil
  546. }
  547. func parseAccess(users []*user.User, accessRaw []string) (map[string][]*user.Grant, error) {
  548. access := make(map[string][]*user.Grant)
  549. for _, accessLine := range accessRaw {
  550. parts := strings.Split(accessLine, ":")
  551. if len(parts) != 3 {
  552. return nil, fmt.Errorf("invalid auth-access: %s, expected format: 'user:topic:permission'", accessLine)
  553. }
  554. username := strings.TrimSpace(parts[0])
  555. if username == userEveryone {
  556. username = user.Everyone
  557. }
  558. u, exists := util.Find(users, func(u *user.User) bool {
  559. return u.Name == username
  560. })
  561. if username != user.Everyone {
  562. if !exists {
  563. return nil, fmt.Errorf("invalid auth-access: %s, user %s is not provisioned", accessLine, username)
  564. } else if !user.AllowedUsername(username) {
  565. return nil, fmt.Errorf("invalid auth-access: %s, username %s invalid", accessLine, username)
  566. } else if u.Role != user.RoleUser {
  567. return nil, fmt.Errorf("invalid auth-access: %s, user %s is not a regular user, only regular users can have ACL entries", accessLine, username)
  568. }
  569. }
  570. topic := strings.TrimSpace(parts[1])
  571. if !user.AllowedTopicPattern(topic) {
  572. return nil, fmt.Errorf("invalid auth-access: %s, topic pattern %s invalid", accessLine, topic)
  573. }
  574. permission, err := user.ParsePermission(strings.TrimSpace(parts[2]))
  575. if err != nil {
  576. return nil, fmt.Errorf("invalid auth-access: %s, permission %s invalid, %s", accessLine, parts[2], err.Error())
  577. }
  578. if _, exists := access[username]; !exists {
  579. access[username] = make([]*user.Grant, 0)
  580. }
  581. access[username] = append(access[username], &user.Grant{
  582. TopicPattern: topic,
  583. Permission: permission,
  584. Provisioned: true,
  585. })
  586. }
  587. return access, nil
  588. }
  589. func parseTokens(users []*user.User, tokensRaw []string) (map[string][]*user.Token, error) {
  590. tokens := make(map[string][]*user.Token)
  591. for _, tokenLine := range tokensRaw {
  592. parts := strings.Split(tokenLine, ":")
  593. if len(parts) < 2 || len(parts) > 3 {
  594. return nil, fmt.Errorf("invalid auth-tokens: %s, expected format: 'user:token[:label]'", tokenLine)
  595. }
  596. username := strings.TrimSpace(parts[0])
  597. _, exists := util.Find(users, func(u *user.User) bool {
  598. return u.Name == username
  599. })
  600. if !exists {
  601. return nil, fmt.Errorf("invalid auth-tokens: %s, user %s is not provisioned", tokenLine, username)
  602. } else if !user.AllowedUsername(username) {
  603. return nil, fmt.Errorf("invalid auth-tokens: %s, username %s invalid", tokenLine, username)
  604. }
  605. token := strings.TrimSpace(parts[1])
  606. if !user.ValidToken(token) {
  607. return nil, fmt.Errorf("invalid auth-tokens: %s, token %s invalid, use 'ntfy token generate' to generate a random token", tokenLine, token)
  608. }
  609. var label string
  610. if len(parts) > 2 {
  611. label = parts[2]
  612. }
  613. if _, exists := tokens[username]; !exists {
  614. tokens[username] = make([]*user.Token, 0)
  615. }
  616. tokens[username] = append(tokens[username], &user.Token{
  617. Value: token,
  618. Label: label,
  619. Provisioned: true,
  620. })
  621. }
  622. return tokens, nil
  623. }
  624. func reloadLogLevel(inputSource altsrc.InputSourceContext) error {
  625. newLevelStr, err := inputSource.String("log-level")
  626. if err != nil {
  627. return fmt.Errorf("cannot load log level: %s", err.Error())
  628. }
  629. overrides, err := inputSource.StringSlice("log-level-overrides")
  630. if err != nil {
  631. return fmt.Errorf("cannot load log level overrides (1): %s", err.Error())
  632. }
  633. log.ResetLevelOverrides()
  634. if err := applyLogLevelOverrides(overrides); err != nil {
  635. return fmt.Errorf("cannot load log level overrides (2): %s", err.Error())
  636. }
  637. log.SetLevel(log.ToLevel(newLevelStr))
  638. if len(overrides) > 0 {
  639. log.Info("Log level is %v, %d override(s) in place", strings.ToUpper(newLevelStr), len(overrides))
  640. } else {
  641. log.Info("Log level is %v", strings.ToUpper(newLevelStr))
  642. }
  643. return nil
  644. }