macOS 部署体验 immich 相册 v1.99.0

Published: 2024-03-28
Updated: 2024-06-13

Tags: Self-Hosted

本文总阅读量次

环境信息

  • 操作系统：macOS Ventura 13
  • 容器环境：OrbStack（Docker 桌面版平替，提供容器与虚拟机）
  • Node.js 环境：v20.12.0

安装 Immich（Docker Compose）

首先，创建应用目录，我计划将文件和配置存储在用户的 ~/Portable 文件夹下

$ mkdir -p ~/Portable/immich-app

$ cd ~/Portable/immich-app

下载配置文件及环境变量

$ wget -O docker-compose.yml https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
$ wget -O .env https://github.com/immich-app/immich/releases/latest/download/example.env

修改 .env 环境变量，我将 UPLOAD_LOCATION 修改为 /Users/dongdong/Portable/immich-app/library

启动服务

$ docker compose up -d

对应的停止命令是 docker compose down，需要在 docker-compose.yml 所在目录执行。

访问服务

因为是本地搭建，请求地址即：http://127.0.0.1:2283

首次访问会要求输入邮箱，用户名密码（第一个用户会成为管理员）

进入后可以通过页面上传文件

批量导入照片

支持通过命令行批量导入图片，Immich CLI 要求 Node.js 大于等于 v20 版本

$ node --version
v20.12.0

$ npm i -g @immich/cli

安装后，即可在命令行使用 immich 命令

首先，从页面获取 API Key，点击 “头像” - “Account Settings” - “API Keys”，添加一个新 Key，复制下来，关闭页面后将不再展示。

登录

# 命令的格式是 immich login server api-key
$ immich login http://127.0.0.1:2283 8OWsXo6MW4DZHsRtKVqodFzNFrRliQ2RH08ZVodQn0
Logging in to http://127.0.0.1:2283
Discovered API at http://127.0.0.1:2283/api
Logged in as username@gmail.com
Wrote auth info to /Users/dongdong/.config/immich/auth.yml

CLI 的使用参考：https://immich.app/docs/features/command-line-interface/

导入命令示例

# 导入文件夹，递归导入子文件夹，以文件夹创建相册，忽略校验哈希
$ immich upload --recursive --album --skip-hash /Users/dongdong/OneDrive/专题相册/2024/20240317-北京颐和园

# 添加 --dry-run 参数，测试导入，但实际不进行任何实际操作
$ immich upload --dry-run --recursive --album --skip-hash /Users/dongdong/OneDrive/专题相册/2024/20240317-北京颐和园

# 相册可以通过 --album-name 重命名
$  immich upload --recursive --album --skip-hash --album-name "20240317-初春北京颐和园" /Users/dongdong/OneDrive/专题相册/2024/20240317-北京颐和园

此处的 --skip-hash 参数，如果你确定本次上传没有重复文件，则可以设置此参数，减少上传前的哈希计算，速度更快。

扩展 Library

当图像存储在部署 Immich 的本地磁盘，Immich 也支持配置后直接使用。

在我的示例中，服务部署在了 ~/Portable/immich-app 下，作为演示，新建一个 ~/Portable/immich-external-library 文件夹，这个文件夹下放置者一个子文件夹 “20240220-北京新年春雪”

编辑 docker-compose.yml 配置文件（在 immich-app 文件夹内）

immich-server:
    volumes:
      - ${EXTERNAL_PATH}:/usr/src/app/immich-external-library

immich-microservices:
    volumes:
      - ${EXTERNAL_PATH}:/usr/src/app/immich-external-library

新增的 volume 配置行注意缩进，继续修改 .env 文件，添加 EXTERNAL_PATH 变量值为自己的扩展照片目录

EXTERNAL_PATH=/Users/dongdong/Portable/immich-external-library

这样物理机上的 /Users/dongdong/Portable/immich-external-library 文件夹就被映射到了容器内部的 /usr/src/app/immich-external-library 目录

重启服务使配置生效

$ docker compose down

$ docker compose up -d

而后通过 Web 页面配置扩展文件夹

点击 “Administration” - “External Libraries” - “Create Library”，选择所属用户，选择后不可更改。

