config.example.yml

# The base Icinga Web 2 URL being used as the base URL for all object, notification and event URLs.
icingaweb2_url: http://localhost/icingaweb2/

# Directory containing all executable Icinga Notifications channel plugins.
# By default, all of Icinga Notifications built-in channel plugins are installed in the directory below.
#channels_dir: /usr/libexec/icinga-notifications/channels

# Icinga Notifications HTTP listener configuration.
listener:
  # The TCP address of the Icinga Notifications HTTP listener to listen on, in the form of "host:port".
  # The host part can be a hostname, an IP address or empty to listen on all interfaces. The port part
  # must be a valid TCP port number. This can be configured in many different ways, as listed below.
  # address: "localhost:5680", ":5680" (any interface) or "[2001:db8::1]:5680" (IPv6 only).
  # Defaults to "localhost:5680".
  #address: "localhost:5680"

  # Path to a Unix domain socket for local sources to submit events.
  # When set, sources connecting via this socket identify themselves by username only; no password is required.
  # This transport is recommended when the source and daemon run on the same host. Leave unset (the default) to disable.
  #socket: "/run/icinga/icinga-notifications.sock"

  # Permission bits for the Unix socket file, given as an octal. Defaults to "0660".
  # To restrict access to a specific OS group, set socket_group and leave this at "0660".
  # Note: each source requires its own OS user, so "0600" (owner-only) would limit the socket to a single source.
  #socket_mode: "0660"

  # OS group to assign to the Unix socket file. When socket_mode grants group access (e.g. "0660"),
  # this controls which group gets that access. Defaults to the primary group of the daemon process.
  #socket_group: "icinga-notifications"

  # Set credentials for all the HTTP debug endpoints. This can be set either directly or read from a file.
  # Setting both options is not allowed and will result in a configuration error. If both options are left
  # unset, the debug endpoints will be disabled and won't be accessible at all.
  #debug_password: "put-something-secret-here"
  #debug_password_file: /run/secrets/icinga_notifications_debug_password

  # Set tls to true to enable only secure connections to the Icinga Notifications HTTP listener.
  # If enabled, the certificate and private key must be set as well. If not set, defaults to false.
  #tls: false

  # Set the path to the server's public TLS certificate or PEM-encoded multiline string.
  # If TLS is enabled, this is required and must be set to a valid certificate.
  #cert: /path/to/server.crt

  # Set the path to the server's private TLS key or PEM-encoded multiline string.
  # If TLS is enabled, this is required and must be set to a valid private key corresponding to the certificate.
  #key: /path/to/server.key

  # Set the path to a CA certificate or PEM-encoded multiline string to enable client certificate authentication.
  #
  # Required if TLS is enabled to be able to verify client certificate if the client provides one.
  #ca: /path/to/ca.crt

# Connection configuration for the database where Icinga Notifications stores configuration and historical data.
# This is also the database used in Icinga Notifications Web to view and work with the data.
database:
  # Database type. Either 'mysql' for MySQL or 'pgsql' for PostgreSQL.
  # Defaults to 'mysql'.
#  type: mysql

  # Database host or absolute Unix socket path.
  host: localhost

  # Database port. By default, the MySQL or PostgreSQL port, depending on the database type.
#  port:

  # Database name.
  database: notifications

  # Database user.
  user: notifications

  # Database password.
  password: CHANGEME
#  password_file: /run/secerets/icinga_notifications_database_password

# The retention policy used by Icinga Notifications to determine how long no longer relevant historical data
# is kept in the database before it is eligible for cleanup. Currently, this retention policy only applies to
# closed incidents and related tables, but in the future it may be extended to other components as well.
retention:
  # Retention period for historical data defined as duration string. This is the duration after which historical data
  # is considered old and eligible for cleanup. By default, Icinga Notifications does not automatically clean up any
  # data, i.e. the retention period is set to 0s. Setting this to a non-zero value enables the retention policy and
  # allows Icinga Notifications to automatically clean up historical data that is older than the specified duration.
  #
  # Valid units are "ms", "s", "m", "h". Defaults to "0s", which means no automatic cleanup.
#  period: 0s

  # Interval for periodic cleanup of historical data defined as duration string. This is the interval at which
  # Icinga Notifications will run the cleanup process to prune old historical data as defined by the retention period.
  # Valid units are "ms", "s", "m", "h". Defaults to "1h".
#  interval: 1h

  # Batch size for deleting historical data. This is the maximum number of records that will be deleted in a single
  # batch during the cleanup process. This is used to avoid long-running transactions and high load on the database
  # when deleting large amounts of historical data. Defaults to 5000.
#  batch_size: 5000

  # Map of component-retention period pairs to define a different retention period than the default value for each
  # component. The retention period for each component defines how long historical data related to that component
  # is kept before it is eligible for cleanup. If a component is not listed here, the default retention period defined
  # above is used.
#  options:
#    incident: 480h

# Icinga Notifications logs its activities at various severity levels and any errors that occur either
# on the console or in systemd's journal. The latter is used automatically when running under systemd.
# In any case, the default log level is 'info'.
# logging:
  # Default logging level. Can be set to 'fatal', 'error', 'warn', 'info' or 'debug'.
  # If not set, defaults to 'info'.
  #level: info

  # Logging output. Can be set to 'console' (stderr) or 'systemd-journald'.
  # If not set, logs to systemd-journald when running under systemd, otherwise stderr.
  #output:

  # Interval for periodic logging defined as duration string.
  # A duration string is a sequence of decimal numbers and a unit suffix, such as "20s".
  # Valid units are "ms", "s", "m", "h".
  # Defaults to "20s".
  #interval: 20s

  # Map of component-logging level pairs to define a different log level than the default value for each component.
#  options:
    #channel:
    #database:
    #incident:
    #event-queue:
    #listener:
    #retention:
    #runtime-updates: