Skip to content

Commit

Permalink
[readme] Describe the parameters added in v1.4.6
Browse files Browse the repository at this point in the history
  • Loading branch information
cornugi committed Nov 24, 2020
1 parent b76c2f2 commit f3c3520
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ ONDUTY_ALERT_LIMIT=2
# When to consider an existing alert as new (in seconds)
# when the time is below this value the count of an alert goes up
ONDUTY_ALERT_THRESHOLD=7200

# Optionally set some constraints to the phone numbers of the Onduty Contacts,
# with comma separated (wihout spaces) code countries and phone types
# (see https://github.com/daddyz/phonelib#getting-started for more details)
# ONDUTY_PHONE_COUNTRIES=ch
# ONDUTY_PHONE_TYPES=fixed_line,mobile
```

### Build & Run with Docker
Expand Down Expand Up @@ -163,11 +169,14 @@ ONDUTY_SLACK_CHANNEL=#onduty-test
ONDUTY_ZENDESK_URL=https://<your-workspace>.zendesk.com/api/v2
[email protected]
ONDUTY_ZENDESK_TOKEN=<zendesk-token>
ONDUTY_ZENDESK_GROUP_ID=<zendesk-group-id>
# ONDUTY_ZENDESK_GROUP_ID=<zendesk-group-id>
# ONDUTY_ZENDESK_SKIPPED_GROUPS=RedTeam,BlueTeam
```

When `ONDUTY_ZENDESK_GROUP_ID` is not defined, the assignee's default group id will be used.

When `ONDUTY_ZENDESK_SKIPPED_GROUPS` is defined (with _existing_ group names as comma-separated list), no Zendesk tickets will be created for alerts of these groups.

# Trigger alerts from external sources

The following example shows how to create an alert using cURL and JSON payload:
Expand Down

0 comments on commit f3c3520

Please sign in to comment.