flan/winnow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update .env.example and README to reflect VERBOSE and current defaults

Browse Source 
- .env.example: add VERBOSE, remove active AUTO_MODE=true (now TTY-detected),
  comment out FORCE_CPU/ENABLE_CACHE default values, update CRON_SCHEDULE
  section to document all three modes
- README: clarify that log file is always DEBUG regardless of VERBOSE

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
flan
2026-06-12 15:50:51 +00:00
co-authored by Claude Sonnet 4.6
parent 882af37d8e
commit 4f6967258f
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+13 -5
View File
@@ -4,7 +4,10 @@ API_KEY=your-immich-api-key
FRIGATE_URL=http://192.168.1.10:5000
# ── Mode & Strategy ───────────────────────────────────────────────────────────
AUTO_MODE=true
# Auto mode is active by default when no TTY is present (Docker/cron).
# Set AUTO_MODE=true to force auto mode even in an interactive terminal.
# AUTO_MODE=true
# VERBOSE=true # Enable DEBUG-level console output (log file is always DEBUG)
# TRAINING_MODE: face = upload to Frigate face recognition API
# object = save crops to output dir for manual Frigate placement
TRAINING_MODE=face
@@ -29,8 +32,8 @@ STRATEGY=auto
# MAX_AUTO_IMAGES=80 # Hard cap on auto-diversity selection (default: 80)
# ── Caching & Models ──────────────────────────────────────────────────────────
FORCE_CPU=false
ENABLE_CACHE=true
# FORCE_CPU=true # Disable GPU, fall back to CPU
# ENABLE_CACHE=false # Disable embedding cache (default: true)
CACHE_DIR=/app/.if_cache
HF_HOME=/models/huggingface
INSIGHTFACE_HOME=/models/.insightface
@@ -41,5 +44,10 @@ INSIGHTFACE_HOME=/models/.insightface
# RESET_PERSON=John # Clear uploaded+rejected history for one person
# ── Scheduling ────────────────────────────────────────────────────────────────
# Cron expression (unset = run once and exit)
CRON_SCHEDULE=0 3 * * 0 # Every Sunday at 3 AM
# CRON_SCHEDULE controls container lifetime:
# unset — run once on startup, then exit
# empty string — stay alive, run nothing (trigger manually: docker exec -it winnow winnow)
# cron expression — run on startup, then on schedule
# CRON_SCHEDULE= # Manual mode (keep alive, no auto-run)
# CRON_SCHEDULE=0 3 * * 0 # Every Sunday at 3 AM
# CRON_SCHEDULE=0 3 1 * * # First of every month
README.md
+1 -1
View File
@@ -169,7 +169,7 @@ The first run after a fresh install downloads the embedding models (~1-2 GB). Su
| Variable | Default | Description |
| :--- | :--- | :--- |
| `AUTO_MODE` | *(auto)* | Force non-interactive mode even in a terminal; auto-detected otherwise (no TTY = auto) |
| `VERBOSE` | `false` | Set to `true` to enable DEBUG-level console output |
| `VERBOSE` | `false` | Set to `true` to enable DEBUG-level console output (the log file is always DEBUG) |
| `TRAINING_MODE` | `face` | `face` — upload crops to Frigate API; `object` — save crops to disk |
| `STRATEGY` | `auto` | `auto` (adaptive), `standard` (30 images), `broad` (100 images) |
| `LIMIT` | *(unset)* | Exact image count — overrides `STRATEGY` |