Skip to content

Installation

Jump to bottom
vonhex edited this page Apr 24, 2026 · 13 revisions

Installation Guide

Eyeris offers multiple deployment options to suit your environment.

Hardware Requirements

Minimum (CPU Only)

  • RAM: 4GB
  • CPU: Any modern x86_64 processor
  • Storage: 2GB for the application and models (plus space for your thumbnails)

Recommended (GPU Accelerated)

For faster face detection and grouping during large library scans:

Option 1: Unraid (Standard Manual Install)

Since Eyeris is in early release, you will need to add it manually to your Unraid Docker tab.

1. Create the Container

  1. Go to the Docker tab in Unraid.
  2. Click Add Container at the bottom.
  3. CRITICAL: Toggle the Advanced View switch in the top right corner.
  4. Set Name to eyeris.
  5. Set Repository to ghcr.io/vonhex/eyeris:latest.
  6. Set WebUI to http://[IP]:[PORT:8000].
  7. Icon URL: Paste the following to get the Eyeris logo: https://raw.githubusercontent.com/vonhex/Eyeris/main/frontend/public/eyeris-logo-icon.png

2. Configure Path Mappings

Click Add another Path, Port, Variable, Label or Device for each of these:

  • Path: Media Storage
    • Container Path: /data/images
    • Host Path: /mnt/user/Pictures/ (or your Unassigned Device path like /mnt/disks/Photos)
    • Access Mode: Choose Read/Write - Slave if using an Unassigned Device / NAS mount.
  • Path: Thumbnails
    • Container Path: /data/thumbnails
    • Host Path: /mnt/user/appdata/eyeris/thumbnails
  • Path: Database (SQLite only)
    • Container Path: /data/db
    • Host Path: /mnt/user/appdata/eyeris/db

3. Configure Port

  • Port: Web UI
    • Container Port: 8000
    • Host Port: 8000

4. GPU Acceleration (Optional)

If you want to use your GPU for face detection, add the following based on your hardware:

NVIDIA Users:

  • Extra Parameters: --gpus all
  • Variable: NVIDIA_VISIBLE_DEVICES = all
  • Variable: NVIDIA_DRIVER_CAPABILITIES = all

Intel / AMD iGPU Users:

  • Extra Parameters: --device /dev/dri:/dev/dri

5. Database Setup (Choose One)

A. Using Built-in SQLite (Default)

No extra configuration needed. Eyeris will use the /data/db path mapped in Step 2.

B. Using External MariaDB/MySQL (Recommended)

Add these Variables to switch from SQLite to an external database:

  • DB_HOST = (Your MariaDB IP)
  • DB_PORT = 3306
  • DB_USER = (Your DB User)
  • DB_PASSWORD = (Your DB Password)
  • DB_NAME = eyeris

Option 2: Docker CLI (Standard Linux)

docker run -d \
  --name eyeris \
  -p 8000:8000 \
  -v ./thumbnails:/data/thumbnails \
  -v ./db:/data/db \
  -e SMB_HOST=192.168.1.x \
  -e SMB_USERNAME=youruser \
  -e SMB_PASSWORD=yourpass \
  -e SMB_SHARES=photos,media \
  ghcr.io/vonhex/eyeris:latest

Post-Installation

On first load, Eyeris auto-generates a login with the default password eyeris. Change your password immediately via Settings.

Clone this wiki locally