Skip to content

Settings Overview

It's important to understand how settings can be applied on three different levels (this applies to both normal settings and notifications settings).

The three levels are:

  • Global (settings / notifications)
  • Per container (containers)
  • Per trigger (keywords / regex / container_event)
Here is an example of how settings can be applied on different levels
yaml
containers:
  container1:
    notification_cooldown: 15
    title_template: "{container}: {keywords}"
    keywords:
      - keyword: "error"
        notification_cooldown: 0
        title_template: "Error in {container}"

settings:
  notification_cooldown: 5
  title_template: "{keywords} found in {container}"

INFO

When the same setting is defined in multiple places like in the example above, the following priority applies:

trigger > container > global

Note that lists like excluded_keywords are merged, not overwritten.


The following tables show which settings are available and where they can be configured:
This is what the columns stand for:

  • G = Global (settings or in case of notification settings: notifications)
  • C = Per Container (containers)
  • T = Per Trigger (keywords / regex / container_event)

Global Only Settings

The following settings can only be configured globally under the settings section.

SettingGCTDescription
log_levelLogging level: DEBUG, INFO, WARNING, ERROR
multi_line_entriesEnable detection of multi-line log entries
reload_configAutomatically reload config on changes
disable_start_messageDisable startup notification
disable_shutdown_messageDisable shutdown notification
disable_config_reload_messageDisable notification when config is reloaded
disable_monitor_event_messageDisable notification when container monitoring starts/stops
compact_summary_messageFormats the summary message in startup and config reload notifications with a comma-separated list of containers instead of a multi-line list
monitor_all_containersMonitor all containers on the host
monitor_all_swarm_servicesMonitor all swarm services on the host
excluded_containersList of containers that should not be monitored. To be used with monitor_all_containers
excluded_swarm_servicesList of swarm services that should not be monitored. To be used with monitor_all_swarm_services

Modular Settings

Most of these settings can be configured on all three levels.

SettingGCTDescription
hostsName of the host a container should be monitored on if monitoring multiple hosts
actionTrigger container actions (restart/stop)
disable_notificationsDisable notifications when keywords are found. Useful when you only want to trigger actions.
excluded_keywordsLog lines with these keywords will always be ignored
hide_regex_in_titleDon't show full regex pattern in found keywords in notification titles for cleaner look. Useful when using very long regexes.
regex_case_sensitiveCase sensitive regex matching
notification_cooldownSeconds between repeated alerts per container and keyword
attachment_linesNumber of log lines to include in attachments
attach_logfileAttach log output to the notification (true/false)
action_cooldownCooldown for triggering container actions per container and action (default: 300s, min: 10s)
title_templateTemplate for the notification title. See Customize Notifications
message_templateTemplate for notification messages
olivetin_urlURL of your OliveTin instance. See Actions Guide
olivetin_usernameUsername for OliveTin authentication. See Actions Guide
olivetin_passwordPassword for OliveTin authentication. See Actions Guide
olivetin_actionsList of OliveTin actions to trigger. See Actions Guide
olivetin_action_idOliveTin action ID to trigger. See Actions Guide

Notifications Settings

Just like other settings you can set notification settings globally, per container or per trigger.

Globally (G) you configure these settings under the respective notification service section under notifications and without the prefix (ntfy_, apprise_, webhook_) (see Notifications Section).

SettingGCTDescription
apprise_urlApprise-compatible URL for notifications
ntfy_urlntfy server URL
ntfy_topicntfy topic
ntfy_priorityntfy priority (1–5)
ntfy_tagsTags/emojis for ntfy notifications
ntfy_tokenntfy token for authentication
ntfy_usernamentfy username for authentication
ntfy_passwordntfy password for authentication
ntfy_iconntfy icon for notifications
ntfy_clickntfy click action for notifications
ntfy_markdownntfy markdown formatting for notifications
ntfy_actionsntfy actions for notifications
ntfy_headersntfy headers for notifications
webhook_urlCustom webhook URL for notifications
webhook_headersCustom headers for webhook notifications

✅ = supported
– = not supported