这里有一些选项，点击 “Edit Import Paths” 来添加路径，保存后点击 “Validate” 校验，没问题后点击 “Save” 保存

选项中包括 “Scan Settings”，这个用来配置规则，可以排除掉不想导入的文件和文件夹，此处暂不设置。

扫描文件，点击 “Scan New Library Files”，稍等片刻，风扇开始狂转，可以看到文件已被加载处理

另外在设置页面，可以开启扩展 Library 的本地磁盘监控，有新增文件会自动添加。

截止到 2024-03-28，不能通过扩展 Library 自动创建 albums，这两个 Discussions（#4279、#4186）是相关讨论，看起来正在计划中

在 Web 支持之前，可以通过 immich-albums 脚本来自动创建 Albums，它基于文件夹创建。

效果展示

图像页

地图页

统计页

搜索（图像内容）

搜索（支持相机、区域、日期等检索）

另外 OrbStack 启动/关闭服务都很方便，还能快速进入容器以及查看日志，比较推荐使用。

服务备份

Immich 服务需要备份的有两部分：数据库与图像

备份数据库

导出

$ docker exec -t immich_postgres pg_dumpall -c -U postgres | gzip > "immich-dump.sql.gz"

恢复

$ docker compose down -v  # 删除所有数据，重新开始
$ docker compose pull        # 如果需要，更新 Immich 到最新版本
$ docker compose create    # 创建 Docker 容器但不启动他们
$ docker start immich_postgres    # 单独启动 Postgres 服务

# 等待 10s 钟等待 Postgres 启动完成
$ gunzip < "immich-dump.sql.gz" | docker exec -i immich_postgres psql -U postgres -d immich    # 导入

$ docker compose up -d    # 启动服务

备份图像

Immich 在磁盘存储两类内容 —— 原始文件与生成文件。

只有原始文件需要备份，文件夹为 UPLOAD_LOCATION 目录下的 library、upload、profile

Immich 提供的小工具

# 进入 immich_server 容器
$ docker exec -it immich_server /bin/bash

# 列出所有用户
$ immich-admin list-users
[
  {
    id: 'd159a19d-b8e9-434c-bebe-51b5e7f10c63',
    email: 'my-email-addr@gmail.com',
    name: '东东',
    profileImagePath: '',
    avatarColor: 'primary',
    storageLabel: 'admin',
    shouldChangePassword: true,
    isAdmin: true,
    createdAt: 2024-03-27T04:34:26.222Z,
    deletedAt: null,
    updatedAt: 2024-03-27T05:35:30.409Z,
    oauthId: '',
    memoriesEnabled: true,
    quotaSizeInBytes: null,
    quotaUsageInBytes: 3214286188,
    status: 'active'
  }
]

immich-admin 目前还支持：重置 admin 密码、启用密码登录、禁用密码登录、启用 oauth 登录、禁用 oauth 登录。

更新到最新版本

Immich 平均一周会发一个小版本, 查看更新说明: immich/releases

更新到最新版本只需要执行如下命令即可

# 先进到应用的目录
$ cd ~/Portable/immich-app

$ docker compose pull && docker compose up -d

如果想要更新到指定的版本，修改 .env 内的 IMMICH_VERSION 为版本号后再升级，如: v1.100.0

最后

推荐 Immich 的人很多，它的算法和速度都不错，不过目前还属于早期的开发版本，可能随时调整各项功能，每次升级前需要格外留意，做好备份，不要将鸡蛋都放在一个篮子。

再就是 Immich 暂不支持多语言、无法使用中文（页面语言、以及搜索的时候要搜索 “duck” 而不支持 “鸭子”），小 BUG 会多一些（比如截图中的 Storage，显示的不正确 #7482 #4318）

Immich 需要导入图像或加载本地磁盘的图像，通过 CLI 工具可以将文件夹导入并自动创建 Album，不过扩展 Library 还不支持导入为 Albums，另外一个在国内使用的困扰就是 Map 地图使用的 OpenStreetMap 的 API，非科学不可用，如果后续能自定义地图 API 或支持配置 OSM 代理就好很多。

现阶段，Immich 还不太适合作为一站式管理图像的稳定服务，虽有不足，但值得关注，未来可期。

20240613 补充

Immich 更新到了 v1.106.3 版本

