|
24 | 24 |
|
25 | 25 | ## Environmental Variables |
26 | 26 |
|
27 | | -| Env | Default | Example | Description | |
28 | | -|-------------------------------------|----------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| |
29 | | -| POSTGRES_USER `REQUIRED` | `null` | `postgres` | Username that will be used in postgres database | |
30 | | -| POSTGRES_PASSWORD `REQUIRED` | `null` | `postgres` | Password that will be used in postgres database | |
31 | | -| POSTGRES_IP `REQUIRED` | `null` | `jellystat-db` or `192.168.0.5` | Hostname/IP of postgres instance | |
32 | | -| POSTGRES_PORT `REQUIRED` | `null` | `5432` | Port Postgres is running on | |
33 | | -| POSTGRES_SSL_ENABLED | `null` | `true` | Enable SSL connections to Postgres |
34 | | -| POSTGRES_SSL_REJECT_UNAUTHORIZED | `null` | `false` | Verify Postgres SSL certificates when POSTGRES_SSL_ENABLED=true |
35 | | -| JS_LISTEN_IP | `0.0.0.0`| `0.0.0.0` or `::` | Enable listening on specific IP or `::` for IPv6 | |
36 | | -| JWT_SECRET `REQUIRED` | `null` | `my-secret-jwt-key` | JWT Key to be used to encrypt JWT tokens for authentication | |
37 | | -| TZ `REQUIRED` | `null` | `Etc/UTC` | Server timezone (Can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) | |
38 | | -| JS_BASE_URL | `/` | `/` | Base url | |
39 | | -| 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) | |
40 | | -| 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) | |
41 | | -| POSTGRES_DB | `jfstat` | `jfstat` | Name of postgres database | |
42 | | -| REJECT_SELF_SIGNED_CERTIFICATES | `true` | `false` | Allow or deny self signed SSL certificates | |
43 | | -| 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) | |
44 | | -| JS_GEOLITE_LICENSE_KEY | `null` | `ASDWdaSdawe2sd186` | License key you need to generate on maxmind to use their services | |
45 | | -| MINIMUM_SECONDS_TO_INCLUDE_PLAYBACK | `1` | `10` | The minimum time (in seconds) to include a playback record, which can be used to exclude short playbacks | |
46 | | -| IS_EMBY_API | `false` | `true` | Set to true if using Emby instead of Jellyfin | |
| 27 | +| Env | Default | Example | Description | |
| 28 | +| ----------------------------------- | --------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 29 | +| POSTGRES_USER `REQUIRED` | `null` | `postgres` | Username that will be used in postgres database | |
| 30 | +| POSTGRES_PASSWORD `REQUIRED` | `null` | `postgres` | Password that will be used in postgres database | |
| 31 | +| POSTGRES_IP `REQUIRED` | `null` | `jellystat-db` or `192.168.0.5` | Hostname/IP of postgres instance | |
| 32 | +| POSTGRES_PORT `REQUIRED` | `null` | `5432` | Port Postgres is running on | |
| 33 | +| POSTGRES_SSL_ENABLED | `null` | `true` | Enable SSL connections to Postgres | |
| 34 | +| POSTGRES_SSL_REJECT_UNAUTHORIZED | `null` | `false` | Verify Postgres SSL certificates when POSTGRES_SSL_ENABLED=true | |
| 35 | +| JS_LISTEN_IP | `0.0.0.0` | `0.0.0.0` or `::` | Enable listening on specific IP or `::` for IPv6 | |
| 36 | +| JWT_SECRET `REQUIRED` | `null` | `my-secret-jwt-key` | JWT Key to be used to encrypt JWT tokens for authentication | |
| 37 | +| TZ `REQUIRED` | `null` | `Etc/UTC` | Server timezone (Can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) | |
| 38 | +| JS_BASE_URL | `/` | `/` | Base url | |
| 39 | +| 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) | |
| 40 | +| 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) | |
| 41 | +| POSTGRES_DB | `jfstat` | `jfstat` | Name of postgres database | |
| 42 | +| REJECT_SELF_SIGNED_CERTIFICATES | `true` | `false` | Allow or deny self signed SSL certificates | |
| 43 | +| 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) | |
| 44 | +| JS_GEOLITE_LICENSE_KEY | `null` | `ASDWdaSdawe2sd186` | License key you need to generate on maxmind to use their services | |
| 45 | +| MINIMUM_SECONDS_TO_INCLUDE_PLAYBACK | `1` | `10` | The minimum time (in seconds) to include a playback record, which can be used to exclude short playbacks | |
| 46 | +| IS_EMBY_API | `false` | `true` | Set to true if using Emby instead of Jellyfin | |
| 47 | +| JF_USE_WEBSOCKETS | `true` | `false` | Enables using Jellyfins websocket connection for session data (No effect on Emby) | |
| 48 | +| JS_USE_EXTERNAL_HOST | `false` | `true` | Prioritises using External host value for some internal communications and processes | |
| 49 | +| NEW_WATCH_EVENT_THRESHOLD_HOURS | 1 | 1-12 | This value sets the max time between watch sessions to determine if a watch is a new session or should be added onto the last session thats happened within this threshold. EG last watch within the last 1 hour. After 1 hour, a new session for the same item will be considered a new watch event. | |
47 | 50 |
|
48 | 51 | ## Getting Started with Development |
49 | 52 |
|
@@ -91,4 +94,4 @@ Will set the environment variable `MYVAR` based on the contents of the `/run/sec |
91 | 94 |
|
92 | 95 | ## API Documentation |
93 | 96 |
|
94 | | -To-do |
| 97 | +Swagger Documentation can be found at `/swagger` endpoint |
0 commit comments