space/face-lock
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs and re-enable test UI

Browse Source
This commit is contained in:
Luna
2026-04-11 17:30:22 +02:00
parent 38ef36aa75
commit 39cd2db140
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@@ -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.