中间的几个版本改善了分享、硬件转码加速、可选的外部库可编辑，增加了邮件通知、查找重复文件、多语言支持等功能!

中文支持

非常棒！

20240823 补充

有段时间没更新，再次更新发现已经到了 v1.112.1 版本，数据库原有数据从 Volume 调整到了磁盘挂载...

因为一直在测试，就懒得找迁移文档，切换了新的 yaml 配置 docker-compose.yml 重新部署

#
# WARNING: Make sure to use the docker-compose.yml of the current release:
#
# https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
#
# The compose file on main may not be compatible with the latest release.
#

name: immich

services:
  immich-server:
    container_name: immich_server
    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
    # extends:
    #   file: hwaccel.transcoding.yml
    #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
    volumes:
      # Do not edit the next line. If you want to change the media storage location on your system, edit the value of UPLOAD_LOCATION in the .env file
      - ${UPLOAD_LOCATION}:/usr/src/app/upload
      - /etc/localtime:/etc/localtime:ro
    env_file:
      - .env
    ports:
      - 2283:3001
    depends_on:
      - redis
      - database
    restart: always
    healthcheck:
      disable: false

  immich-machine-learning:
    container_name: immich_machine_learning
    # For hardware acceleration, add one of -[armnn, cuda, openvino] to the image tag.
    # Example tag: ${IMMICH_VERSION:-release}-cuda
    image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
    # extends: # uncomment this section for hardware acceleration - see https://immich.app/docs/features/ml-hardware-acceleration
    #   file: hwaccel.ml.yml
    #   service: cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference - use the `-wsl` version for WSL2 where applicable
    volumes:
      - model-cache:/cache
    env_file:
      - .env
    restart: always
    healthcheck:
      disable: false

  redis:
    container_name: immich_redis
    image: docker.io/redis:6.2-alpine@sha256:e3b17ba9479deec4b7d1eeec1548a253acc5374d68d3b27937fcfe4df8d18c7e
    healthcheck:
      test: redis-cli ping || exit 1
    restart: always

  database:
    container_name: immich_postgres
    image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
    environment:
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_DB: ${DB_DATABASE_NAME}
      POSTGRES_INITDB_ARGS: '--data-checksums'
    volumes:
      # Do not edit the next line. If you want to change the database storage location on your system, edit the value of DB_DATA_LOCATION in the .env file
      - ${DB_DATA_LOCATION}:/var/lib/postgresql/data
    healthcheck:
      test: pg_isready --dbname='${DB_DATABASE_NAME}' --username='${DB_USERNAME}' || exit 1; Chksum="$$(psql --dbname='${DB_DATABASE_NAME}' --username='${DB_USERNAME}' --tuples-only --no-align --command='SELECT COALESCE(SUM(checksum_failures), 0) FROM pg_stat_database')"; echo "checksum failure count is $$Chksum"; [ "$$Chksum" = '0' ] || exit 1
      interval: 5m
      start_interval: 30s
      start_period: 5m
    command: ["postgres", "-c", "shared_preload_libraries=vectors.so", "-c", 'search_path="$$user", public, vectors', "-c", "logging_collector=on", "-c", "max_wal_size=2GB", "-c", "shared_buffers=512MB", "-c", "wal_compression=on"]
    restart: always

volumes:
  model-cache:

最新的 .env 文件如下

# You can find documentation for all the supported env variables at https://immich.app/docs/install/environment-variables

# The location where your uploaded files are stored
UPLOAD_LOCATION=/Users/dongdong/Portable/immich-app/library

# The Immich version to use. You can pin this to a specific version like "v1.71.0"
IMMICH_VERSION=release

# Connection secret for postgres. You should change it to a random password
DB_PASSWORD=postgres

# The values below this line do not need to be changed
###################################################################################
DB_HOSTNAME=immich_postgres
DB_USERNAME=postgres
DB_DATABASE_NAME=immich


REDIS_HOSTNAME=immich_redis

EXTERNAL_PATH=/Users/dongdong/Portable/immich-external-library

DB_DATA_LOCATION=/Users/dongdong/Portable/immich-app/pgdata

体验了下，页面整体的美观程度，后台管理项，整体都有一定提升

参考