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

only show required env vars in docker compose

Browse Source
This commit is contained in:
FuzzyGrim
2023-10-02 20:40:29 +02:00
parent fa27071210
commit 45ef31db97
2 changed files with 14 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -33,13 +33,6 @@ services:
environment:
- TMDB_API=TMDB_API_KEY
- MAL_API=MAL_API_KEY
- PUID=1000
- PGID=1000
- TZ=Europe/Madrid
# - SECRET=secret
# - ALLOWED_HOSTS=*
# - HTTPS_COOKIES=False
# - REGISTRATION=False
volumes:
- ./db:/yamtrack/db
- media:/yamtrack/media
@@ -52,20 +45,20 @@ volumes:
### Environment variables
| Name | Type | Description | Required | Default | Notes |
| -------------- | ----------- | -------------------------- | ------------ | ---------- | ------------------------------------- |
| TMDB_API | String | The Movie Database API key | Yes | None | Required for movies and tv shows |
| MAL_API | String | MyAnimeList API key | Yes | None | Required for anime and manga |
| SECRET | String | Django secret key | Recommended | "secret" | [SECRET_KEY](https://docs.djangoproject.com/en/4.2/ref/settings/#secret-key) |
| ALLOWED_HOSTS | List | Base IP / Domain | No | "*" | [ALLOWED_HOSTS](https://docs.djangoproject.com/en/4.1/ref/settings/#allowed-hosts) |
| PUID | Int | User ID | No | 1000 | |
| PGID | Int | Group ID | No | 1000 | |
| TZ | String | Timezone | No | UTC | |
| HTTPS_COOKIES | Bool | Cookies over HTTPS | No | False | [SESSION_COOKIE_SECURE](https://docs.djangoproject.com/en/4.1/ref/settings/#std-setting-SESSION_COOKIE_SECURE) and [CSRF_COOKIE_SECURE](https://docs.djangoproject.com/en/4.1/ref/settings/#std-setting-CSRF_COOKIE_SECURE)|
| REGISTRATION | Bool | User registration | No | True | |
| ADMIN_ENABLED | Bool | Django admin page | No | False | |
| WEB_CONCURRENCY| Int | Number of worker processes | No | 1 | [Recommend (2 x $num_cores) + 1](https://docs.gunicorn.org/en/latest/design.html#how-many-workers) |
| DEBUG | Bool | Django debug mode | No | False | |
| Name | Type | Description | Required | Default | Notes |
| --------------- | ----------- | -------------------------- | ------------ | ---------- | ------------------------------------- |
| TMDB_API | String | The Movie Database API key | Yes | None | Required for movies and tv shows |
| MAL_API | String | MyAnimeList API key | Yes | None | Required for anime and manga |
| SECRET | String | Django secret key | Recommended | "secret" | [SECRET_KEY](https://docs.djangoproject.com/en/4.2/ref/settings/#secret-key) |
| ALLOWED_HOSTS | List | Base IP / Domain | No | "*" | [ALLOWED_HOSTS](https://docs.djangoproject.com/en/4.1/ref/settings/#allowed-hosts) |
| PUID | Int | User ID | No | 1000 | |
| PGID | Int | Group ID | No | 1000 | |
| TZ | String | Timezone | No | UTC | |
| HTTPS_COOKIES | Bool | Cookies over HTTPS | No | False | [SESSION_COOKIE_SECURE](https://docs.djangoproject.com/en/4.1/ref/settings/#std-setting-SESSION_COOKIE_SECURE) and [CSRF_COOKIE_SECURE](https://docs.djangoproject.com/en/4.1/ref/settings/#std-setting-CSRF_COOKIE_SECURE)|
| REGISTRATION | Bool | User registration | No | True | |
| ADMIN_ENABLED | Bool | Django admin page | No | False | |
| WEB_CONCURRENCY | Int | Number of worker processes | No | 1 | [Recommend (2 x $num_cores) + 1](https://docs.gunicorn.org/en/latest/design.html#how-many-workers) |
| DEBUG | Bool | Django debug mode | No | False | |
### Environment variables for PostgreSQL

1
docker-compose.yml
View File

@@ -7,7 +7,6 @@ services:
environment:
- TMDB_API=TMDB_API_KEY
- MAL_API=MAL_API_KEY
- WEB_CONCURRENCY=2
volumes:
- ./db:/yamtrack/db
ports: