From 4a563e76be796d53d4b0c66fd1a2733173a1ffc1 Mon Sep 17 00:00:00 2001 From: CyferShepard Date: Tue, 4 Jun 2024 19:30:23 +0200 Subject: [PATCH] chore: Update Readme --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a7d2a0e..f6670e6 100644 --- a/README.md +++ b/README.md @@ -24,28 +24,28 @@ ## Environmental Variables -| 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 maxmind to use their services | +| Env | Default | Example | Description | +| ------------------------------- | -------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| 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_IP `REQUIRED` | `null` | `jellystat-db` or `192.168.0.5` | Hostname/IP of postgres instance | +| POSTGRES_PORT `REQUIRED` | `null` | `5432` | Port Postgres is running on | +| JWT_SECRET `REQUIRED` | `null` | `my-secret-jwt-key` | JWT Key to be used to encrypt JWT tokens for authentication | +| 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_DB | `jfstat` | `jfstat` | Name of postgres database | +| REJECT_SELF_SIGNED_CERTIFICATES | `true` | `false` | Allow or deny self signed SSL certificates | +| 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 maxmind to use their services | ## Getting Started with Development - Clone the project from git -- set your env variables before strating the server (Variable names as per the docker compose file). +- set your env variables before strating the server (Variable names as per Environmental Variables above). - Run `npm install` to install necessary packages - Run `npm run start-server` to only run the backend nodejs server -- Run `npm run start` to only run the frontend React UI +- Run `npm run start-client` to only run the frontend React UI - Run `npm run start-app` to run both backend and frontend at the same time When contributing please ensure to log a pull request on the `unstable` branch