From bac84e24eca432eb0e07f9aa9f982c1f57e03c78 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Wed, 29 Jul 2026 16:12:21 -0400 Subject: [PATCH] docs(env): document DB_PORT, SERVER_PORT, BASE_URL, COOKIE_SECURE, IMAGE_TAG in .env.example Expose the recently-added env-driven compose settings as commented examples so self-hosters and deployers can discover them. All remain optional with defaults. --- .env.example | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.env.example b/.env.example index cdb581b..d4721b2 100644 --- a/.env.example +++ b/.env.example @@ -10,6 +10,21 @@ JWT_SECRET=your-secure-jwt-secret-key-here # Generate with: openssl rand -hex 16 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) # Test Mode: WARNING - Only set to true for integration testing # TEST_MODE=true