From 14e0bbcdd48087e280827e56149224549e5daf77 Mon Sep 17 00:00:00 2001 From: CyferShepard Date: Fri, 10 May 2024 21:23:24 +0200 Subject: [PATCH] docs: update README with required environment variables --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bf9dee3..9fe5427 100644 --- a/README.md +++ b/README.md @@ -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