pdf-icon

Immich

Immich is an open-source self-hosted photo and video management platform that supports automatic backups, intelligent search, and cross-device access.

  1. Manually download the program and upload it to AI Pyramid, or pull the model repository using the following command.
Tip
If git lfs is not installed, first refer to the git lfs installation guide to install it.
git clone https://huggingface.co/AXERA-TECH/immich

File Description:

root@m5stack-AI-Pyramid:~/rsp/immich# ls -lh
total 421M
drwxrwxr-x 2 axera axera 4.0K Dec 23 17:23 asset
-rw-rw-r-- 1 axera axera 421M Dec 23 17:23 ax-immich-server-aarch64.tar.gz
-rw-rw-r-- 1 axera axera    0 Dec 23 17:22 config.json
-rw-rw-r-- 1 axera axera 7.6K Dec 23 17:23 docker-deploy.zip
-rw-rw-r-- 1 axera axera 104K Dec 23 17:23 immich_ml-1.129.0-py3-none-any.whl
-rw-rw-r-- 1 axera axera 9.4K Dec 23 17:22 README.md
-rw-rw-r-- 1 axera axera  177 Dec 23 17:22 requirements.txt
  1. Import the Docker image
cd immich
docker load -i ax-immich-server-aarch64.tar.gz
  1. Prepare the working directory
Tip
If unzip is not installed, first install it using the apt install zip -y command.
unzip docker-deploy.zip
cp example.env .env
  1. Start the containers
Tip
If you are using the 4GB version of AI Pyramid, first refer to Increase Virtual Memory to ensure the program can run properly.
docker compose -f docker-compose.yml -f docker-compose.override.yml up -d

After successful startup, the information is as follows:

root@m5stack-AI-Pyramid:~/rsp/immich# docker compose -f docker-compose.yml -f docker-compose.override.yml up -d
WARN[0000] /root/rsp/immich/docker-compose.override.yml: `version` is obsolete 
[+] Running 3/3
 ✔ Container immich_redis     Running                                                                                                    0.0s 
 ✔ Container immich_postgres  Running                                                                                                    0.0s 
 ✔ Container immich_server    Running                                                                                                    0.0s 
  1. Install dependency packages
pip install https://github.com/AXERA-TECH/pyaxengine/releases/download/0.1.3.rc2/axengine-0.1.3-py3-none-any.whl
pip install -r requirements.txt
pip install immich_ml-1.129.0-py3-none-any.whl # The precompiled package may be updated; please use the actual filename.
  1. Create a Python symlink and start the immich_ml service
ln -s /usr/bin/python3 /usr/bin/python
IMMICH_HOST=0.0.0.0 IMMICH_PORT=3003 python3 -m immich_ml

After running, the output information is as follows:

root@m5stack-AI-Pyramid:~/rsp/immich# IMMICH_HOST=0.0.0.0 IMMICH_PORT=3003 python3 -m immich_ml
[12/30/25 10:59:50] INFO     Starting gunicorn 23.0.0                                                                                         
[12/30/25 10:59:50] INFO     Listening at: http://0.0.0.0:3003 (14537)                                                                        
[12/30/25 10:59:50] INFO     Using worker: immich_ml.config.CustomUvicornWorker                                                               
[12/30/25 10:59:50] INFO     Booting worker with pid: 14546                                                                                   
2025-12-30 10:59:52.776738850 [W:onnxruntime:Default, device_discovery.cc:164 DiscoverDevicesForPlatform] GPU device discovery failed: device_discovery.cc:89 ReadFileContents Failed to open file: "/sys/class/drm/card1/device/vendor"
[INFO] Available providers:  ['AxEngineExecutionProvider']
/usr/local/lib/python3.10/dist-packages/immich_ml/models/clip/cn_vocab.txt
[12/30/25 11:00:06] INFO     Started server process [14546]                                                                                   
[12/30/25 11:00:06] INFO     Waiting for application startup.                                                                                 
[12/30/25 11:00:06] INFO     Created in-memory cache with unloading after 300s of inactivity.                                                 
[12/30/25 11:00:06] INFO     Initialized request thread pool with 8 threads.                                                                  
[12/30/25 11:00:06] INFO     Application startup complete.

Enter the AI Pyramid IP address and port 2283 in the browser, for example: 192.168.20.105:2283.

Note: On the first access, you need to register an administrator account. The account and password are stored locally.

After configuration is complete, you can upload photos and videos. For the first time, you need to configure the machine learning server. Refer to the image below to enter the configuration.

Fill in the URL with the AI Pyramid IP address and port 3003, for example: 192.168.20.118:3003.

For the CLIP model:

  • If using Chinese search, set it to ViT-L-14-336-CN__axera
  • If using English search, set it to ViT-L-14-336__axera

After setting, save the configuration.

Tip
If the server is shown as offline, check whether the client proxy is enabled. Disable it and refresh the webpage.

For the first time, you need to manually enter the Jobs option and manually trigger it under SMART SEARCH.

The immich_ml service will automatically download the models.

Enter a description of the image in the search bar to retrieve related images.

On This Page