From 5fc96186a363bfdb8f036f75d542ee42b3c32f7e Mon Sep 17 00:00:00 2001
From: Xoconoch <github@cordovault.com>
Date: Sat, 23 Aug 2025 08:47:59 -0600
Subject: [PATCH] chore(docs): add environment variables docs

---
 docs/user/configuration.md   |  2 ++
 docs/user/environment.md     | 38 ++++++++++++++++++++++++++++++++++++
 docs/user/getting-started.md |  2 ++
 mkdocs.yml                   |  1 +
 4 files changed, 43 insertions(+)
 create mode 100644 docs/user/environment.md

diff --git a/docs/user/configuration.md b/docs/user/configuration.md
index d1871f1..7b5b9ba 100644
--- a/docs/user/configuration.md
+++ b/docs/user/configuration.md
@@ -1,5 +1,7 @@
 ## Configuration
 
+See also: [Environment variables](environment.md)
+
 Open Configuration in the web UI. Tabs:
 
 - General (admin)
diff --git a/docs/user/environment.md b/docs/user/environment.md
new file mode 100644
index 0000000..8e01b82
--- /dev/null
+++ b/docs/user/environment.md
@@ -0,0 +1,38 @@
+## Environment variables
+
+Location: project `.env`. Minimal reference for server admins.
+
+### Core
+- HOST: Interface to bind (default `0.0.0.0`)
+- EXPLICIT_FILTER: Filter explicit content (`true|false`, default `false`)
+
+### Redis
+- REDIS_HOST: Hostname (default `redis`)
+- REDIS_PORT: Port (default `6379`)
+- REDIS_DB: Database index (default `0`)
+- REDIS_PASSWORD: Password
+
+### File ownership & permissions
+- PUID: Container user ID owning downloads (default `1000`)
+- PGID: Container group ID owning downloads (default `1000`)
+- UMASK: Default permissions for new files (default `0022`)
+- SKIP_SET_PERMISSIONS: Skip permission fix on startup (`true|false`, default `false`)
+
+### Multi-user & auth
+- ENABLE_AUTH: Enable authentication (`true|false`, default `false`)
+- JWT_SECRET: Long random string for tokens (required if auth enabled)
+- JWT_EXPIRATION_HOURS: Session duration in hours (default `720`)
+- DEFAULT_ADMIN_USERNAME: Seed admin username (default `admin`)
+- DEFAULT_ADMIN_PASSWORD: Seed admin password (change it!)
+- DISABLE_REGISTRATION: Disable public signups (`true|false`, default `false`)
+
+### SSO
+- SSO_ENABLED: Enable SSO (`true|false`)
+- SSO_BASE_REDIRECT_URI: Base backend callback (e.g. `http://127.0.0.1:7171/api/auth/sso/callback`)
+- FRONTEND_URL: Public UI base (e.g. `http://127.0.0.1:7171`)
+- GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET
+- GITHUB_CLIENT_ID / GITHUB_CLIENT_SECRET
+
+Tips:
+- If running behind a reverse proxy, set `FRONTEND_URL` and `SSO_BASE_REDIRECT_URI` to public URLs.
+- Change `DEFAULT_ADMIN_*` on first login or disable registration and create users from the admin panel.
\ No newline at end of file
diff --git a/docs/user/getting-started.md b/docs/user/getting-started.md
index b6181df..effc0ee 100644
--- a/docs/user/getting-started.md
+++ b/docs/user/getting-started.md
@@ -76,11 +76,13 @@ _Note: You will have to enable the virtual environment everytime you want to reg
 - Credentials are posted to Spotizerr automatically
 
 **Next steps:**
+
 - Add Deezer ARL in Configuration → Accounts (optional, allows for FLAC availability if premium)
 - Adjust Download and Formatting options
 - Enable Watch system if you want automatic downloads
 
 **Troubleshooting (quick):**
+
 - Downloads not starting: verify service credentials and API keys
 - Watch not working: enable in Configuration → Watch and set intervals
 - Auth issues: ensure JWT secret and SSO creds (if used); try clearing browser cache
diff --git a/mkdocs.yml b/mkdocs.yml
index ff99451..55d5bf8 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -13,6 +13,7 @@ theme:
 nav:
   - Getting started: user/getting-started
   - Configuration: user/configuration
+  - Environment: user/environment
   - Tracks: user/tracks
   - Albums: user/albums
   - Playlists: user/playlists