serve.go 43 KB

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