jessikitty/frambe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

v1.5.1 - refresh env template with volume/persistence note

Browse Source
This commit is contained in:
jessikitty
2026-06-15 09:27:22 +10:00
parent e444a457f5
commit 9c0e5dafe8
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+10 -3
View File
@@ -1,4 +1,7 @@
# === Frambe Configuration === # === 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 # REQUIRED
IMMICH_URL=http://your-immich-server:2283 IMMICH_URL=http://your-immich-server:2283
@@ -22,14 +25,18 @@ SHOW_PROGRESS=true
# ALBUM_ID= # ALBUM_ID=
# SHOW_FAVORITES_ONLY=false # 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_USERNAME=admin
ADMIN_PASSWORD= ADMIN_PASSWORD=
# ADMIN_PASSWORD=changeme # ADMIN_PASSWORD=changeme
# API Token for external access (Home Assistant, scripts, etc.) # 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 # 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 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.