corbz/PYRSS-Website
corbz/PYRSS-Website
1
0
Fork 0
Code Issues 21 Pull Requests Actions Releases 1 Wiki Activity

Update Environment Variables

Corban-Lee Jones 2024-08-27 18:02:56 +00:00
parent 8a2bfcdda9
commit e94826848c
1 changed files with 29 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Environment-Variables.md

@ -1,22 +1,29 @@
This wiki covers the environment variables used in this application, their purposes and what values you should use.
### Access
#### `BOT_TOKEN`
**Required / No Default**
### Security
#### `DEBUG`
**Optional / Default `False`**
This flag is intended to be enabled for development purposes, and should always be disabled in a production environment.
Unless you intend to make use of debugging for development purposes, you should leave this alone.
Example value: `True` or `False`
#### `SECRET_KEY`
**Optional / Default `unsecure-default-secret-key`**
#### `SUPERUSER_IDS`
**Optional / No Default**
A comma separated list of Discord User IDs. Authenticated users with a matching Discord ID will be automatically made into superusers.
Superusers can access the Django administrator panel, so be careful!
Example value: `000000000000000001` or `000000000000000001,000000000000000002` (no spaces) for multiple users.
### Discord App
#### `DISCORD_KEY`
@ -27,6 +34,10 @@ This wiki covers the environment variables used in this application, their purpo
**Required / No Default**
#### `DISCORD_SCOPES`
**Required / Default `identity,guilds`**
#### `DISCORD_OAUTH2_URL`
**Required / No Default**
@ -41,6 +52,15 @@ This wiki covers the environment variables used in this application, their purpo
#### `DISCORD_API_URL`
**Required / Default `https://discord.com/api/v10`**
The API endpoint for Discord.
This value shouldn't be changed unless you know what you are doing, as different API versions could handle/respond to requests differently.
Example value: `https://discord.com/api/v9`
#### `BOT_TOKEN`
**Required / No Default**
### Database
@ -51,6 +71,8 @@ This wiki covers the environment variables used in this application, their purpo
If `None`, the other database environment variables will be ignored, and an sqlite database will be used in the project root, named `db.sqlite3`.
Example value: ``
#### `DB_NAME`
**Optional / No Default**
@ -70,7 +92,3 @@ If `None`, the other database environment variables will be ignored, and an sqli
#### `DB_PORT`
**Optional / No Default**
### Extras
#### `SUPERUSER_IDS`