More documentation

[ildyria]

Summary by CodeRabbit

• Documentation
  • Expanded "How-To: Configure Facial Recognition" guide with detailed non-Docker setup instructions and configuration steps.
  • Enhanced troubleshooting section with step-by-step checklist for common issues and remediation guidance.
  • Improved health check examples for both Docker and bare-metal deployments.
  • Clarified async queue processing behavior and queue worker requirements.

[coderabbitai]

📝 Walkthrough

Walkthrough

The facial recognition configuration guide is expanded to add a full non-Docker (bare-metal) setup section covering installation, .env configuration for both the Python service and Lychee, uvicorn startup, and a systemd unit example. Existing sections for health checks, troubleshooting, the env var table, and bulk scan notes are updated to address both Docker and bare-metal deployments.

Changes

Facial Recognition Guide: Bare-Metal & Docker Updates

Layer / File(s)	Summary
ToC, Prerequisites, and new Bare-Metal Setup section docs/specs/2-how-to/configure-facial-recognition.md	Table of contents gains a bare-metal entry; prerequisites expand to include Python 3.13+/uv, repo clone, and queue worker; a new "Non-Docker (Bare-Metal) Setup" section is added with clone/install steps, .env configuration for both services, uvicorn startup command, a systemd unit example, and /health verification with model-download timing note.
Env var table, Admin UI note, Bulk Scan note, and Health Check rewrite docs/specs/2-how-to/configure-facial-recognition.md	VISION_FACE_PHOTOS_PATH row is added/clarified in the env var table; the Admin UI section references both startup modes; the Bulk Scan section gains an async-queue note; the Health Check section is rewritten with distinct curl examples for Docker host, Docker network, and non-Docker, plus systemd process-check guidance.
Troubleshooting rewrite for Docker and bare-metal docs/specs/2-how-to/configure-facial-recognition.md	A brief bullet list is replaced by a numbered checklist covering queue-worker status, QUEUE_CONNECTION env check, /health call, and log locations; "cannot find photos" separates Docker volume-mount from non-Docker filesystem path requirements; "API key mismatch" adds Docker restart and non-Docker config-cache clearing steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop, hop, no Docker today!
A bare-metal path has found its way.
With uv sync and uvicorn too,
Systemd units keep faces in view.
The rabbit checks /health — all green!
Clearest face-scan guide ever seen. ✨

🚥 Pre-merge checks | ✅ 1

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

docs/specs/2-how-to/configure-facial-recognition.md (1)

114-219: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Systemd unit uses 127.0.0.1 binding; consider clarity for production multi-machine deployments.

The manual startup instruction (line 175) binds to 0.0.0.0 (all interfaces), but the systemd unit example (line 192) binds to 127.0.0.1 (localhost only). This inconsistency is not incorrect—given that bare-metal setup assumes a single machine and Lychee's bare-metal config (line 165) points to http://localhost:8000—but it could confuse users scaling to separate machines.

Consider adding a comment in the systemd unit clarifying that 127.0.0.1 is appropriate for localhost-only access, and that 0.0.0.0 should be used if Lychee runs on a different host.

📝 Suggested clarification in the systemd unit

 [Service]
 Type=simple
 User=www-data
 WorkingDirectory=/opt/Lychee-Facial-Recognition
 EnvironmentFile=/opt/Lychee-Facial-Recognition/.env
+# Bind to 127.0.0.1 for localhost-only access; use 0.0.0.0 if Lychee runs on a different host
 ExecStart=/usr/bin/uv run uvicorn app.main:app --host 127.0.0.1 --port 8000
 Restart=on-failure
 RestartSec=5

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 31054a38-a508-494a-90e6-746c2f346f86

📥 Commits

Reviewing files that changed from the base of the PR and between 5922914 and 9c5f904.

📒 Files selected for processing (1)

• docs/specs/2-how-to/configure-facial-recognition.md