Add explicit detectors and optional auth
This commit is contained in:
34
README.md
34
README.md
@@ -2,7 +2,37 @@
|
||||
|
||||
FastAPI microservice that finds the primary subject in an image, draws a square around it, and returns a buffered crop.
|
||||
|
||||
## Dev
|
||||
## UI
|
||||
|
||||
The Tailwind UI is always available at `/`.
|
||||
|
||||
## Auth
|
||||
|
||||
Optional header auth is enabled when `FACE_LOCK_AUTH_TOKEN` is set.
|
||||
|
||||
- Default header: `X-API-Key`
|
||||
- Alternate: `Authorization: Bearer <token>`
|
||||
- Override the header name with `FACE_LOCK_AUTH_HEADER`
|
||||
|
||||
## API
|
||||
|
||||
- `POST /api/focus`
|
||||
- `POST /api/focus/image`
|
||||
- `GET /health`
|
||||
|
||||
## Detectors
|
||||
|
||||
- `face`
|
||||
- `animal`
|
||||
- `person`
|
||||
- `subject`
|
||||
|
||||
## Docs
|
||||
|
||||
- OpenAPI UI: `/docs`
|
||||
- Project docs: `docs/README.md`
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
@@ -10,8 +40,6 @@ pip install -r requirements.txt
|
||||
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
|
||||
```
|
||||
|
||||
Set `ENV=dev` to enable the Tailwind UI at `/`.
|
||||
|
||||
## Docker
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user