Simon/Yamtrack
1
0
Fork 0
mirror of https://github.com/FuzzyGrim/Yamtrack.git synced 2026-03-03 02:37:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to clarify environment variable descriptions and defaults

Browse Source
This commit is contained in:
FuzzyGrim
2025-02-07 00:03:31 +01:00
parent f8c534ff4b
commit bfff6c014a
1 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -54,30 +54,30 @@ Note that the setting must include the correct protocol (`https` or `http`), and
### Environment variables
| Name | Notes |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| TMDB_API | The Movie Database API key for movies and tv shows, a default key is provided |
| TMDB_NSFW | Default to `False`, set to `True` to include adult content in tv and movie searches |
| TMDB_LANG | TMDB metadata language, uses a Language code in ISO 639-1 e.g `en`, for more specific results a country code in ISO 3166-1 can be added e.g `en-US` |
| MAL_API | MyAnimeList API key, for anime and manga, a default key is provided |
| MAL_NSFW | Default to `False`, set to `True` to include adult content in anime and manga searches from MyAnimeList |
| MU_NSFW | Default to `False`, set to `True` to include adult content in manga searches from MangaUpdates |
| IGDB_ID | IGDB API key for games, a default key is provided but it's recommended to get your own as it has a low rate limit |
| IGDB_SECRET | IGDB API secret for games, a default value is provided but it's recommended to get your own as it has a low rate limit |
| IGDB_NSFW | Default to `False`, set to `True` to include adult content in game searches |
| SIMKL_ID | Simkl API key only needed for importing media from Simkl, a default key is provided but you can get one at [Simkl Developer](https://simkl.com/settings/developer/new/custom-search/) if needed |
| SIMKL_SECRET | Simkl API secret for importing media from Simkl, a default secret is provided but you can get one at [Simkl Developer](https://simkl.com/settings/developer/new/custom-search/) if needed |
| REDIS_URL | Default to `redis://localhost:6379`, Redis is needed for processing background tasks, set this to your redis server url |
| SECRET | [Secret key](https://docs.djangoproject.com/en/stable/ref/settings/#secret-key) used for cryptographic signing, should be a random string |
| URLS | Used to set both the `CSRF` and `ALLOWED_HOSTS` settings, comma separated list of URLs, e.g. `https://yamtrack.mydomain.com` or `https://yamtrack.mydomain.com, https://yamtrack.mydomain2.com` |
| ALLOWED_HOSTS | Comma separated list of host/domain names that this Django site can serve, e.g. `yamtrack.mydomain.com`. See [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#allowed-hosts) for more details. |
| CSRF | Comma separated list of trusted origins for `POST` requests, e.g. `https://yamtrack.mydomain.com`. See [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#csrf-trusted-origins) for more details. |
| REGISTRATION | Default to `True`, set to `False` to disable user registration |
| DEBUG | Default to `False`, set to `True` for debugging |
| PUID | User ID for the app, default to `1000` |
| PGID | Group ID for the app, default to `1000` |
| TZ | Timezone, like `Europe/Berlin`. Default to `UTC` |
| WEB_CONCURRENCY | Number of webserver processes, default to `1` but it's recommended to have a value of [(2 x num cores) + 1](https://docs.gunicorn.org/en/latest/design.html#how-many-workers) |
| Name | Notes |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| TMDB_API | The Movie Database API key for movies and tv shows, a default key is provided |
| TMDB_NSFW | Default to `False`, set to `True` to include adult content in tv and movie searches |
| TMDB_LANG | TMDB metadata language, uses a Language code in ISO 639-1 e.g `en`, for more specific results a country code in ISO 3166-1 can be added e.g `en-US` |
| MAL_API | MyAnimeList API key, for anime and manga, a default key is provided |
| MAL_NSFW | Default to `False`, set to `True` to include adult content in anime and manga searches from MyAnimeList |
| MU_NSFW | Default to `False`, set to `True` to include adult content in manga searches from MangaUpdates |
| IGDB_ID | IGDB API key for games, a default key is provided but it's recommended to get your own as it has a low rate limit |
| IGDB_SECRET | IGDB API secret for games, a default value is provided but it's recommended to get your own as it has a low rate limit |
| IGDB_NSFW | Default to `False`, set to `True` to include adult content in game searches |
| SIMKL_ID | Simkl API key only needed for importing media from Simkl, a default key is provided but you can get one at [Simkl Developer](https://simkl.com/settings/developer/new/custom-search/) if needed |
| SIMKL_SECRET | Simkl API secret for importing media from Simkl, a default secret is provided but you can get one at [Simkl Developer](https://simkl.com/settings/developer/new/custom-search/) if needed |
| REDIS_URL | Default to `redis://localhost:6379`, Redis is needed for processing background tasks, set this to your redis server url |
| SECRET | [Secret key](https://docs.djangoproject.com/en/stable/ref/settings/#secret-key) used for cryptographic signing, should be a random string |
| URLS | Shortcut to set both the `CSRF` and `ALLOWED_HOSTS` settings, comma separated list of URLs, e.g. `https://yamtrack.mydomain.com` or `https://yamtrack.mydomain.com, https://yamtrack.mydomain2.com` |
| ALLOWED_HOSTS | Comma separated list of host/domain names that this Django site can serve, e.g. `yamtrack.mydomain.com` or `yamtrack.mydomain.com, 192.168.1.1`. Default to `*` for all hosts |
| CSRF | Comma separated list of trusted origins for `POST` requests when using reverse proxies, e.g. `https://yamtrack.mydomain.com` or `https://yamtrack.mydomain.com, https://yamtrack.mydomain2.com` |
| REGISTRATION | Default to `True`, set to `False` to disable user registration |
| DEBUG | Default to `False`, set to `True` for debugging |
| PUID | User ID for the app, default to `1000` |
| PGID | Group ID for the app, default to `1000` |
| TZ | Timezone, like `Europe/Berlin`. Default to `UTC` |
| WEB_CONCURRENCY | Number of webserver processes, default to `1` but it's recommended to have a value of [(2 x num cores) + 1](https://docs.gunicorn.org/en/latest/design.html#how-many-workers) |
### Environment variables for PostgreSQL