diff --git a/.env.example b/.env.example index 1c8dc0a..b686c9e 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,7 @@ # === Frambe Configuration === +# Copy this file to .env and fill in your real values: +# cp .env.example .env +# .env is gitignored and holds your secrets. docker compose reads it automatically. # REQUIRED IMMICH_URL=http://your-immich-server:2283 @@ -22,14 +25,18 @@ SHOW_PROGRESS=true # ALBUM_ID= # SHOW_FAVORITES_ONLY=false -# Admin Authentication (optional — leave ADMIN_PASSWORD blank to disable) +# Admin Authentication (leave ADMIN_PASSWORD blank to disable) ADMIN_USERNAME=admin ADMIN_PASSWORD= # ADMIN_PASSWORD=changeme # API Token for external access (Home Assistant, scripts, etc.) -# When set, REST endpoints require this token via Bearer auth or x-api-token header +# When set, REST endpoints require this token via Bearer auth or x-api-token header. # FRAMBE_API_TOKEN=your-secret-token-here -# Server (internal port — Docker maps externally via docker-compose) +# Server (internal port — Docker maps externally to 3030 via docker-compose) PORT=3000 + +# NOTE: Global settings (default source, sleep schedule, etc.) are saved to +# /app/data/settings.json inside the container, backed by the named volume +# `frambe_data` in docker-compose.yml — they persist across rebuilds.