corbz/relay
1
0
Fork 0
Code Issues 2 Pull Requests Actions Releases Activity

docs: add readme listing environment variables

Browse Source
This commit is contained in:
Corban-Lee Jones 2025-05-13 18:48:27 +01:00
parent 389ea6cf34
commit c99b6d6a46
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -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.|✔||