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

chore: Update Readme

Browse Source
This commit is contained in:
CyferShepard
2024-06-04 19:30:23 +02:00
parent d5c6f1b927
commit 4a563e76be
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

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