config.yml 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. # ntfy config file
  2. # Listen address for the HTTP web server
  3. # Format: <hostname>:<port>
  4. #
  5. # listen-http: ":80"
  6. # Listen address for the HTTPS web server. If set, you must also set "key-file" and "cert-file".
  7. # Format: <hostname>:<port>
  8. #
  9. # listen-https:
  10. # Path to the private key file for the HTTPS web server. Not used if "listen-https" is not set.
  11. # Format: <filename>
  12. #
  13. # key-file:
  14. # Path to the cert file for the HTTPS web server. Not used if "listen-https" is not set.
  15. # Format: <filename>
  16. #
  17. # cert-file:
  18. # If set, also publish messages to a Firebase Cloud Messaging (FCM) topic for your app.
  19. # This is optional and only required to save battery when using the Android app.
  20. #
  21. # firebase-key-file: <filename>
  22. # If set, messages are cached in a local SQLite database instead of only in-memory. This
  23. # allows for service restarts without losing messages in support of the since= parameter.
  24. #
  25. # cache-file: <filename>
  26. # Duration for which messages will be buffered before they are deleted.
  27. # This is required to support the "since=..." and "poll=1" parameter.
  28. #
  29. # cache-duration: 12h
  30. # Interval in which keepalive messages are sent to the client. This is to prevent
  31. # intermediaries closing the connection for inactivity.
  32. #
  33. # Note that the Android app has a hardcoded timeout at 77s, so it should be less than that.
  34. #
  35. # keepalive-interval: 30s
  36. # Interval in which the manager prunes old messages, deletes topics
  37. # and prints the stats.
  38. #
  39. # manager-interval: 1m
  40. # Rate limiting: Total number of topics before the server rejects new topics.
  41. #
  42. # global-topic-limit: 5000
  43. # Rate limiting: Number of subscriptions per visitor (IP address)
  44. #
  45. # visitor-subscription-limit: 30
  46. # Rate limiting: Allowed GET/PUT/POST requests per second, per visitor:
  47. # - visitor-request-limit-burst is the initial bucket of requests each visitor has
  48. # - visitor-request-limit-replenish is the rate at which the bucket is refilled
  49. #
  50. # visitor-request-limit-burst: 60
  51. # visitor-request-limit-replenish: 10s
  52. # If set, the X-Forwarded-For header is used to determine the visitor IP address
  53. # instead of the remote address of the connection.
  54. #
  55. # WARNING: If you are behind a proxy, you must set this, otherwise all visitors are rate limited
  56. # as if they are one.
  57. #
  58. # behind-proxy: false