aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/default/modmail/README.md
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2023-08-13 20:01:42 +0100
committerGravatar Chris Lovering <[email protected]>2023-08-14 11:44:03 +0100
commit661f49409e69f5cfafbef4cd41411a72ebc5418d (patch)
tree9ddd7f2a2ab09cadc5b716be00628e19d839ad4d /kubernetes/namespaces/default/modmail/README.md
parentAllow multiple documents within yaml files (diff)
Copy all files from kubernetes repo into this one
This commit is a like-for-like copy of the [kubernetes repo](https://github.com/python-discord/kubernetes) check that repo for comit history prioir to this commit. Co-authored-by: Amrou Bellalouna <[email protected]> Co-authored-by: Bradley Reynolds <[email protected]> Co-authored-by: Chris <[email protected]> Co-authored-by: Chris Lovering <[email protected]> Co-authored-by: ChrisJL <[email protected]> Co-authored-by: Den4200 <[email protected]> Co-authored-by: GDWR <[email protected]> Co-authored-by: Hassan Abouelela <[email protected]> Co-authored-by: Hassan Abouelela <[email protected]> Co-authored-by: jchristgit <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Johannes Christ <[email protected]> Co-authored-by: Kieran Siek <[email protected]> Co-authored-by: kosayoda <[email protected]> Co-authored-by: ks129 <[email protected]> Co-authored-by: Leon Sand├©y <[email protected]> Co-authored-by: Leon Sand├©y <[email protected]> Co-authored-by: MarkKoz <[email protected]> Co-authored-by: Matteo Bertucci <[email protected]> Co-authored-by: Sebastiaan Zeeff <[email protected]> Co-authored-by: Sebastiaan Zeeff <[email protected]> Co-authored-by: vcokltfre <[email protected]>
Diffstat (limited to 'kubernetes/namespaces/default/modmail/README.md')
-rw-r--r--kubernetes/namespaces/default/modmail/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/kubernetes/namespaces/default/modmail/README.md b/kubernetes/namespaces/default/modmail/README.md
new file mode 100644
index 0000000..92ac16b
--- /dev/null
+++ b/kubernetes/namespaces/default/modmail/README.md
@@ -0,0 +1,19 @@
+# Modmail
+
+This folder contains the manifests for our Modmail service.
+
+## Secrets
+
+The services require one shared secret called `modmail` containing the following:
+
+| Key | Value | Description |
+| ------------------------| ---------------------------------|--------------------------------------------------------------|
+| `CONNECTION_URI` | MongoDB connection URI | Used for storing data |
+| `DATABASE_TYPE` | `mongodb` | The type of database to use, only supports mongodb right now |
+| `DATA_COLLECTION` | `False` | Disable bot metadata collection by modmail devs |
+| `DISABLE_AUTOUPDATES` | `yes` | Auto-updates breaks in production |
+| `GUILD_ID` | Snowflake of Discord guild | Guild to respond to commands in |
+| `LOG_URL` | URL of the web portal | Used for generating links on the bot |
+| `OWNERS` | Comma separated list of user IDs | Used for granting high permissions on the bot |
+| `REGISTRY_PLUGINS_ONLY` | `false` | Allows the usage of plugins outside of the official registry |
+| `TOKEN` | Discord Token | Used to connect to Discord |