diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
@@ -35,6 +35,11 @@ back end, plain HTML/CSS/JS front end. Live at **https://albumen.jots.org**. - **Run Update** button scans for new/removed files and generates missing thumbnails; **Force rescan all** checkbox bypasses the sentinel and rescans every directory +### Facial recognition (opt-in) +- Detects faces in photos and stores 128-D embeddings alongside each image +- Powered by [face_recognition](https://github.com/ageitgey/face_recognition) (dlib/HOG, CPU-only) +- People management and browse-by-person UI in progress + ### Media support | Category | Extensions | @@ -169,6 +174,39 @@ The PBKDF2-SHA256 hash is stored in `/opt/albumen/config.yml` (readable only by --- +## Facial recognition setup + +Face detection is opt-in. Install once, then enable in `config.yml`. + +### 1. Install Python dependencies (server, ~30 min first time) + +```bash +apt install python3-pip python3-dev python3-venv cmake build-essential libopenblas-dev liblapack-dev +python3 -m venv /opt/albumen/venv +/opt/albumen/venv/bin/pip install face_recognition +``` + +### 2. Enable in config.yml + +Add to `/opt/albumen/config.yml`: + +```yaml +faces: + enabled: true +``` + +### 3. Run the update script + +```bash +ruby /opt/albumen/scripts/update.rb +``` + +The update script will now detect faces in images and store bounding boxes and +embeddings in each album's `album.json`. This is a one-time cost per image; +subsequent runs skip already-processed photos. + +--- + ## Service management ```bash |