From c99b6d6a46c28ac62a9a421f5b33c021b24d5d79 Mon Sep 17 00:00:00 2001 From: Corban-Lee Jones Date: Tue, 13 May 2025 18:48:27 +0100 Subject: [PATCH] docs: add readme listing environment variables --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..11ad962 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Relay + +## Installation + +### Environment Variables + +|Variable|Description|Required|Default Value| +|-|-|:-:|-| +|`HOST`|The application host.|✔|| +|`PORT`|The application port.|✔|| +|`PUBLIC_URL`|The public endpoint of the web ui.|✔|| +|`BOT_TOKEN`|Authentication for the Discord Bot.|✔|| +|`DATABASE_URL`|Postgresql connection string.|✔|| +|`OAUTH_URL`|Discord authentication URL.|✔|| +|`CALLBACK_URL`|Discord authentication callback URL.|✔|| +|`CLIENT_ID`|Discord application client ID.|✔|| +|`CLIENT_SECRET`|Discord application client secret.|✔|| +|`DISCORD_USER_IDS`|CSV of Discord User IDs allowed to access the web ui.|✔||