BreizhHardware/Jellystat
1
0
Fork 0
mirror of https://github.com/BreizhHardware/Jellystat.git synced 2026-01-18 16:27:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README with required environment variables

Browse Source
This commit is contained in:
CyferShepard
2024-05-10 21:23:24 +02:00
parent b52aa34fb3
commit 14e0bbcdd4
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -24,20 +24,20 @@
## Environmental Variables
| Env | Default | Example | Description |
| ------------------------------- | ------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| JS_BASE_URL | / | / | Base url |
| JS_USER | not set | User | Master Override User in case username used during setup is forgotten |
| JS_PASSWORD | not set | Password | Master Override Password in case username used during setup is forgotten |
| POSTGRES_USER | not set | postgres | Username that will be used in postgres database |
| POSTGRES_PASSWORD | not set | postgres | Password that will be used in postgres database |
| POSTGRES_DB | jfstat | jfstat | Name of postgres database |
| POSTGRES_IP | not set | jellystat-db/192.168.0.5 | Hostname/IP of postgres instance |
| POSTGRES_PORT | not set | 5432 | Port Postgres is running on |
| REJECT_SELF_SIGNED_CERTIFICATES | true | false | Allow or deny self signed SSL certificates |
| JWT_SECRET | not set | my-secret-jwt-key | JWT Key to be used to encrypt JWT tokens for authentication |
| JS_GEOLITE_ACCOUNT_ID | not set | 123456 | maxmind.com user id to be used for Geolocating IP Addresses (Can be found at https://www.maxmind.com/en/accounts/current/edit) |
| JS_GEOLITE_LICENSE_KEY | not set | ASDWdaSdawe2sd186 | License key you need to generate on maxmin to use their services |
| Env | Default | Example | Description |
| ------------------------------- | ------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| JS_BASE_URL | / | / | Base url |
| JS_USER | `null` | User | Master Override User in case username or password used during setup is forgotten (Both `JS_USER` and `JS_PASSWORD` required to work) |
| JS_PASSWORD | `null` | Password | Master Override Password in case username or password used during setup is forgotten (Both `JS_USER` and `JS_PASSWORD` required to work) |
| POSTGRES_USER `REQUIRED` | `null` | postgres | Username that will be used in postgres database |
| POSTGRES_PASSWORD `REQUIRED` | `null` | postgres | Password that will be used in postgres database |
| POSTGRES_DB | jfstat | jfstat | Name of postgres database |
| POSTGRES_IP `REQUIRED` | `null` | jellystat-db/192.168.0.5 | Hostname/IP of postgres instance |
| POSTGRES_PORT `REQUIRED` | `null` | 5432 | Port Postgres is running on |
| REJECT_SELF_SIGNED_CERTIFICATES | true | false | Allow or deny self signed SSL certificates |
| JWT_SECRET `REQUIRED` | `null` | my-secret-jwt-key | JWT Key to be used to encrypt JWT tokens for authentication |
| JS_GEOLITE_ACCOUNT_ID | `null` | 123456 | maxmind.com user id to be used for Geolocating IP Addresses (Can be found at https://www.maxmind.com/en/accounts/current/edit) |
| JS_GEOLITE_LICENSE_KEY | `null` | ASDWdaSdawe2sd186 | License key you need to generate on maxmin to use their services |
## Getting Started with Development