Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs(env): document DB_PORT, SERVER_PORT, BASE_URL, COOKIE_SECURE, IMAGE_TAG in .env.example

Browse Source 
Expose the recently-added env-driven compose settings as commented examples so self-hosters and deployers can discover them. All remain optional with defaults.
This commit is contained in:
john-okeefe
2026-07-29 16:12:21 -04:00
parent de8f71b2be
commit bac84e24ec
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+15
View File
@@ -10,6 +10,21 @@ JWT_SECRET=your-secure-jwt-secret-key-here
# Generate with: openssl rand -hex 16 # Generate with: openssl rand -hex 16
DBPASS=your-secure-database-password-here DBPASS=your-secure-database-password-here
# Networking: change a port if it conflicts on your host
# Postgres port, host + container (e.g. another local DB already uses 5432)
# DB_PORT=15432
# App web port, host + container
# SERVER_PORT=8765
# Deployment
# External URL for device sync (must include protocol; defaults to http://localhost:8765)
# Examples: https://bookhoard.example.com | http://192.168.1.10:8765
# BASE_URL=https://bookhoard.example.com
# Mark session cookies Secure — set true behind a TLS-terminating reverse proxy (Caddy/nginx/traefik)
# COOKIE_SECURE=true
# Pin or rollback a specific published image version (defaults to "latest")
# IMAGE_TAG=1.0.0
# Optional: Override Defaults (defaults are set in docker-compose.yml) # Optional: Override Defaults (defaults are set in docker-compose.yml)
# Test Mode: WARNING - Only set to true for integration testing # Test Mode: WARNING - Only set to true for integration testing
# TEST_MODE=true # TEST_MODE=true