config.sample.yml

# Credentials for SES for sending notification emails
ses:
  access_key_id: ~
  secret_access_key: ~

net:
  open_timeout: 60
  read_timeout: 60

# Define endpoints to monitor in here.
monitors:
    # Name each of your monitors something descriptive so you know what they do.
  - name: Communities

    # This is the URL that the monitor should visit to determine if your
    # endpoint is up or down.
    test_url: https://meta.codidact.com/

    # How many seconds apart should each test be?
    frequency: 300

    # When a test fails, testing frequency will be changed to this value, so
    # that you can increase (for quicker change detection) or decrease (for 
    # relieving pressure on your host) frequency.
    failed_retest: 30

    # This many tests must fail before a DOWN notification is sent.
    failure_count: 4

    # This many tests must succeed when the endpoint is DOWN before an UP
    # notification is sent.
    success_count: 2

    # Defines endpoints to which to send notifications when the status of components changes.
    notifications:
      # Email notifications, for example to StatusPage, just need an email address to send to.
      - type: email
        from: status@codidact.org
        address: example@statuspage
        subject: '$Status'
        body: '$Component is $Status'

      # You can also set up notifications in Discord channels like this:
      - type: discord

        # This is the webhook URL copied when you create your webhook in Discord.
        url: https://discord.com/api/webhooks/123/token

        # This will override the default username of your webhook bot.
        username: Captain Hook

        # List users or roles the message should mention. Use just the user ID for users, prefix with & for roles.
        mentions:
          - 1234
          - '&1234'

        content: '$Mentions ping! $Component is $Status!'