Defaults

Defaults to give each service/notify/slack/webhook.

You can define defaults for service, notify, slack and webhook in the config.yml. These defaults can also be set with environment variables in the format of ARGUS_<YAML_PATH_UNDER_DEFAULTS>. For example, ARGUS_SERVICE_OPTIONS_INTERVAL=10m would set the default interval to 10 minutes (defaults.service.options.interval). The YAML config format is as follows:

service portion

defaults:
  ...
  service:
    options:
      interval: 10m              # How often to query for new releases
      semantic_versioning: true  # Whether to enforce semantic versioning (required to only alert on newew versions)
    latest_version:
      access_token: ''            # GitHub access token to increase your rate-limit and/or access private repos
                                  # https://github.com/settings/tokens - w/ repo.public_repo/repo for public/private
      allow_invalid_certs: false  # Whether invalid HTTPS certs are allowed in queries
      use_prerelease: false       # Whether 'prerelease' GitHub tags can be used
    deployed_version:             # Get the `current_version` from a deployed service
      allow_invalid_certs: false  # Accept invalid HTTPS certs/not
    dashboard:
      auto_approve: false  # Whether approval is required on the web UI for sending the new release WebHooks

notify portion

Defaults can be defined for each notify type. Details about the vars for each type can be found here.

defaults:
  ...
  notify:
    bark:
    discord:
    email:
    gotify:
    googlechat:
    ifttt:
    join:
    mattermost:
    matrix:
    ntfy:
    opsgenie:
    pushbullet:
    pushover:
    rocketchat:
    slack:
    teams:
    telegram:
    zulip:
    shoutrrr:

webhook portion

defaults:
  ...
  webhook:
    delay: 0s                   # Delay before sending the webhooks when a new release is found
                                # (only used when auto_approve is true for the service)
    max_tries: 3                # Maximum number of tries at sending each webhook
    allow_invalid_certs: false  # Whether invalid HTTPS certs are allowed in this webhook
    desired_status_code: 201    # Status code to use indicating a success. Using 0 will accept any 2XX status code
    silent_fails: false         # Whether to notify the service's notifiers if max_tries fails occur

Last modified June 1, 2023: shoutrrr 0.7 (d4caf0e)