@@ -8,40 +8,40 @@ This deployment expects a number of secrets and environment variables to exist i
88### Core
99These environment variables are required to start the bot
1010
11- | Environment | Description | Required/Default |
12- | ------------------------------------- | ------------------------------------------------------------ | ------------------------- |
13- | KING_ARTHUR_TOKEN | The bot token to authorize with Discord | Required |
14- | KING_ARTHUR_PREFIXES | The list of prefixes to listen to commands | ` ("arthur ", "M-x ") ` |
15- | KING_ARTHUR_DEVOPS_ROLE | The Discord role that is allowed to run King Arthur commands | 409416496733880320 |
16- | KING_ARTHUR_GUILD_ID | The guild the bot should interact with | 267624335836053506 |
17- | KING_ARTHUR_DEVOPS_CHANNEL_ID | The devops Discord channel | 675756741417369640 |
18- | KING_ARTHUR_SENTRY_DSN | Where to send sentry alerts | "" |
11+ | Environment | Description | Required/Default |
12+ | -------------------------------------------------- | ------------------------------------------------------------ | ------------------------- |
13+ | KING_ARTHUR_THE_TERRIBLE_TOKEN | The bot token to authorize with Discord | Required |
14+ | KING_ARTHUR_THE_TERRIBLE_PREFIXES | The list of prefixes to listen to commands | ` ("arthur ", "M-x ") ` |
15+ | KING_ARTHUR_THE_TERRIBLE_DEVOPS_ROLE | The Discord role that is allowed to run King Arthur commands | 409416496733880320 |
16+ | KING_ARTHUR_THE_TERRIBLE_GUILD_ID | The guild the bot should interact with | 267624335836053506 |
17+ | KING_ARTHUR_THE_TERRIBLE_DEVOPS_CHANNEL_ID | The devops Discord channel | 675756741417369640 |
18+ | KING_ARTHUR_THE_TERRIBLE_SENTRY_DSN | Where to send sentry alerts | "" |
1919
2020### API integrations
2121These environment variables are required to work on the relevant cog.
2222
23- | Environment | Relevant cog | Description | Required/Default |
24- | ------------------------------------- | --------------------- | ------------------------------------------------------------------------- | ------------------------- |
25- | KING_ARTHUR_CLOUDFLARE_TOKEN | Zones | A token for the Cloudflare API used for the Cloudflare commands in Arthur | Required |
26- | KING_ARTHUR_GITHUB_ORG | GrafanaGitHubTeamSync | The github organisation to fetch teams from | python-discord |
27- | KING_ARTHUR_GITHUB_TOKEN | GrafanaGitHubTeamSync | The github token used to fetch teams to populate grafana | Required |
28- | KING_ARTHUR_GRAFANA_URL | GrafanaGitHubTeamSync | The URL to the grafana instance to manage teams | https://grafana.pydis.wtf |
29- | KING_ARTHUR_GRAFANA_TOKEN | GrafanaGitHubTeamSync | The grafana token used to sync teams with github | Required |
30- | KING_ARTHUR_YOUTUBE_API_KEY | Motivation | The YouTube API key to fetch missions with | Required |
23+ | Environment | Relevant cog | Description | Required/Default |
24+ | -------------------------------------------------- | --------------------- | ------------------------------------------------------------------------- | ------------------------- |
25+ | KING_ARTHUR_THE_TERRIBLE_CLOUDFLARE_TOKEN | Zones | A token for the Cloudflare API used for the Cloudflare commands in Arthur | Required |
26+ | KING_ARTHUR_THE_TERRIBLE_GITHUB_ORG | GrafanaGitHubTeamSync | The github organisation to fetch teams from | python-discord |
27+ | KING_ARTHUR_THE_TERRIBLE_GITHUB_TOKEN | GrafanaGitHubTeamSync | The github token used to fetch teams to populate grafana | Required |
28+ | KING_ARTHUR_THE_TERRIBLE_GRAFANA_URL | GrafanaGitHubTeamSync | The URL to the grafana instance to manage teams | https://grafana.pydis.wtf |
29+ | KING_ARTHUR_THE_TERRIBLE_GRAFANA_TOKEN | GrafanaGitHubTeamSync | The grafana token used to sync teams with github | Required |
30+ | KING_ARTHUR_THE_TERRIBLE_YOUTUBE_API_KEY | Motivation | The YouTube API key to fetch missions with | Required |
3131
3232### LDAP & Directory integrations
3333The environment variables are required to work with the LDAP/FreeIPA system.
3434
35- | Environment | Description | Required/Default |
36- | ------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
37- | KING_ARTHUR_ENABLE_LDAP | Whether the LDAP cog should be started | False |
38- | KING_ARTHUR_LDAP_BOOTSTRAP_CHANNEL_ID | Channel to send the LDAP account reset message | 1266358923875586160 |
39- | KING_ARTHUR_LDAP_HOST | The FQDN of the host running LDAP | Required |
40- | KING_ARTHUR_LDAP_BIND_USER | The LDAP user to use when making requests | uid=kingarthur,cn=users,cn=accounts,dc=box,dc=pydis,dc=wtf |
41- | KING_ARTHUR_LDAP_BIND_PASSWORD | The password for the above user | Required |
42- | KING_ARTHUR_LDAP_BASE_DN | The base distinguished name to use for requests to LDAP | dc=box,dc=pydis,dc=wtf |
43- | KING_ARTHUR_LDAP_CERTIFICATE_LOCATION | The location of the self signed cert to send with requests | Required |
44- | KING_ARTHUR_KEYCLOAK_ADDRESS | The URL to the keycloak address to make requests to | Required |
45- | KING_ARTHUR_KEYCLOAK_USERNAME | The username of the keycloak user to make requests with | kingarthur |
46- | KING_ARTHUR_KEYCLOAK_PASSWORD | The password of the keycloak user to make requests with | Required |
47- | KING_ARTHUR_KEYCLOAK_USER_REALM | The keycloak realm to make requests to | pydis |
35+ | Environment | Description | Required/Default |
36+ | -------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
37+ | KING_ARTHUR_THE_TERRIBLE_ENABLE_LDAP | Whether the LDAP cog should be started | False |
38+ | KING_ARTHUR_THE_TERRIBLE_LDAP_BOOTSTRAP_CHANNEL_ID | Channel to send the LDAP account reset message | 1266358923875586160 |
39+ | KING_ARTHUR_THE_TERRIBLE_LDAP_HOST | The FQDN of the host running LDAP | Required |
40+ | KING_ARTHUR_THE_TERRIBLE_LDAP_BIND_USER | The LDAP user to use when making requests | uid=kingarthur,cn=users,cn=accounts,dc=box,dc=pydis,dc=wtf |
41+ | KING_ARTHUR_THE_TERRIBLE_LDAP_BIND_PASSWORD | The password for the above user | Required |
42+ | KING_ARTHUR_THE_TERRIBLE_LDAP_BASE_DN | The base distinguished name to use for requests to LDAP | dc=box,dc=pydis,dc=wtf |
43+ | KING_ARTHUR_THE_TERRIBLE_LDAP_CERTIFICATE_LOCATION | The location of the self signed cert to send with requests | Required |
44+ | KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_ADDRESS | The URL to the keycloak address to make requests to | Required |
45+ | KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_USERNAME | The username of the keycloak user to make requests with | kingarthur |
46+ | KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_PASSWORD | The password of the keycloak user to make requests with | Required |
47+ | KING_ARTHUR_THE_TERRIBLE_KEYCLOAK_USER_REALM | The keycloak realm to make requests to | pydis |
0 commit comments