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

Add test UI toggle and docs

Browse Source
This commit is contained in:
Luna
2026-04-11 17:27:46 +02:00
parent 09119e8c0e
commit 38ef36aa75
5 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.env.example
View File

@@ -1,4 +1,5 @@
ENV=prod ENV=prod
FACE_LOCK_TEST_UI=true
# Optional auth # Optional auth
# FACE_LOCK_AUTH_TOKEN=change-me # FACE_LOCK_AUTH_TOKEN=change-me
# FACE_LOCK_AUTH_HEADER=X-API-Key # FACE_LOCK_AUTH_HEADER=X-API-Key

4
README.md
View File

@@ -4,7 +4,7 @@ FastAPI microservice that finds the primary subject in an image, draws a square
## UI ## UI
The Tailwind UI is always available at `/`. The Tailwind test UI is available at `/` unless disabled with `FACE_LOCK_TEST_UI=false`.
## Auth ## Auth
@@ -40,6 +40,8 @@ pip install -r requirements.txt
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000 uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
``` ```
Set `FACE_LOCK_TEST_UI=false` to disable the UI.
## Docker ## Docker
```bash ```bash

8
app/config.py
View File

@@ -6,9 +6,17 @@ from dotenv import load_dotenv
load_dotenv() load_dotenv()
def _env_bool(name: str, default: bool = False) -> bool:
value = os.getenv(name)
if value is None:
return default
return value.strip().lower() in {"1", "true", "yes", "on"}
@dataclass(frozen=True) @dataclass(frozen=True)
class Settings: class Settings:
env: str = os.getenv("ENV", "prod").strip().lower() env: str = os.getenv("ENV", "prod").strip().lower()
test_ui_enabled: bool = _env_bool("FACE_LOCK_TEST_UI", True)
auth_token: str = os.getenv("FACE_LOCK_AUTH_TOKEN", "").strip() auth_token: str = os.getenv("FACE_LOCK_AUTH_TOKEN", "").strip()
auth_header_name: str = os.getenv("FACE_LOCK_AUTH_HEADER", "X-API-Key").strip() auth_header_name: str = os.getenv("FACE_LOCK_AUTH_HEADER", "X-API-Key").strip()

5
app/main.py
View File

@@ -24,6 +24,7 @@ def health():
return { return {
"ok": True, "ok": True,
"env": settings.env, "env": settings.env,
"test_ui_enabled": settings.test_ui_enabled,
"auth_enabled": settings.auth_enabled, "auth_enabled": settings.auth_enabled,
"auth_header": settings.auth_header_name if settings.auth_enabled else None, "auth_header": settings.auth_header_name if settings.auth_enabled else None,
} }
@@ -31,6 +32,10 @@ def health():
@app.get("/", response_class=HTMLResponse) @app.get("/", response_class=HTMLResponse)
def index(): def index():
if not settings.test_ui_enabled:
return HTMLResponse(
"<!doctype html><html><body style='font-family:sans-serif;background:#0f172a;color:#e2e8f0;padding:2rem'><h1>face-lock</h1><p>Test UI is disabled.</p><p><a href='/docs' style='color:#67e8f9'>Open API docs</a></p></body></html>"
)
return HTMLResponse( return HTMLResponse(
""" """
<!doctype html> <!doctype html>

4
docs/README.md
View File

@@ -19,6 +19,10 @@ face-lock is a FastAPI service that detects a primary subject, makes a square cr
- `person` for full-body person detection - `person` for full-body person detection
- `subject` for general foreground subjects - `subject` for general foreground subjects
## Test UI
Set `FACE_LOCK_TEST_UI=false` to disable the `/` test UI.
## Authentication ## Authentication
Set `FACE_LOCK_AUTH_TOKEN` to require a header token. Set `FACE_LOCK_AUTH_TOKEN` to require a header token.