From 39cd2db140117d88da0e12759fb4ffd1de88ddcf Mon Sep 17 00:00:00 2001 From: Luna Date: Sat, 11 Apr 2026 17:30:22 +0200 Subject: [PATCH] Improve docs and re-enable test UI --- README.md | 2 ++ docs/README.md | 8 ++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 54832c7..a881830 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,5 @@ Set `FACE_LOCK_TEST_UI=false` to disable the UI. ```bash docker compose up --build ``` + +If you change env vars in `.env`, recreate the container, `docker compose up -d --force-recreate`, because restart alone will not reload `--env-file`. diff --git a/docs/README.md b/docs/README.md index 7733139..01279cb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ ## Overview -face-lock is a FastAPI service that detects a primary subject, makes a square crop, and returns both a crop and an annotated preview. +face-lock is a FastAPI service that detects a primary subject, makes a square crop, and returns both a crop and an annotated preview. The app ships with a simple Tailwind test UI at `/`. ## Endpoints @@ -21,7 +21,7 @@ face-lock is a FastAPI service that detects a primary subject, makes a square cr ## Test UI -Set `FACE_LOCK_TEST_UI=false` to disable the `/` test UI. +Set `FACE_LOCK_TEST_UI=false` to disable the `/` test UI. If you update `.env`, recreate the container so Docker picks up the new values. ## Authentication @@ -44,3 +44,7 @@ curl -H 'X-API-Key: your-token' \ -F 'detector=animal' \ http://localhost:8000/api/focus ``` + +## Docker note + +Use `docker compose up -d --force-recreate` after env changes.