Skip to content

daemonless/immich-ml

Repository files navigation

Immich Machine Learning

Build Status Last Commit

Machine learning service for Immich — handles facial recognition, image classification, and semantic search using ONNX models.

Port 3003
Registry ghcr.io/daemonless/immich-ml
Source https://github.com/immich-app/immich
Website https://immich.app/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.
beta Beta release built from upstream v3.0.0-rc.2. Alternative build.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  immich-ml:
    image: "ghcr.io/daemonless/immich-ml:latest"
    container_name: immich-ml
    environment:
      - MACHINE_LEARNING_HOST=0.0.0.0  # Host to bind to (0.0.0.0)
      - MACHINE_LEARNING_PORT=3003  # Port to bind to (3003)
      - MACHINE_LEARNING_CACHE_FOLDER=/cache  # Path to cache folder (/cache)
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/immich-ml/cache:/cache"
      - "/path/to/containers/immich-ml:/config"
    ports:
      - "3003:3003"
    restart: unless-stopped

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=immich-ml
MACHINE_LEARNING_HOST=0.0.0.0
MACHINE_LEARNING_PORT=3003
MACHINE_LEARNING_CACHE_FOLDER=/cache
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  immich-ml:
    name: immich_ml
    options:
      - container: 'boot args:--pull'
      - expose: '3003:3003 proto:tcp' \
    oci:
      user: root
      environment:
        - MACHINE_LEARNING_HOST: !ENV '${MACHINE_LEARNING_HOST}'
        - MACHINE_LEARNING_PORT: !ENV '${MACHINE_LEARNING_PORT}'
        - MACHINE_LEARNING_CACHE_FOLDER: !ENV '${MACHINE_LEARNING_CACHE_FOLDER}'
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - immich-ml_cache: /cache
      - immich-ml: /config
volumes:
  immich-ml_cache:
    device: '/path/to/containers/immich-ml/cache'
  immich-ml:
    device: '/path/to/containers/immich-ml'

Makejail:

# Makejail 

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/immich-ml:${tag}

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name immich-ml \
  -p 3003:3003 \
  -e MACHINE_LEARNING_HOST=0.0.0.0 \
  -e MACHINE_LEARNING_PORT=3003 \
  -e MACHINE_LEARNING_CACHE_FOLDER=/cache \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/immich-ml/cache:/cache \
  -v /path/to/containers/immich-ml:/config \
  ghcr.io/daemonless/immich-ml:latest

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="3003:3003 proto:tcp" \
  -e MACHINE_LEARNING_HOST=0.0.0.0 \
  -e MACHINE_LEARNING_PORT=3003 \
  -e MACHINE_LEARNING_CACHE_FOLDER=/cache \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/immich-ml/cache /cache <pseudofs>" \
  -o fstab="/path/to/containers/immich-ml /config <pseudofs>" \
  ghcr.io/daemonless/immich-ml:latest immich-ml

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Ansible

- name: Deploy immich-ml
  containers.podman.podman_container:
    name: immich-ml
    image: "ghcr.io/daemonless/immich-ml:latest"
    state: started
    restart_policy: always
    env:
      MACHINE_LEARNING_HOST: "0.0.0.0"
      MACHINE_LEARNING_PORT: "3003"
      MACHINE_LEARNING_CACHE_FOLDER: "/cache"
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "3003:3003"
    volumes:
      - "/path/to/containers/immich-ml/cache:/cache"
      - "/path/to/containers/immich-ml:/config"

Parameters

Environment Variables

Variable Default Description
MACHINE_LEARNING_HOST 0.0.0.0 Host to bind to (0.0.0.0)
MACHINE_LEARNING_PORT 3003 Port to bind to (3003)
MACHINE_LEARNING_CACHE_FOLDER /cache Path to cache folder (/cache)
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/cache Model cache directory (HuggingFace)
/config Configuration directory (unused but mounted)

Ports

Port Protocol Description
3003 TCP ML API

This image is part of the Immich Stack.

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.