diff --git a/operator.md b/operator.md index 3cccfd7f..be7ab389 100644 --- a/operator.md +++ b/operator.md @@ -51,3 +51,16 @@ needed. Allstar does not currently listen to webhooks, so no incoming network configuration needed. Only outgoing calls to GitHub are made. Allstar is currently stateless. It is best to only run one instance to avoid potential race conditions on enforcement actions, ex: pinging an issue twice at the same time. + +## Configuration via Environment Variables + +Allstar supports various operator configuration options which can be set via environment variables: +|Name|Description|Default| +|----|----|----| +|APP_ID|The application ID of the created GitHub App.|| +|PRIVATE_KEY|The raw value of the private key for the GitHub App. KEY_SECRET must be set to "direct".|| +|KEY_SECRET|The name of a secret containing a private key.|| +|DO_NOTHING_ON_OPT_OUT|Boolean flag which defines if allstar should do nothing and skip the corresponding checks when a repository is opted out.|false| +|ALLSTAR_LOG_LEVEL|The minimum logging level that allstar should use when emitting logs. Acceptable values are: panic ; fatal ; error ; warn ; info ; debug ; trace|info| +|NOTICE_PING_DURATION_HOURS|The duration (in hours) to wait between pinging notice actions, such as updating a GitHub issue.|24| +