From 47479db0b157a9a6bc4e1774454ac7fd3f76ef5d Mon Sep 17 00:00:00 2001 From: Alexey Skobkin Date: Tue, 5 Nov 2024 02:07:34 +0300 Subject: [PATCH] immich. draft. --- README.md | 1 + immich/.env.dist | 28 +++++++++ immich/db/.gitignore | 2 + immich/docker-compose.yml | 107 +++++++++++++++++++++++++++++++++ immich/hwaccel.ml.yml | 43 +++++++++++++ immich/hwaccel.transcoding.yml | 54 +++++++++++++++++ immich/model-cache/.gitignore | 2 + immich/upload/.gitignore | 2 + 8 files changed, 239 insertions(+) create mode 100644 immich/.env.dist create mode 100644 immich/db/.gitignore create mode 100644 immich/docker-compose.yml create mode 100644 immich/hwaccel.ml.yml create mode 100644 immich/hwaccel.transcoding.yml create mode 100644 immich/model-cache/.gitignore create mode 100644 immich/upload/.gitignore diff --git a/README.md b/README.md index 29a164b..13abe14 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ Not every stack is tested to fully work. | Home Assistant | ✅ | `ghcr.io/home-assistant/home-assistant` | Home automation suite. | [Website](https://www.home-assistant.io/), [Github](https://github.com/home-assistant) | | Homer | ✅ | `b4bz/homer` | Server homepage generator. | [Github](https://github.com/bastienwirtz/homer), [Demo](https://homer-demo.netlify.app), [Configuration](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md) | | I2PD | ✅ | `purplei2p/i2pd` | The Invisible Internet router. | [Website](https://i2pd.website), [Github](https://github.com/PurpleI2P/i2pd/), [I2P project](https://geti2p.net/) | +| Immich | ✅ | `ghcr.io/immich-app/immich-server` | Self-hosted photo and video management solution. | [Website](https://immich.app), [Github](https://github.com/immich-app/immich) | | InBucket | ✅ | `inbucket/inbucket` | Testing SMTP/POP3 mail server with web interface. | [Website](https://www.inbucket.org), [Github](https://github.com/inbucket/inbucket) | | Killing Floor 2 server | ✅ Abandoned | `jeeaaasustest/killingfloor2-srv` | Killing Floor 2 game server. | | | Lidarr | Not tested | `linuxserver/lidarr` | Music downloader and manager. | [Website](https://lidarr.audio), [Github](https://github.com/Lidarr/Lidarr), [Wiki](https://wiki.servarr.com/lidarr) | diff --git a/immich/.env.dist b/immich/.env.dist new file mode 100644 index 0000000..e8184fb --- /dev/null +++ b/immich/.env.dist @@ -0,0 +1,28 @@ +# 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=./library +MODEL_CACHE_LOCATION=./model-cache +# The location where your database files are stored +DB_DATA_LOCATION=./db + +# To set a timezone, uncomment the next line and change Etc/UTC to a TZ identifier from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List +# TZ=Etc/UTC + +#HWACCEL_TRANSCODING=vaapi +#HWACCEL_ML= + +# 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 +# Please use only the characters `A-Za-z0-9`, without special characters or spaces +DB_PASSWORD=ChangeMe + +# The values below this line do not need to be changed +################################################################################### +DB_USERNAME=immich +DB_DATABASE_NAME=immich + +LOG_MAX_SIZE=5m +LOG_MAX_FILE=5 diff --git a/immich/db/.gitignore b/immich/db/.gitignore new file mode 100644 index 0000000..a68d087 --- /dev/null +++ b/immich/db/.gitignore @@ -0,0 +1,2 @@ +/* +!/.gitignore diff --git a/immich/docker-compose.yml b/immich/docker-compose.yml new file mode 100644 index 0000000..8df8b74 --- /dev/null +++ b/immich/docker-compose.yml @@ -0,0 +1,107 @@ +# +# 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: '${HWACCEL_TRANSCODING:-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:-./upload}:/usr/src/app/upload' + - '/etc/localtime:/etc/localtime:ro' + env_file: + - .env + ports: + - '2283:2283' + depends_on: + - redis + - database + restart: unless-stopped +# healthcheck: +# disable: false + logging: + driver: 'json-file' + options: + max-size: '${LOG_MAX_SIZE:-5m}' + max-file: '${LOG_MAX_FILE:-5}' + + 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: '${HWACCEL_ML:-cpu}' # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference - use the `-wsl` version for WSL2 where applicable + volumes: + - '${MODEL_CACHE_LOCATION:-./model-cache}:/cache' + env_file: + - .env + restart: unless-stopped +# healthcheck: +# disable: false + logging: + driver: 'json-file' + options: + max-size: '${LOG_MAX_SIZE:-5m}' + max-file: '${LOG_MAX_FILE:-5}' + + redis: + container_name: immich_redis + image: 'docker.io/redis:6.2-alpine@sha256:2ba50e1ac3a0ea17b736ce9db2b0a9f6f8b85d4c27d5f5accc6a416d8f42c6d5' + healthcheck: + test: redis-cli ping || exit 1 + restart: unless-stopped + logging: + driver: 'json-file' + options: + max-size: '${LOG_MAX_SIZE:-5m}' + max-file: '${LOG_MAX_FILE:-5}' + + 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: + - '${DB_DATA_LOCATION:-./db}:/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: unless-stopped + logging: + driver: 'json-file' + options: + max-size: '${LOG_MAX_SIZE:-5m}' + max-file: '${LOG_MAX_FILE:-5}' diff --git a/immich/hwaccel.ml.yml b/immich/hwaccel.ml.yml new file mode 100644 index 0000000..d9455d2 --- /dev/null +++ b/immich/hwaccel.ml.yml @@ -0,0 +1,43 @@ +# Configurations for hardware-accelerated machine learning + +# If using Unraid or another platform that doesn't allow multiple Compose files, +# you can inline the config for a backend by copying its contents +# into the immich-machine-learning service in the docker-compose.yml file. + +# See https://immich.app/docs/features/ml-hardware-acceleration for info on usage. + +services: + armnn: + devices: + - /dev/mali0:/dev/mali0 + volumes: + - /lib/firmware/mali_csffw.bin:/lib/firmware/mali_csffw.bin:ro # Mali firmware for your chipset (not always required depending on the driver) + - /usr/lib/libmali.so:/usr/lib/libmali.so:ro # Mali driver for your chipset (always required) + + cpu: {} + + cuda: + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: + - gpu + + openvino: + device_cgroup_rules: + - 'c 189:* rmw' + devices: + - /dev/dri:/dev/dri + volumes: + - /dev/bus/usb:/dev/bus/usb + + openvino-wsl: + devices: + - /dev/dri:/dev/dri + - /dev/dxg:/dev/dxg + volumes: + - /dev/bus/usb:/dev/bus/usb + - /usr/lib/wsl:/usr/lib/wsl diff --git a/immich/hwaccel.transcoding.yml b/immich/hwaccel.transcoding.yml new file mode 100644 index 0000000..33fb7b3 --- /dev/null +++ b/immich/hwaccel.transcoding.yml @@ -0,0 +1,54 @@ +# Configurations for hardware-accelerated transcoding + +# If using Unraid or another platform that doesn't allow multiple Compose files, +# you can inline the config for a backend by copying its contents +# into the immich-microservices service in the docker-compose.yml file. + +# See https://immich.app/docs/features/hardware-transcoding for more info on using hardware transcoding. + +services: + cpu: {} + + nvenc: + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: + - gpu + - compute + - video + + quicksync: + devices: + - /dev/dri:/dev/dri + + rkmpp: + security_opt: # enables full access to /sys and /proc, still far better than privileged: true + - systempaths=unconfined + - apparmor=unconfined + group_add: + - video + devices: + - /dev/rga:/dev/rga + - /dev/dri:/dev/dri + - /dev/dma_heap:/dev/dma_heap + - /dev/mpp_service:/dev/mpp_service + #- /dev/mali0:/dev/mali0 # only required to enable OpenCL-accelerated HDR -> SDR tonemapping + volumes: + #- /etc/OpenCL:/etc/OpenCL:ro # only required to enable OpenCL-accelerated HDR -> SDR tonemapping + #- /usr/lib/aarch64-linux-gnu/libmali.so.1:/usr/lib/aarch64-linux-gnu/libmali.so.1:ro # only required to enable OpenCL-accelerated HDR -> SDR tonemapping + + vaapi: + devices: + - /dev/dri:/dev/dri + + vaapi-wsl: # use this for VAAPI if you're running Immich in WSL2 + devices: + - /dev/dri:/dev/dri + volumes: + - /usr/lib/wsl:/usr/lib/wsl + environment: + - LIBVA_DRIVER_NAME=d3d12 diff --git a/immich/model-cache/.gitignore b/immich/model-cache/.gitignore new file mode 100644 index 0000000..a68d087 --- /dev/null +++ b/immich/model-cache/.gitignore @@ -0,0 +1,2 @@ +/* +!/.gitignore diff --git a/immich/upload/.gitignore b/immich/upload/.gitignore new file mode 100644 index 0000000..a68d087 --- /dev/null +++ b/immich/upload/.gitignore @@ -0,0 +1,2 @@ +/* +!/.gitignore