document .env.example

This commit is contained in:
Xoconoch
2025-08-07 09:02:10 -06:00
parent 95deeb54b3
commit 656eeaae2d
2 changed files with 667 additions and 12 deletions

View File

@@ -1,31 +1,42 @@
# Docker Compose environment variables# Delete all comments of this when deploying (everything that is )
###
### Main configuration file of the server. If you
### plan to have this only for personal use, you
### can leave the defaults as they are.
###
### If you plan on using for a server,
### see [insert docs url]
###
# Interface to bind to. Unless you know what you're doing, don't change this
HOST=0.0.0.0
# Redis connection (external or internal)
# Redis connection (external or internal).
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_DB=0
REDIS_PASSWORD=CHANGE_ME
# Set to true to filter out explicit content
# Set to true to filter out explicit content.
EXPLICIT_FILTER=false
# User ID for the container
PUID=1000
# Group ID for the container
# User and group ID for the container. Sets the owner of the downloaded files.
PUID=1000
PGID=1000
# Optional: Sets the default file permissions for newly created files within the container.
# Optional: Sets the default file permissions for newly created files within the container.
UMASK=0022
# Enable authentication
ENABLE_AUTH=true
# Basic Authentication settings. CHANGE THE JWT_SECRET
###
### Multi-user settings, disabled by default.
###
# Enable authentication (i.e. multi-user mode).
ENABLE_AUTH=false
# Basic Authentication settings.
JWT_SECRET=long-random-text
# How much a session persists, in hours. 720h = 30 days.
@@ -49,4 +60,4 @@ GOOGLE_CLIENT_SECRET=
# GitHub SSO (get from GitHub Developer Settings)
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_CLIENT_SECRET=