Adds ticks to the progress indicator

* fix zero index

* fix day

* docs: add gpu acceleration milestone

---------

Co-authored-by: martabal <74269598+martabal@users.noreply.github.com>

.dockerignore

@@ -8,7 +8,7 @@ machine-learning/
 misc/
 mobile/
 
-server/node_modules
+server/node_modules/
 server/coverage/
 server/.reverse-geocoding-dump/
 server/upload/
@@ -19,7 +19,10 @@ web/coverage/
 web/.svelte-kit
 web/build/
 
-cli/node_modules
+cli/node_modules/
 cli/.reverse-geocoding-dump/
 cli/upload/
-cli/dist/
+cli/dist/
+
+open-api/typescript-sdk/node_modules/
+open-api/typescript-sdk/build/

.gitattributes

@@ -8,14 +8,9 @@ mobile/openapi/.openapi-generator/FILES linguist-generated=true
 mobile/lib/**/*.g.dart -diff -merge
 mobile/lib/**/*.g.dart linguist-generated=true
 
-cli/src/api/open-api/**/*.md -diff -merge
-cli/src/api/open-api/**/*.md linguist-generated=true
-cli/src/api/open-api/**/*.ts -diff -merge
-cli/src/api/open-api/**/*.ts linguist-generated=true
-
-web/src/api/open-api/**/*.md -diff -merge
-web/src/api/open-api/**/*.md linguist-generated=true
-web/src/api/open-api/**/*.ts -diff -merge
-web/src/api/open-api/**/*.ts linguist-generated=true
+open-api/typescript-sdk/client/**/*.md -diff -merge
+open-api/typescript-sdk/client/**/*.md linguist-generated=true
+open-api/typescript-sdk/client/**/*.ts -diff -merge
+open-api/typescript-sdk/client/**/*.ts linguist-generated=true
 
 *.sh text eol=lf

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,7 +1,5 @@
 name: Report an issue with Immich
 description: Report an issue with Immich
-labels: ["bug", "need triage"]
-title: "[BUG] <title>"
 body:
   - type: markdown
     attributes:

.github/release.yml

@@ -1,29 +1,41 @@
 changelog:
   categories:
-    - title: Breaking Changes 🛠
+    - title: ⚠️ Breaking Changes
       labels:
         - breaking-change
-    - title: Server
+
+    - title: 🗄️ Server
       labels:
         - 🗄️server
-    - title: Mobile
+
+    - title: 📱 Mobile
       labels:
         - 📱mobile
-    - title: Web
+
+    - title: 🖥️ Web
       labels:
         - 🖥️web
-    - title: Machine Learning
+
+    - title: 🧠 Machine Learning
       labels:
         - 🧠machine-learning
-    - title: CLI
+
+    - title: ⚡ CLI
       labels:
         - cli
-    - title: Documentation
+
+    - title: 📓 Documentation
       labels:
         - documentation
-    - title: Dependency updates
+
+    - title: 🔨 Maintenance
       labels:
+        - deployment
+        - dependencies
         - renovate
+        - maintenance
+        - tech-debt
+
     - title: Other changes
       labels:
         - "*"

.github/workflows/build-mobile.yml

@@ -20,7 +20,7 @@ jobs:
     name: Build and sign Android
     # Skip when PR from a fork
     if: ${{ !github.event.pull_request.head.repo.fork && github.actor != 'dependabot[bot]' }}
-    runs-on: macos-13
+    runs-on: macos-14
 
     steps:
       - name: Determine ref
@@ -38,14 +38,14 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: "zulu"
-          java-version: "12.x"
+          java-version: "11.0.21+9"
           cache: "gradle"
 
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.16.9"
           cache: true
 
       - name: Create the Keystore

.github/workflows/docker.yml

@@ -25,15 +25,38 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - context: "machine-learning"
-            file: "machine-learning/Dockerfile"
-            image: "immich-machine-learning"
-            platforms: "linux/amd64,linux/arm64"
-          - context: "."
-            file: "server/Dockerfile"
-            image: "immich-server"
-            platforms: "linux/arm64,linux/amd64"
+          - image: immich-machine-learning
+            context: machine-learning
+            file: machine-learning/Dockerfile
+            platforms: linux/amd64,linux/arm64
+            device: cpu
 
+          - image: immich-machine-learning
+            context: machine-learning
+            file: machine-learning/Dockerfile
+            platforms: linux/amd64
+            device: cuda
+            suffix: -cuda
+
+          - image: immich-machine-learning
+            context: machine-learning
+            file: machine-learning/Dockerfile
+            platforms: linux/amd64
+            device: openvino
+            suffix: -openvino
+          
+          - image: immich-machine-learning
+            context: machine-learning
+            file: machine-learning/Dockerfile
+            platforms: linux/arm64
+            device: armnn
+            suffix: -armnn
+
+          - image: immich-server
+            context: .
+            file: server/Dockerfile
+            platforms: linux/amd64,linux/arm64
+            device: cpu
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -79,12 +102,12 @@ jobs:
             name=altran1502/${{matrix.image}},enable=${{ github.event_name == 'release' }}
           tags: |
             # Tag with branch name
-            type=ref,event=branch
+            type=ref,event=branch,suffix=${{ matrix.suffix }}
             # Tag with pr-number
-            type=ref,event=pr
+            type=ref,event=pr,suffix=${{ matrix.suffix }}
             # Tag with git tag on release
-            type=ref,event=tag
-            type=raw,value=release,enable=${{ github.event_name == 'release' }}
+            type=ref,event=tag,suffix=${{ matrix.suffix }}
+            type=raw,value=release,enable=${{ github.event_name == 'release' }},suffix=${{ matrix.suffix }}
 
       - name: Determine build cache output
         id: cache-target
@@ -106,5 +129,7 @@ jobs:
           push: ${{ !github.event.pull_request.head.repo.fork }}
           cache-from: type=registry,ref=ghcr.io/${{ github.repository_owner }}/immich-build-cache:${{matrix.image}}
           cache-to: ${{ steps.cache-target.outputs.cache-to }}
+          build-args: |
+            DEVICE=${{ matrix.device }}
           tags: ${{ steps.metadata.outputs.tags }}
           labels: ${{ steps.metadata.outputs.labels }}

.github/workflows/prepare-release.yml

@@ -83,5 +83,6 @@ jobs:
           files: |
             docker/docker-compose.yml
             docker/example.env
-            docker/hwaccel.yml
+            docker/hwaccel.ml.yml
+            docker/hwaccel.transcoding.yml
             *.apk

.github/workflows/static_analysis.yml

@@ -23,7 +23,7 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.16.9"
 
       - name: Install dependencies
         run: dart pub get

.github/workflows/test.yml

@@ -10,9 +10,26 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  e2e-tests:
-    name: Server (e2e)
-    runs-on: ubuntu-latest
+  server-e2e-api:
+    name: Server (e2e-api)
+    runs-on: mich
+    defaults:
+      run:
+        working-directory: ./server
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run npm install
+        run: npm ci
+
+      - name: Run e2e tests
+        run: npm run e2e:api
+
+  server-e2e-jobs:
+    name: Server (e2e-jobs)
+    runs-on: mich
 
     steps:
       - name: Checkout code
@@ -21,7 +38,7 @@ jobs:
           submodules: "recursive"
 
       - name: Run e2e tests
-        run: make test-server-e2e
+        run: make server-e2e-jobs
 
   doc-tests:
     name: Docs
@@ -41,10 +58,6 @@ jobs:
         run: npm run format
         if: ${{ !cancelled() }}
 
-      - name: Run tsc
-        run: npm run check
-        if: ${{ !cancelled() }}
-
       - name: Run build
         run: npm run build
         if: ${{ !cancelled() }}
@@ -90,10 +103,14 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Run npm install in cli
+      - name: Run setup typescript-sdk
+        run: npm ci && npm run build
+        working-directory: ./open-api/typescript-sdk
+
+      - name: Run npm install (cli)
         run: npm ci
 
-      - name: Run npm install in server
+      - name: Run npm install (server)
         run: npm ci
         working-directory: ./server
 
@@ -126,11 +143,15 @@ jobs:
         with:
           submodules: "recursive"
 
-      - name: Run npm install in cli
+      - name: Run setup typescript-sdk
+        run: npm ci && npm run build
+        working-directory: ./open-api/typescript-sdk
+
+      - name: Run npm install (cli)
         run: npm ci
 
-      - name: Run npm install in server
-        run: npm ci
+      - name: Run npm install (server)
+        run: npm ci && npm run build
         working-directory: ./server
 
       - name: Run e2e tests
@@ -147,6 +168,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Run setup typescript-sdk
+        run: npm ci && npm run build
+        working-directory: ./open-api/typescript-sdk
+
       - name: Run npm install
         run: npm ci
 
@@ -166,9 +191,9 @@ jobs:
         run: npm run check:typescript
         if: ${{ !cancelled() }}
 
-      # - name: Run unit tests & coverage
-      #   run: npm run test:cov
-      #   if: ${{ !cancelled() }}
+      - name: Run unit tests & coverage
+        run: npm run test:cov
+        if: ${{ !cancelled() }}
 
   mobile-unit-tests:
     name: Mobile
@@ -179,7 +204,7 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.16.9"
       - name: Run tests
         working-directory: ./mobile
         run: flutter test -j 1
@@ -200,10 +225,10 @@ jobs:
           cache: "poetry"
       - name: Install dependencies
         run: |
-          poetry install --with dev
+          poetry install --with dev --with cpu
       - name: Lint with ruff
         run: |
-          poetry run ruff check --format=github app export
+          poetry run ruff check --output-format=github app export
       - name: Check black formatting
         run: |
           poetry run black --check app export
@@ -220,14 +245,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Run API generation
-        run: npm --prefix server run api:generate
+        run: make open-api
       - name: Find file changes
         uses: tj-actions/verify-changed-files@v13.1
         id: verify-changed-files
         with:
           files: |
             mobile/openapi
-            web/src/api/open-api
+            open-api/typescript-sdk
       - name: Verify files have not changed
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |
@@ -269,6 +294,9 @@ jobs:
       - name: Run existing migrations
         run: npm run typeorm:migrations:run
 
+      - name: Test npm run schema:reset command works
+        run: npm run typeorm:schema:reset
+
       - name: Generate new migrations
         continue-on-error: true
         run: npm run typeorm:migrations:generate ./src/infra/migrations/TestMigration

.gitignore

@@ -1,3 +1,5 @@
+**/node_modules/**
+
 .DS_Store
 .vscode/*
 !.vscode/launch.json
@@ -12,3 +14,7 @@ mobile/gradle.properties
 mobile/openapi/pubspec.lock
 mobile/*.jks
 mobile/libisar.dylib
+
+open-api/typescript-sdk/build
+mobile/android/fastlane/report.xml
+mobile/ios/fastlane/report.xml

Makefile

@@ -16,8 +16,11 @@ stage:
 pull-stage:
 	docker compose -f ./docker/docker-compose.staging.yml pull
 
-test-server-e2e:
-	docker compose -f ./server/test/docker-compose.server-e2e.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
+server-e2e-jobs:
+	docker compose -f ./server/e2e/docker-compose.server-e2e.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
+
+server-e2e-api:
+	npm run e2e:api --prefix server
 
 prod:
 	docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
@@ -25,8 +28,15 @@ prod:
 prod-scale:
 	docker compose -f ./docker/docker-compose.prod.yml up --build -V --scale immich-server=3 --scale immich-microservices=3 --remove-orphans
 
-api:
-	npm --prefix server run api:generate
+.PHONY: open-api
+open-api:
+	cd ./open-api && bash ./bin/generate-open-api.sh
+
+open-api-dart:
+	cd ./open-api && bash ./bin/generate-open-api.sh dart
+
+open-api-typescript:
+	cd ./open-api && bash ./bin/generate-open-api.sh typescript
 
 sql:
 	npm --prefix server run sql:generate

README.md

@@ -28,6 +28,7 @@
   <a href="README_nl_NL.md">Nederlands</a>
   <a href="README_tr_TR.md">Türkçe</a>
   <a href="README_zh_CN.md">中文</a>
+  <a href="README_ru_RU.md">Русский</a>
 </p>
 
 ## Disclaimer
@@ -70,10 +71,12 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 
 ## Features
 
+
 | Features                                     | Mobile | Web |
-| -------------------------------------------- | ------ | --- |
+| :--------------------------------------------- | -------- | ----- |
 | Upload and view videos and photos            | Yes    | Yes |
 | Auto backup when the app is opened           | Yes    | N/A |
+| Prevent duplication of assets                | Yes    | Yes |
 | Selective album(s) for backup                | Yes    | N/A |
 | Download photos and videos to local device   | Yes    | Yes |
 | Multi-user support                           | Yes    | Yes |
@@ -88,6 +91,7 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | OAuth support                                | Yes    | Yes |
 | API Keys                                     | N/A    | Yes |
 | LivePhoto/MotionPhoto backup and playback    | Yes    | Yes |
+| Support 360 degree image display             | No     | Yes |
 | User-defined storage structure               | Yes    | Yes |
 | Public Sharing                               | No     | Yes |
 | Archive and Favorites                        | Yes    | Yes |
@@ -109,14 +113,15 @@ If you feel like this is the right cause and the app is something you are seeing
 
 ### Donation
 
-- [Monthly donation](https://github.com/sponsors/alextran1502) via GitHub Sponsors
-- [One-time donation](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
+- [Monthly donation](https://github.com/sponsors/immich-app) via GitHub Sponsors
+- [One-time donation](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Liberapay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
 
 ## Contributors
+
 <a href="https://github.com/alextran1502/immich/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
 </a>

README_ca_ES.md

@@ -106,8 +106,8 @@ Si creieu que aquesta és una causa justa i l'aplicació és alguna cosa que us
 
 ## Donació
 
-- [Donació mensual](https://github.com/sponsors/alextran1502) a través de GitHub Sponsors
-- [Donació única](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
+- [Donació mensual](https://github.com/sponsors/immich-app) a través de GitHub Sponsors
+- [Donació única](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_es_ES.md

@@ -107,8 +107,8 @@ Si consideras que esta es una causa justa y la aplicación es algo que te gustar
 
 ## Donación
 
-- [Donación mensual](https://github.com/sponsors/alextran1502) a través de GitHub Sponsors
-- [Donación única](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
+- [Donación mensual](https://github.com/sponsors/immich-app) a través de GitHub Sponsors
+- [Donación única](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_fr_FR.md

@@ -108,8 +108,8 @@ Si vous estimez que c'est pour la bonne cause et que vous prévoyez d'utiliser l
 
 ## Donation
 
-- [Donation mensuelle](https://github.com/sponsors/alextran1502) via GitHub Sponsors
-- [Donation occasionnelle](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Donation mensuelle](https://github.com/sponsors/immich-app) via GitHub Sponsors
+- [Donation occasionnelle](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_it_IT.md

@@ -109,8 +109,8 @@ Se pensi che Immich sia una buona causa e che l'app sia qualcosa che useresti ne
 
 ## Donazioni
 
-- [Donazione mensile](https://github.com/sponsors/alextran1502) tramite GitHub Sponsors
-- [Donazione una tantum](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) tramite GitHub Sponsors
+- [Donazione mensile](https://github.com/sponsors/immich-app) tramite GitHub Sponsors
+- [Donazione una tantum](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) tramite GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_ja_JP.md

@@ -108,8 +108,8 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 
 ## 寄付
 
-- GitHub スポンサー経由の[毎月の寄付](https://github.com/sponsors/alextran1502)
-- GitHub スポンサー経由の[一回寄付](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
+- GitHub スポンサー経由の[毎月の寄付](https://github.com/sponsors/immich-app)
+- GitHub スポンサー経由の[一回寄付](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_ko_KR.md

@@ -109,8 +109,8 @@ password: demo
 
 ### 후원
 
-- GitHub 스폰서를 통한 [정기 후원](https://github.com/sponsors/alextran1502)
-- GitHub 스폰서를 통한 [일시 후원](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
+- GitHub 스폰서를 통한 [정기 후원](https://github.com/sponsors/immich-app)
+- GitHub 스폰서를 통한 [일시 후원](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_nl_NL.md

@@ -108,8 +108,8 @@ Als je denkt dat dit het juiste doel is en de app iets is dat je jezelf al heel
 
 ## Doneren
 
-- [Maandelijkse donatie](https://github.com/sponsors/alextran1502) via GitHub Sponsors
-- [Eenmalige donatie](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Maandelijkse donatie](https://github.com/sponsors/immich-app) via GitHub Sponsors
+- [Eenmalige donatie](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_ru_RU.md

@@ -0,0 +1,124 @@
+<p align="center"> 
+  <br/>  
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
+  <a href="https://discord.gg/D8JsnBEuKb">
+    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt="Discord"/>
+  </a>
+  <br/>  
+  <br/>   
+</p>
+
+<p align="center">
+<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
+</p>
+<h3 align="center">Immich - Высокопроизводительное решение для автономоного создания фото и видео архивов</h3>
+<br/>
+<a href="https://immich.app">
+<img src="design/immich-screenshots.png" title="Main Screenshot">
+</a>
+<br/>
+<p align="center">
+  <a href="README_ca_ES.md">Català</a>
+  <a href="README_es_ES.md">Español</a>
+  <a href="README_fr_FR.md">Français</a>
+  <a href="README_it_IT.md">Italiano</a>
+  <a href="README_ja_JP.md">日本語</a>
+  <a href="README_ko_KR.md">한국어</a>
+  <a href="README_de_DE.md">Deutsch</a>
+  <a href="README_nl_NL.md">Nederlands</a>
+  <a href="README_tr_TR.md">Türkçe</a>
+  <a href="README_zh_CN.md">中文</a>
+  <a href="README_ru_RU.md">Русский</a>
+</p>
+
+## Предупреждение
+
+- ⚠️ Этот проект находится **в очень активной** разработке.
+- ⚠️ Ожидайте ошибок и критических изменение.
+- ⚠️ **Не используйте это приложение для бекапа ваших фото и видео.**
+- ⚠️ Всегда следуйте [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) плану резервного копирования ваших драгоценных фото и видео!
+
+## Содержание
+
+- [Официальная документация](https://immich.app/docs)
+- [План разработки](https://github.com/orgs/immich-app/projects/1)
+- [Демо](#demo)
+- [Возможности](#features)
+- [Введение](https://immich.app/docs/overview/introduction)
+- [Инсталяция](https://immich.app/docs/install/requirements)
+- [Гайд по доработке проекта](https://immich.app/docs/overview/support-the-project)
+- [Поддержки проект](#support-the-project)
+
+## Документация
+
+Вы можете найти основную документация, включая инструкции по установке по ссылке https://immich.app/.
+
+## Демо
+
+Вы можете посмотреть  веб демо по ссылке https://demo.immich.app
+
+Для мобильного приложения вы можете использовать адрес `https://demo.immich.app/api` в поле `Server Endpoint URL`
+
+```bash title="Демо доступ"
+Реквизиты доступа
+логин/почта: demo@immich.app
+пароль: demo
+```
+
+```
+Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
+```
+
+## Возможности
+
+| Возможности                                         | Приложение | Веб |
+| --------------------------------------------------- | ---------- | --- |
+| Выгрузка на сервер и просмотр видео и фото          | Да         | Да  |
+| Авто бекап когда приложение открыто                 | Да         | Н/Д |
+| Выбор альбома(ов) для бекапа                        | Да         | Н/Д |
+| загрузка с сервера фото и видео на устройство       | Да         | Да  |
+| Поддержка нескольких пользователей                  | Да         | Да  |
+| Альбомы и общие альбомы                             | Да         | Да  |
+| Прокручиваемая/перетаскиваемая полоса прокрутки     | Да         | Да  |
+| Поддержка формата RAW                               | Да         | Да  |
+| Просмотр метаданных (EXIF, map)                     | Да         | Да  |
+| Поиск до метаданным, объектам, лицам и CLIP         | Да         | Да  |
+| Административные функци (управление пользователями) | Нет        | Да  |
+| Фоновый бекпа                                       | Да         | Н/Д |
+| Виртуальная прокрутка                               | Да         | Да  |
+| Поддержка OAuth                                     | Да         | Да  |
+| Ключи API                                           | Н/Д        | Да  |
+| LivePhoto/MotionPhoto бекап и воспроизведение       | Да         | Да  |
+| Настраиваемая структура хранилища                   | Да         | Да  |
+| Публичные альбомы                                   | Нет        | Да  |
+| Архив и Избранное                                   | Да         | Да  |
+| Мировая карта                                       | Да         | Да  |
+| Совместное использование                            | Да         | Да  |
+| Распознавание лиц и группировка по лицам            | Да         | Да  |
+| В этот день (x лет назад)                           | Да         | Да  |
+| Работа без интернета                                | Да         | Нет |
+| Галлереи только для просмотра                       | Да         | Да  |
+| Колллажи                                            | Да         | Да  |
+
+## Поддержка проекта
+
+Я посвятил себя этому проекту и не остановлюсь. Я буду продолжать обновлять документацию, добавлять новые функции и исправлять ошибки. Но я не могу сделать это один. Поэтому мне нужна ваша помощь, чтобы дать мне дополнительную мотивацию продолжать идти дальше.
+
+Как сказали наши покровители [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418), это масштабная работа, которую мы с командой делаем. И мне бы очень хотелось когда-нибудь иметь возможность заниматься этим на постоянной основе, и я прошу вашей помощи, чтобы это произошло.
+
+
+Если вы считаете, что это правильная причина и вы уже давно используете это приложение, рассмотрите возможность финансовой поддержки проекта, выбрав вариант ниже.
+
+### Пожертвование
+
+- [Ежемесячное пожертвование](https://github.com/sponsors/immich-app) via GitHub Sponsors
+- [Одноразовое пожертвование](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Librepay](https://liberapay.com/alex.tran1502/)
+- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
+- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
+- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
+
+## Авторы
+<a href="https://github.com/alextran1502/immich/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
+</a>

README_tr_TR.md

@@ -105,8 +105,8 @@ Eğer bu size doğru bir amaç gibi geliyorsa ve uygulamanın uzun bir süre boy
 
 ## Bağış
 
-- [Aylık bağış](https://github.com/sponsors/alextran1502) via GitHub Sponsors
-- [Bir seferlik bağış](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Aylık bağış](https://github.com/sponsors/immich-app) via GitHub Sponsors
+- [Bir seferlik bağış](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_zh_CN.md

@@ -17,7 +17,7 @@
 </p>
 <br/>
 <a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
+<img src="design/immich-screenshots.png" title="界面截图">
 </a>
 <br/>
 
@@ -32,6 +32,7 @@
   <a href="README_de_DE.md">Deutsch</a>
   <a href="README_nl_NL.md">Nederlands</a>
   <a href="README_tr_TR.md">Türkçe</a>
+  <a href="README_ru_RU.md">Русский</a>
 </p>
 
 ## 免责声明
@@ -39,7 +40,7 @@
 - ⚠️ 本项目正在 **非常活跃** 地开发中。
 - ⚠️ 可能存在 bug 或者随时有重大变更。
 - ⚠️ **不要把本软件作为您存储照片或视频的唯一方式。**
-- ⚠️ 为了您宝贵的照片与视频，始终遵守 [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) 备份方案！
+- ⚠️ 为了您宝贵的照片与视频，请始终遵守 [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) 备份方案！
 
 ## 目录
 
@@ -74,47 +75,54 @@
 
 # 功能特性
 
-| 功能特性                                     | 移动端  | 网页端 |
-| ------------------------------------------- | ------- | --- |
-| 上传并查看照片和视频                         | 是     | 是 |
-| 软件运行时自动备份                           | 是     | N/A |
-| 选择需要备份的相册          | 是     | N/A |
-| 下载照片和视频到本地        | 是     | 是 |
-| 多用户支持                          | 是     | 是 |
-| 相册                                       | 是     | 是 |
-| 共享相册                               | 是     | 是 |
-| 可拖动的快速导航栏   | 是     | 是 |
-| 支持RAW格式 (HEIC, HEIF, DNG, Apple ProRaw) | 是     | 是 |
-| 元数据视图（EXIF, 地图）                   | 是     | 是 |
-| 通过元数据、对象和标签进行搜索  | 是     | 是  |
-| 管理功能（用户管理）  | 否     | 是 |
-| 后台备份                         | 是 | N/A |
-| 虚拟滚动                             | 是     | 是 |
-| OAuth 支持                               | 是     | 是 |
-| API Keys|N/A|是|
-| 实况照片备份和查看   | 仅 iOS     | 是 |
-|用户自定义存储结构|是|是|
-|公共分享|否|是|
-|归档与收藏功能|是|是|
-|全局地图|否|是|
-|好友分享|是|是|
-|人像识别与分组|是|是|
-|回忆（那年今日）|是|是|
-|离线支持|是|否|
-|只读相册|是|是|
+| 功能特性                                    | 移动端 | 网页端 |
+|---------------------------------------------|--------|--------|
+| 上传并查看照片和视频                        | 是     | 是     |
+| 软件运行时自动备份                          | 是     | N/A    |
+| 选择需要备份的相册                          | 是     | N/A    |
+| 下载照片和视频到本地                        | 是     | 是     |
+| 多用户支持                                  | 是     | 是     |
+| 相册与共享相册                              | 是     | 是     |
+| 可拖动的快速导航栏                          | 是     | 是     |
+| 支持RAW格式                                 | 是     | 是     |
+| 元数据视图（EXIF、地图）                    | 是     | 是     |
+| 通过元数据、对象、人脸和标签进行搜索        | 是     | 是     |
+| 管理功能（用户管理）                        | 否     | 是     |
+| 后台备份                                    | 是     | N/A    |
+| 虚拟滚动                                    | 是     | 是     |
+| OAuth 支持                                  | 是     | 是     |
+| API Keys                                    | N/A    | 是     |
+| 实况照片备份和查看                          | 是     | 是     |
+| 用户自定义存储结构                          | 是     | 是     |
+| 公共分享                                    | 否     | 是     |
+| 归档与收藏功能                              | 是     | 是     |
+| 足迹地图                                    | 是     | 是     |
+| 好友分享                                    | 是     | 是     |
+| 人脸识别与分组                              | 是     | 是     |
+| 回忆（那年今日）                            | 是     | 是     |
+| 离线支持                                    | 是     | 否     |
+| 只读相册                                    | 是     | 是     |
+| 照片堆叠                                    | 是     | 是     |
+
 
 # 支持本项目
 
-我已经致力于本项目并且将我会持续更新文档、新增功能和修复问题。但是独木不成林，我需要您给予我坚持下去的动力。
+我已经致力于本项目并且我将会持续更新文档、新增功能和修复问题。但是独木不成林，我需要您给予我坚持下去的动力。
 
-就像我在 [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) 节目里说的一样,这是我和团队的一项艰巨任务。并且我希望某一天我能够全职开发本项目，在此我请求您能够助我梦想成真。
+就像我在 [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) 节目里说的一样，这是我和团队的一项艰巨任务。并且我希望某一天我能够全职开发本项目，在此我请求您能够助我梦想成真。
 
 如果您使用了本项目一段时间，并且觉得上面的话有道理，那么请您考虑通过下列任一方式支持我吧。
 
 ## 捐赠
 
-- 通过 GitHub Sponsors [按月捐赠](https://github.com/sponsors/alextran1502)
-- 通过 Github Sponsors [单次捐赠](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
+- 通过 GitHub Sponsors [按月捐赠](https://github.com/sponsors/immich-app)
+- 通过 Github Sponsors [单次捐赠](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - 比特币: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
+- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
+
+## 贡献者
+<a href="https://github.com/alextran1502/immich/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
+</a>

cli/.prettierignore

@@ -5,7 +5,6 @@ node_modules
 .env
 .env.*
 !.env.example
-src/api/open-api
 *.md
 *.json
 coverage

cli/Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/immich-app/base-server-dev:20231109 as test
+FROM ghcr.io/immich-app/base-server-dev:20240130@sha256:a11ac5c56f0ccce1f218954c07c43caadf489557252ba5b9ca1c5977aaa25999 as test
 
 WORKDIR /usr/src/app/server
 COPY server/package.json server/package-lock.json ./
@@ -10,7 +10,7 @@ COPY cli/package.json cli/package-lock.json ./
 RUN npm ci
 COPY ./cli/ .
 
-FROM ghcr.io/immich-app/base-server-prod:20231109
+FROM ghcr.io/immich-app/base-server-prod:20240130@sha256:ce23a32154540b906df3c971766bcd991561c60331794e0ebb780947ac48113f
 
 VOLUME /usr/src/app/upload
 

cli/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@immich/cli",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "Command Line Interface (CLI) for Immich",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
   "bin": {
     "immich": "./dist/src/index.js"
   },
@@ -12,82 +13,46 @@
     "cli"
   ],
   "dependencies": {
-    "axios": "^1.6.2",
+    "@immich/sdk": "file:../open-api/typescript-sdk",
+    "axios": "^1.6.7",
     "byte-size": "^8.1.1",
     "cli-progress": "^3.12.0",
     "commander": "^11.0.0",
     "form-data": "^4.0.0",
     "glob": "^10.3.1",
-    "graceful-fs": "^4.2.11",
     "yaml": "^2.3.1"
   },
   "devDependencies": {
     "@testcontainers/postgresql": "^10.4.0",
     "@types/byte-size": "^8.1.0",
-    "@types/chai": "^4.3.5",
     "@types/cli-progress": "^3.11.0",
-    "@types/jest": "^29.5.2",
-    "@types/js-yaml": "^4.0.5",
-    "@types/mime-types": "^2.1.1",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^20.3.1",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
-    "chai": "^4.3.7",
+    "@vitest/coverage-v8": "^1.2.2",
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-unicorn": "^49.0.0",
+    "eslint-plugin-unicorn": "^50.0.0",
     "immich": "file:../server",
-    "jest": "^29.5.0",
-    "jest-extended": "^4.0.0",
-    "jest-message-util": "^29.5.0",
-    "jest-mock-axios": "^4.7.2",
-    "jest-when": "^3.5.2",
     "mock-fs": "^5.2.0",
-    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^1.2.1"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
     "lint:fix": "npm run lint -- --fix",
     "prepack": "npm run build",
-    "test": "jest",
-    "test:cov": "jest --coverage",
+    "test": "vitest",
+    "test:cov": "vitest --coverage",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "check": "tsc --noEmit",
-    "test:e2e": "NODE_OPTIONS='--experimental-vm-modules' jest --config test/e2e/jest-e2e.json --runInBand"
-  },
-  "jest": {
-    "clearMocks": true,
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": ".",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "<rootDir>/src/**/*.(t|j)s",
-      "!**/open-api/**"
-    ],
-    "moduleNameMapper": {
-      "^@api(|/.*)$": "<rootDir>/src/api/$1",
-      "^@test(|/.*)$": "<rootDir>../server/test/$1",
-      "^@app/immich(|/.*)$": "<rootDir>../server/src/immich/$1",
-      "^@app/infra(|/.*)$": "<rootDir>../server/src/infra/$1",
-      "^@app/domain(|/.*)$": "<rootDir>../server/src/domain/$1"
-    },
-    "coverageDirectory": "./coverage",
-    "testEnvironment": "node"
+    "test:e2e": "vitest --config test/e2e/vitest.config.ts"
   },
   "repository": {
     "type": "git",

cli/src/api/open-api/.openapi-generator/VERSION

@@ -1 +0,0 @@
-6.5.0

cli/src/api/open-api/base.ts

@@ -1,72 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Immich
- * Immich API
- *
- * The version of the OpenAPI document: 1.91.4
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import type { Configuration } from './configuration';
-// Some imports not used depending on template conditions
-// @ts-ignore
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import globalAxios from 'axios';
-
-export const BASE_PATH = "/api".replace(/\/+$/, "");
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: AxiosRequestConfig;
-}
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPI {
-    protected configuration: Configuration | undefined;
-
-    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = configuration.basePath || this.basePath;
-        }
-    }
-};
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-    constructor(public field: string, msg?: string) {
-        super(msg);
-        this.name = "RequiredError"
-    }
-}

cli/src/cli/base-command.ts

@@ -1,33 +0,0 @@
-import { ImmichApi } from '../api/client';
-import { SessionService } from '../services/session.service';
-import { LoginError } from '../cores/errors/login-error';
-import { exit } from 'node:process';
-import { ServerVersionResponseDto, UserResponseDto } from 'src/api/open-api';
-import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
-
-export abstract class BaseCommand {
-  protected sessionService!: SessionService;
-  protected immichApi!: ImmichApi;
-  protected user!: UserResponseDto;
-  protected serverVersion!: ServerVersionResponseDto;
-
-  constructor(options: BaseOptionsDto) {
-    if (!options.config) {
-      throw new Error('Config directory is required');
-    }
-    this.sessionService = new SessionService(options.config);
-  }
-
-  public async connect(): Promise<void> {
-    try {
-      this.immichApi = await this.sessionService.connect();
-    } catch (error) {
-      if (error instanceof LoginError) {
-        console.log(error.message);
-        exit(1);
-      } else {
-        throw error;
-      }
-    }
-  }
-}

cli/src/commands/base-command.ts

@@ -0,0 +1,21 @@
+import { ServerVersionResponseDto, UserResponseDto } from '@immich/sdk';
+import { ImmichApi } from '../services/api.service';
+import { SessionService } from '../services/session.service';
+
+export abstract class BaseCommand {
+  protected sessionService!: SessionService;
+  protected immichApi!: ImmichApi;
+  protected user!: UserResponseDto;
+  protected serverVersion!: ServerVersionResponseDto;
+
+  constructor(options: { config?: string }) {
+    if (!options.config) {
+      throw new Error('Config directory is required');
+    }
+    this.sessionService = new SessionService(options.config);
+  }
+
+  public async connect(): Promise<void> {
+    this.immichApi = await this.sessionService.connect();
+  }
+}

cli/src/commands/login.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from './base-command';
+
+export class LoginCommand extends BaseCommand {
+  public async run(instanceUrl: string, apiKey: string): Promise<void> {
+    await this.sessionService.login(instanceUrl, apiKey);
+  }
+}

cli/src/commands/login/key.ts

@@ -1,9 +0,0 @@
-import { BaseCommand } from '../../cli/base-command';
-
-export default class LoginKey extends BaseCommand {
-  public async run(instanceUrl: string, apiKey: string): Promise<void> {
-    console.log('Executing API key auth flow...');
-
-    await this.sessionService.keyLogin(instanceUrl, apiKey);
-  }
-}

cli/src/commands/logout.command.ts

@@ -0,0 +1,8 @@
+import { BaseCommand } from './base-command';
+
+export class LogoutCommand extends BaseCommand {
+  public static readonly description = 'Logout and remove persisted credentials';
+  public async run(): Promise<void> {
+    await this.sessionService.logout();
+  }
+}

cli/src/commands/logout.ts

@@ -1,13 +0,0 @@
-import { BaseCommand } from '../cli/base-command';
-
-export default class Logout extends BaseCommand {
-  public static readonly description = 'Logout and remove persisted credentials';
-
-  public async run(): Promise<void> {
-    console.log('Executing logout flow...');
-
-    await this.sessionService.logout();
-
-    console.log('Successfully logged out');
-  }
-}

cli/src/commands/server-info.command.ts

@@ -0,0 +1,17 @@
+import { BaseCommand } from './base-command';
+
+export class ServerInfoCommand extends BaseCommand {
+  public async run() {
+    await this.connect();
+    const { data: versionInfo } = await this.immichApi.serverInfoApi.getServerVersion();
+    const { data: mediaTypes } = await this.immichApi.serverInfoApi.getSupportedMediaTypes();
+    const { data: statistics } = await this.immichApi.assetApi.getAssetStatistics();
+
+    console.log(`Server Version: ${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`);
+    console.log(`Image Types: ${mediaTypes.image.map((extension) => extension.replace('.', ''))}`);
+    console.log(`Video Types: ${mediaTypes.video.map((extension) => extension.replace('.', ''))}`);
+    console.log(
+      `Statistics:\n  Images: ${statistics.images}\n  Videos: ${statistics.videos}\n  Total: ${statistics.total}`,
+    );
+  }
+}

cli/src/commands/server-info.ts

@@ -1,19 +0,0 @@
-import { BaseCommand } from '../cli/base-command';
-
-export default class ServerInfo extends BaseCommand {
-  public async run() {
-    await this.connect();
-    const { data: versionInfo } = await this.immichApi.serverInfoApi.getServerVersion();
-
-    console.log(`Server is running version ${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`);
-
-    const { data: supportedmedia } = await this.immichApi.serverInfoApi.getSupportedMediaTypes();
-
-    console.log(`Supported image types: ${supportedmedia.image.map((extension) => extension.replace('.', ''))}`);
-
-    console.log(`Supported video types: ${supportedmedia.video.map((extension) => extension.replace('.', ''))}`);
-
-    const { data: statistics } = await this.immichApi.assetApi.getAssetStatistics();
-    console.log(`Images: ${statistics.images}, Videos: ${statistics.videos}, Total: ${statistics.total}`);
-  }
-}

cli/src/commands/upload.command.ts

@@ -1,15 +1,112 @@
-import { Asset } from '../cores/models/asset';
-import { CrawlService } from '../services';
-import { UploadOptionsDto } from '../cores/dto/upload-options-dto';
-import { CrawlOptionsDto } from '../cores/dto/crawl-options-dto';
-import fs from 'node:fs';
-import cliProgress from 'cli-progress';
+import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
 import byteSize from 'byte-size';
-import { BaseCommand } from '../cli/base-command';
-import axios, { AxiosRequestConfig } from 'axios';
+import cliProgress from 'cli-progress';
 import FormData from 'form-data';
+import fs, { ReadStream, createReadStream } from 'node:fs';
+import { CrawlService } from '../services/crawl.service';
+import { BaseCommand } from './base-command';
+import { basename } from 'node:path';
+import { access, constants, stat, unlink } from 'node:fs/promises';
+import { createHash } from 'node:crypto';
+import Os from 'os';
 
-export default class Upload extends BaseCommand {
+class Asset {
+  readonly path: string;
+  readonly deviceId!: string;
+
+  deviceAssetId?: string;
+  fileCreatedAt?: string;
+  fileModifiedAt?: string;
+  sidecarPath?: string;
+  fileSize!: number;
+  albumName?: string;
+
+  constructor(path: string) {
+    this.path = path;
+  }
+
+  async prepare() {
+    const stats = await stat(this.path);
+    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
+    this.fileCreatedAt = stats.mtime.toISOString();
+    this.fileModifiedAt = stats.mtime.toISOString();
+    this.fileSize = stats.size;
+    this.albumName = this.extractAlbumName();
+  }
+
+  async getUploadFormData(): Promise<FormData> {
+    if (!this.deviceAssetId) throw new Error('Device asset id not set');
+    if (!this.fileCreatedAt) throw new Error('File created at not set');
+    if (!this.fileModifiedAt) throw new Error('File modified at not set');
+
+    // TODO: doesn't xmp replace the file extension? Will need investigation
+    const sideCarPath = `${this.path}.xmp`;
+    let sidecarData: ReadStream | undefined = undefined;
+    try {
+      await access(sideCarPath, constants.R_OK);
+      sidecarData = createReadStream(sideCarPath);
+    } catch (error) {}
+
+    const data: any = {
+      assetData: createReadStream(this.path),
+      deviceAssetId: this.deviceAssetId,
+      deviceId: 'CLI',
+      fileCreatedAt: this.fileCreatedAt,
+      fileModifiedAt: this.fileModifiedAt,
+      isFavorite: String(false),
+    };
+    const formData = new FormData();
+
+    for (const prop in data) {
+      formData.append(prop, data[prop]);
+    }
+
+    if (sidecarData) {
+      formData.append('sidecarData', sidecarData);
+    }
+
+    return formData;
+  }
+
+  async delete(): Promise<void> {
+    return unlink(this.path);
+  }
+
+  public async hash(): Promise<string> {
+    const sha1 = (filePath: string) => {
+      const hash = createHash('sha1');
+      return new Promise<string>((resolve, reject) => {
+        const rs = createReadStream(filePath);
+        rs.on('error', reject);
+        rs.on('data', (chunk) => hash.update(chunk));
+        rs.on('end', () => resolve(hash.digest('hex')));
+      });
+    };
+
+    return await sha1(this.path);
+  }
+
+  private extractAlbumName(): string {
+    if (Os.platform() === 'win32') {
+      return this.path.split('\\').slice(-2)[0];
+    } else {
+      return this.path.split('/').slice(-2)[0];
+    }
+  }
+}
+
+export class UploadOptionsDto {
+  recursive? = false;
+  exclusionPatterns?: string[] = [];
+  dryRun? = false;
+  skipHash? = false;
+  delete? = false;
+  album? = false;
+  albumName? = '';
+  includeHidden? = false;
+}
+
+export class UploadCommand extends BaseCommand {
   uploadLength!: number;
 
   public async run(paths: string[], options: UploadOptionsDto): Promise<void> {
@@ -18,32 +115,29 @@ export default class Upload extends BaseCommand {
     const formatResponse = await this.immichApi.serverInfoApi.getSupportedMediaTypes();
     const crawlService = new CrawlService(formatResponse.data.image, formatResponse.data.video);
 
-    const crawlOptions = new CrawlOptionsDto();
-    crawlOptions.pathsToCrawl = paths;
-    crawlOptions.recursive = options.recursive;
-    crawlOptions.exclusionPatterns = options.exclusionPatterns;
-    crawlOptions.includeHidden = options.includeHidden;
-
-    const files: string[] = [];
-
+    const inputFiles: string[] = [];
     for (const pathArgument of paths) {
       const fileStat = await fs.promises.lstat(pathArgument);
-
       if (fileStat.isFile()) {
-        files.push(pathArgument);
+        inputFiles.push(pathArgument);
       }
     }
 
-    const crawledFiles: string[] = await crawlService.crawl(crawlOptions);
+    const files: string[] = await crawlService.crawl({
+      pathsToCrawl: paths,
+      recursive: options.recursive,
+      exclusionPatterns: options.exclusionPatterns,
+      includeHidden: options.includeHidden,
+    });
 
-    crawledFiles.push(...files);
+    files.push(...inputFiles);
 
-    if (crawledFiles.length === 0) {
+    if (files.length === 0) {
       console.log('No assets found, exiting');
       return;
     }
 
-    const assetsToUpload = crawledFiles.map((path) => new Asset(path));
+    const assetsToUpload = files.map((path) => new Asset(path));
 
     const uploadProgress = new cliProgress.SingleBar(
       {
@@ -60,7 +154,7 @@ export default class Upload extends BaseCommand {
 
     for (const asset of assetsToUpload) {
       // Compute total size first
-      await asset.process();
+      await asset.prepare();
       totalSize += asset.fileSize;
 
       if (options.albumName) {
@@ -104,9 +198,11 @@ export default class Upload extends BaseCommand {
         if (!skipAsset) {
           if (!options.dryRun) {
             if (!skipUpload) {
-              const formData = asset.getUploadFormData();
+              const formData = await asset.getUploadFormData();
               const res = await this.uploadAsset(formData);
               existingAssetId = res.data.id;
+              uploadCounter++;
+              totalSizeUploaded += asset.fileSize;
             }
 
             if ((options.album || options.albumName) && asset.albumName !== undefined) {
@@ -127,9 +223,6 @@ export default class Upload extends BaseCommand {
               }
             }
           }
-
-          totalSizeUploaded += asset.fileSize;
-          uploadCounter++;
         }
 
         sizeSoFar += asset.fileSize;
@@ -158,7 +251,7 @@ export default class Upload extends BaseCommand {
       } else {
         console.log('Deleting assets that have been uploaded...');
         const deletionProgress = new cliProgress.SingleBar(cliProgress.Presets.shades_classic);
-        deletionProgress.start(crawledFiles.length, 0);
+        deletionProgress.start(files.length, 0);
 
         for (const asset of assetsToUpload) {
           if (!options.dryRun) {
@@ -172,15 +265,15 @@ export default class Upload extends BaseCommand {
     }
   }
 
-  private async uploadAsset(data: FormData): Promise<axios.AxiosResponse> {
-    const url = this.immichApi.apiConfiguration.instanceUrl + '/asset/upload';
+  private async uploadAsset(data: FormData): Promise<AxiosResponse> {
+    const url = this.immichApi.instanceUrl + '/asset/upload';
 
     const config: AxiosRequestConfig = {
       method: 'post',
       maxRedirects: 0,
       url,
       headers: {
-        'x-api-key': this.immichApi.apiConfiguration.apiKey,
+        'x-api-key': this.immichApi.apiKey,
         ...data.getHeaders(),
       },
       maxContentLength: Infinity,

cli/src/cores/api-configuration.ts

@@ -1,9 +0,0 @@
-export class ApiConfiguration {
-  public readonly instanceUrl!: string;
-  public readonly apiKey!: string;
-
-  constructor(instanceUrl: string, apiKey: string) {
-    this.instanceUrl = instanceUrl;
-    this.apiKey = apiKey;
-  }
-}

cli/src/cores/dto/base-options-dto.ts

@@ -1,3 +0,0 @@
-export class BaseOptionsDto {
-  config?: string;
-}

cli/src/cores/dto/crawl-options-dto.ts

@@ -1,6 +0,0 @@
-export class CrawlOptionsDto {
-  pathsToCrawl!: string[];
-  recursive? = false;
-  includeHidden? = false;
-  exclusionPatterns?: string[];
-}

cli/src/cores/dto/upload-options-dto.ts

@@ -1,10 +0,0 @@
-export class UploadOptionsDto {
-  recursive? = false;
-  exclusionPatterns?: string[] = [];
-  dryRun? = false;
-  skipHash? = false;
-  delete? = false;
-  album? = false;
-  albumName? = '';
-  includeHidden? = false;
-}

cli/src/cores/errors/login-error.ts

@@ -1,9 +0,0 @@
-export class LoginError extends Error {
-  constructor(message: string) {
-    super(message);
-
-    this.name = this.constructor.name;
-
-    Error.captureStackTrace(this, this.constructor);
-  }
-}

cli/src/cores/index.ts

@@ -1 +0,0 @@
-export * from './models';

cli/src/cores/models/asset.ts

@@ -1,98 +0,0 @@
-import * as fs from 'graceful-fs';
-import { basename } from 'node:path';
-import crypto from 'crypto';
-import Os from 'os';
-import FormData from 'form-data';
-
-export class Asset {
-  readonly path: string;
-  readonly deviceId!: string;
-
-  assetData?: fs.ReadStream;
-  deviceAssetId?: string;
-  fileCreatedAt?: string;
-  fileModifiedAt?: string;
-  sidecarData?: fs.ReadStream;
-  sidecarPath?: string;
-  fileSize!: number;
-  albumName?: string;
-
-  constructor(path: string) {
-    this.path = path;
-  }
-
-  async process() {
-    const stats = await fs.promises.stat(this.path);
-    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
-    this.fileCreatedAt = stats.mtime.toISOString();
-    this.fileModifiedAt = stats.mtime.toISOString();
-    this.fileSize = stats.size;
-    this.albumName = this.extractAlbumName();
-
-    this.assetData = this.getReadStream(this.path);
-
-    // TODO: doesn't xmp replace the file extension? Will need investigation
-    const sideCarPath = `${this.path}.xmp`;
-    try {
-      fs.accessSync(sideCarPath, fs.constants.R_OK);
-      this.sidecarData = this.getReadStream(sideCarPath);
-    } catch (error) {}
-  }
-
-  getUploadFormData(): FormData {
-    if (!this.assetData) throw new Error('Asset data not set');
-    if (!this.deviceAssetId) throw new Error('Device asset id not set');
-    if (!this.fileCreatedAt) throw new Error('File created at not set');
-    if (!this.fileModifiedAt) throw new Error('File modified at not set');
-
-    const data: any = {
-      assetData: this.assetData as any,
-      deviceAssetId: this.deviceAssetId,
-      deviceId: 'CLI',
-      fileCreatedAt: this.fileCreatedAt,
-      fileModifiedAt: this.fileModifiedAt,
-      isFavorite: String(false),
-    };
-    const formData = new FormData();
-
-    for (const prop in data) {
-      formData.append(prop, data[prop]);
-    }
-
-    if (this.sidecarData) {
-      formData.append('sidecarData', this.sidecarData);
-    }
-
-    return formData;
-  }
-
-  private getReadStream(path: string): fs.ReadStream {
-    return fs.createReadStream(path);
-  }
-
-  async delete(): Promise<void> {
-    return fs.promises.unlink(this.path);
-  }
-
-  public async hash(): Promise<string> {
-    const sha1 = (filePath: string) => {
-      const hash = crypto.createHash('sha1');
-      return new Promise<string>((resolve, reject) => {
-        const rs = fs.createReadStream(filePath);
-        rs.on('error', reject);
-        rs.on('data', (chunk) => hash.update(chunk));
-        rs.on('end', () => resolve(hash.digest('hex')));
-      });
-    };
-
-    return await sha1(this.path);
-  }
-
-  private extractAlbumName(): string {
-    if (Os.platform() === 'win32') {
-      return this.path.split('\\').slice(-2)[0];
-    } else {
-      return this.path.split('/').slice(-2)[0];
-    }
-  }
-}

cli/src/cores/models/index.ts

@@ -1 +0,0 @@
-export * from './asset';

cli/src/index.ts

@@ -1,14 +1,12 @@
 #! /usr/bin/env node
-
-import { Option, Command } from 'commander';
-import Upload from './commands/upload';
-import ServerInfo from './commands/server-info';
-import LoginKey from './commands/login/key';
-import Logout from './commands/logout';
-import { version } from '../package.json';
-
+import { Command, Option } from 'commander';
 import path from 'node:path';
 import os from 'os';
+import { version } from '../package.json';
+import { LoginCommand } from './commands/login';
+import { LogoutCommand } from './commands/logout.command';
+import { ServerInfoCommand } from './commands/server-info.command';
+import { UploadCommand } from './commands/upload.command';
 
 const userHomeDir = os.homedir();
 const configDir = path.join(userHomeDir, '.config/immich/');
@@ -46,14 +44,14 @@ program
   .argument('[paths...]', 'One or more paths to assets to be uploaded')
   .action(async (paths, options) => {
     options.exclusionPatterns = options.ignore;
-    await new Upload(program.opts()).run(paths, options);
+    await new UploadCommand(program.opts()).run(paths, options);
   });
 
 program
   .command('server-info')
   .description('Display server information')
   .action(async () => {
-    await new ServerInfo(program.opts()).run();
+    await new ServerInfoCommand(program.opts()).run();
   });
 
 program
@@ -62,14 +60,14 @@ program
   .argument('[instanceUrl]')
   .argument('[apiKey]')
   .action(async (paths, options) => {
-    await new LoginKey(program.opts()).run(paths, options);
+    await new LoginCommand(program.opts()).run(paths, options);
   });
 
 program
   .command('logout')
   .description('Remove stored credentials')
   .action(async () => {
-    await new Logout(program.opts()).run();
+    await new LogoutCommand(program.opts()).run();
   });
 
 program.parse(process.argv);

cli/src/services/api.service.ts

@@ -9,8 +9,7 @@ import {
   ServerInfoApi,
   SystemConfigApi,
   UserApi,
-} from './open-api';
-import { ApiConfiguration } from '../cores/api-configuration';
+} from '@immich/sdk';
 import FormData from 'form-data';
 
 export class ImmichApi {
@@ -25,10 +24,11 @@ export class ImmichApi {
   public systemConfigApi: SystemConfigApi;
 
   private readonly config;
-  public readonly apiConfiguration: ApiConfiguration;
 
-  constructor(instanceUrl: string, apiKey: string) {
-    this.apiConfiguration = new ApiConfiguration(instanceUrl, apiKey);
+  constructor(
+    public instanceUrl: string,
+    public apiKey: string,
+  ) {
     this.config = new Configuration({
       basePath: instanceUrl,
       baseOptions: {
@@ -49,4 +49,9 @@ export class ImmichApi {
     this.keyApi = new APIKeyApi(this.config);
     this.systemConfigApi = new SystemConfigApi(this.config);
   }
+
+  setApiKey(apiKey: string) {
+    this.apiKey = apiKey;
+    this.config.baseOptions.headers['x-api-key'] = apiKey;
+  }
 }

cli/src/services/crawl.service.spec.ts

@@ -1,10 +1,9 @@
 import mockfs from 'mock-fs';
-import { CrawlOptionsDto } from 'src/cores/dto/crawl-options-dto';
-import { CrawlService } from '.';
+import { CrawlService, CrawlOptions } from './crawl.service';
 
 interface Test {
   test: string;
-  options: CrawlOptionsDto;
+  options: CrawlOptions;
   files: Record<string, boolean>;
 }
 
@@ -198,6 +197,58 @@ const tests: Test[] = [
       [`/photos/3.jpg`]: false,
     },
   },
+  {
+    test: 'should support ignoring full filename',
+    options: {
+      pathsToCrawl: ['/photos'],
+      exclusionPatterns: ['**/image2.jpg'],
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image2.jpg': false,
+      '/photos/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring file extensions',
+    options: {
+      pathsToCrawl: ['/photos'],
+      exclusionPatterns: ['**/*.png'],
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image2.png': false,
+      '/photos/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring folder names',
+    options: {
+      pathsToCrawl: ['/photos'],
+      recursive: true,
+      exclusionPatterns: ['**/raw/**'],
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image/image1.jpg': true,
+      '/photos/raw/image2.dng': false,
+      '/photos/raw/image3.dng': false,
+      '/photos/notraw/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring absolute paths',
+    options: {
+      pathsToCrawl: ['/'],
+      recursive: true,
+      exclusionPatterns: ['/images/**'],
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/images/image2.jpg': false,
+      '/assets/image3.jpg': true,
+    },
+  },
 ];
 
 describe(CrawlService.name, () => {

cli/src/services/crawl.service.ts

@@ -1,7 +1,13 @@
-import { CrawlOptionsDto } from 'src/cores/dto/crawl-options-dto';
 import { glob } from 'glob';
 import * as fs from 'fs';
 
+export class CrawlOptions {
+  pathsToCrawl!: string[];
+  recursive? = false;
+  includeHidden? = false;
+  exclusionPatterns?: string[];
+}
+
 export class CrawlService {
   private readonly extensions!: string[];
 
@@ -9,8 +15,9 @@ export class CrawlService {
     this.extensions = image.concat(video).map((extension) => extension.replace('.', ''));
   }
 
-  async crawl(crawlOptions: CrawlOptionsDto): Promise<string[]> {
-    const { pathsToCrawl, exclusionPatterns, includeHidden } = crawlOptions;
+  async crawl(options: CrawlOptions): Promise<string[]> {
+    const { recursive, pathsToCrawl, exclusionPatterns, includeHidden } = options;
+
     if (!pathsToCrawl) {
       return Promise.resolve([]);
     }
@@ -44,7 +51,7 @@ export class CrawlService {
       searchPattern = '{' + patterns.join(',') + '}';
     }
 
-    if (crawlOptions.recursive) {
+    if (recursive) {
       searchPattern = searchPattern + '/**/';
     }
 

cli/src/services/index.ts

@@ -1 +0,0 @@
-export * from './crawl.service';

cli/src/services/session.service.spec.ts

@@ -1,7 +1,6 @@
 import { SessionService } from './session.service';
 import fs from 'node:fs';
 import yaml from 'yaml';
-import { LoginError } from '../cores/errors/login-error';
 import {
   TEST_AUTH_FILE,
   TEST_CONFIG_DIR,
@@ -13,29 +12,21 @@ import {
   spyOnConsole,
 } from '../../test/cli-test-utils';
 
-const mockPingServer = jest.fn(() => Promise.resolve({ data: { res: 'pong' } }));
-const mockUserInfo = jest.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
+const mockPingServer = vi.fn(() => Promise.resolve({ data: { res: 'pong' } }));
+const mockUserInfo = vi.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
 
-jest.mock('../api/open-api', () => {
-  return {
-    __esModule: true,
-    ...jest.requireActual('../api/open-api'),
-    UserApi: jest.fn().mockImplementation(() => {
-      return { getMyUserInfo: mockUserInfo };
-    }),
-    ServerInfoApi: jest.fn().mockImplementation(() => {
-      return { pingServer: mockPingServer };
-    }),
-  };
-});
+vi.mock('@immich/sdk', async () => ({
+  ...(await vi.importActual('@immich/sdk')),
+  UserApi: vi.fn().mockImplementation(() => {
+    return { getMyUserInfo: mockUserInfo };
+  }),
+  ServerInfoApi: vi.fn().mockImplementation(() => {
+    return { pingServer: mockPingServer };
+  }),
+}));
 
 describe('SessionService', () => {
   let sessionService: SessionService;
-  let consoleSpy: jest.SpyInstance;
-
-  beforeAll(() => {
-    consoleSpy = spyOnConsole();
-  });
 
   beforeEach(() => {
     deleteAuthFile();
@@ -71,7 +62,6 @@ describe('SessionService', () => {
       }),
     );
     await sessionService.connect().catch((error) => {
-      expect(error).toBeInstanceOf(LoginError);
       expect(error.message).toEqual(`Instance URL missing in auth config file ${TEST_AUTH_FILE}`);
     });
   });
@@ -83,13 +73,11 @@ describe('SessionService', () => {
       }),
     );
 
-    await expect(sessionService.connect()).rejects.toThrow(
-      new LoginError(`API key missing in auth config file ${TEST_AUTH_FILE}`),
-    );
+    await expect(sessionService.connect()).rejects.toThrow(`API key missing in auth config file ${TEST_AUTH_FILE}`);
   });
 
   it('should create auth file when logged in', async () => {
-    await sessionService.keyLogin(TEST_IMMICH_INSTANCE_URL, TEST_IMMICH_API_KEY);
+    await sessionService.login(TEST_IMMICH_INSTANCE_URL, TEST_IMMICH_API_KEY);
 
     const data: string = await readTestAuthFile();
     const authConfig = yaml.parse(data);
@@ -98,6 +86,8 @@ describe('SessionService', () => {
   });
 
   it('should delete auth file when logging out', async () => {
+    const consoleSpy = spyOnConsole();
+
     await createTestAuthFile(
       JSON.stringify({
         apiKey: TEST_IMMICH_API_KEY,
@@ -110,6 +100,10 @@ describe('SessionService', () => {
       expect(error.message).toContain('ENOENT');
     });
 
-    expect(consoleSpy.mock.calls).toEqual([[`Removed auth file ${TEST_AUTH_FILE}`]]);
+    expect(consoleSpy.mock.calls).toEqual([
+      ['Logging out...'],
+      [`Removed auth file ${TEST_AUTH_FILE}`],
+      ['Successfully logged out'],
+    ]);
   });
 });

cli/src/services/session.service.ts

@@ -1,31 +1,40 @@
-import fs from 'node:fs';
-import yaml from 'yaml';
+import { existsSync } from 'fs';
+import { access, constants, mkdir, readFile, unlink, writeFile } from 'node:fs/promises';
 import path from 'node:path';
-import { ImmichApi } from '../api/client';
-import { LoginError } from '../cores/errors/login-error';
+import yaml from 'yaml';
+import { ImmichApi } from './api.service';
+
+class LoginError extends Error {
+  constructor(message: string) {
+    super(message);
+
+    this.name = this.constructor.name;
+
+    Error.captureStackTrace(this, this.constructor);
+  }
+}
 
 export class SessionService {
   readonly configDir!: string;
   readonly authPath!: string;
-  private api!: ImmichApi;
 
   constructor(configDir: string) {
     this.configDir = configDir;
     this.authPath = path.join(configDir, '/auth.yml');
   }
 
-  public async connect(): Promise<ImmichApi> {
+  async connect(): Promise<ImmichApi> {
     let instanceUrl = process.env.IMMICH_INSTANCE_URL;
     let apiKey = process.env.IMMICH_API_KEY;
 
     if (!instanceUrl || !apiKey) {
-      await fs.promises.access(this.authPath, fs.constants.F_OK).catch((error) => {
+      await access(this.authPath, constants.F_OK).catch((error) => {
         if (error.code === 'ENOENT') {
           throw new LoginError('No auth file exist. Please login first');
         }
       });
 
-      const data: string = await fs.promises.readFile(this.authPath, 'utf8');
+      const data: string = await readFile(this.authPath, 'utf8');
       const parsedConfig = yaml.parse(data);
 
       instanceUrl = parsedConfig.instanceUrl;
@@ -40,51 +49,54 @@ export class SessionService {
       }
     }
 
-    this.api = new ImmichApi(instanceUrl, apiKey);
+    const api = new ImmichApi(instanceUrl, apiKey);
 
-    await this.ping();
+    const { data: pingResponse } = await api.serverInfoApi.pingServer().catch((error) => {
+      throw new Error(`Failed to connect to server ${api.instanceUrl}: ${error.message}`);
+    });
 
-    return this.api;
+    if (pingResponse.res !== 'pong') {
+      throw new Error(`Could not parse response. Is Immich listening on ${api.instanceUrl}?`);
+    }
+
+    return api;
   }
 
-  public async keyLogin(instanceUrl: string, apiKey: string): Promise<ImmichApi> {
-    this.api = new ImmichApi(instanceUrl, apiKey);
+  async login(instanceUrl: string, apiKey: string): Promise<ImmichApi> {
+    console.log('Logging in...');
+
+    const api = new ImmichApi(instanceUrl, apiKey);
 
     // Check if server and api key are valid
-    const { data: userInfo } = await this.api.userApi.getMyUserInfo().catch((error) => {
+    const { data: userInfo } = await api.userApi.getMyUserInfo().catch((error) => {
       throw new LoginError(`Failed to connect to server ${instanceUrl}: ${error.message}`);
     });
 
     console.log(`Logged in as ${userInfo.email}`);
 
-    if (!fs.existsSync(this.configDir)) {
+    if (!existsSync(this.configDir)) {
       // Create config folder if it doesn't exist
-      const created = await fs.promises.mkdir(this.configDir, { recursive: true });
+      const created = await mkdir(this.configDir, { recursive: true });
       if (!created) {
         throw new Error(`Failed to create config folder ${this.configDir}`);
       }
     }
 
-    fs.writeFileSync(this.authPath, yaml.stringify({ instanceUrl, apiKey }));
+    await writeFile(this.authPath, yaml.stringify({ instanceUrl, apiKey }));
 
     console.log('Wrote auth info to ' + this.authPath);
-    return this.api;
+
+    return api;
   }
 
-  public async logout(): Promise<void> {
-    if (fs.existsSync(this.authPath)) {
-      fs.unlinkSync(this.authPath);
+  async logout(): Promise<void> {
+    console.log('Logging out...');
+
+    if (existsSync(this.authPath)) {
+      await unlink(this.authPath);
       console.log('Removed auth file ' + this.authPath);
     }
-  }
 
-  private async ping(): Promise<void> {
-    const { data: pingResponse } = await this.api.serverInfoApi.pingServer().catch((error) => {
-      throw new Error(`Failed to connect to server ${this.api.apiConfiguration.instanceUrl}: ${error.message}`);
-    });
-
-    if (pingResponse.res !== 'pong') {
-      throw new Error(`Could not parse response. Is Immich listening on ${this.api.apiConfiguration.instanceUrl}?`);
-    }
+    console.log('Successfully logged out');
   }
 }

cli/src/version.ts

@@ -1,12 +1,12 @@
 import pkg from '../package.json';
 
-export interface ICLIVersion {
+export interface ICliVersion {
   major: number;
   minor: number;
   patch: number;
 }
 
-export class CLIVersion implements ICLIVersion {
+export class CliVersion implements ICliVersion {
   constructor(
     public readonly major: number,
     public readonly minor: number,
@@ -22,16 +22,16 @@ export class CLIVersion implements ICLIVersion {
     return { major, minor, patch };
   }
 
-  static fromString(version: string): CLIVersion {
+  static fromString(version: string): CliVersion {
     const regex = /(?:v)?(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/i;
     const matchResult = version.match(regex);
     if (matchResult) {
       const [, major, minor, patch] = matchResult.map(Number);
-      return new CLIVersion(major, minor, patch);
+      return new CliVersion(major, minor, patch);
     } else {
       throw new Error(`Invalid version format: ${version}`);
     }
   }
 }
 
-export const cliVersion = CLIVersion.fromString(pkg.version);
+export const cliVersion = CliVersion.fromString(pkg.version);

cli/test/cli-test-utils.ts

@@ -1,15 +1,33 @@
-import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
 import fs from 'node:fs';
 import path from 'node:path';
+import { ImmichApi } from '../src/services/api.service';
 
 export const TEST_CONFIG_DIR = '/tmp/immich/';
 export const TEST_AUTH_FILE = path.join(TEST_CONFIG_DIR, 'auth.yml');
 export const TEST_IMMICH_INSTANCE_URL = 'https://test/api';
 export const TEST_IMMICH_API_KEY = 'pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg';
 
-export const CLI_BASE_OPTIONS: BaseOptionsDto = { config: TEST_CONFIG_DIR };
+export const CLI_BASE_OPTIONS = { config: TEST_CONFIG_DIR };
 
-export const spyOnConsole = () => jest.spyOn(console, 'log').mockImplementation();
+export const setup = async () => {
+  const api = new ImmichApi(process.env.IMMICH_INSTANCE_URL as string, '');
+  await api.authenticationApi.signUpAdmin({
+    signUpDto: { email: 'cli@immich.app', password: 'password', name: 'Administrator' },
+  });
+  const { data: admin } = await api.authenticationApi.login({
+    loginCredentialDto: { email: 'cli@immich.app', password: 'password' },
+  });
+  const { data: apiKey } = await api.keyApi.createApiKey(
+    { aPIKeyCreateDto: { name: 'CLI Test' } },
+    { headers: { Authorization: `Bearer ${admin.accessToken}` } },
+  );
+
+  api.setApiKey(apiKey.secret);
+
+  return api;
+};
+
+export const spyOnConsole = () => vi.spyOn(console, 'log').mockImplementation(() => {});
 
 export const createTestAuthFile = async (contents: string) => {
   if (!fs.existsSync(TEST_CONFIG_DIR)) {

cli/test/e2e/login-key.e2e-spec.ts

@@ -1,20 +1,15 @@
-import { api } from '@test/api';
-import { restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import LoginKey from 'src/commands/login/key';
-import { LoginError } from 'src/cores/errors/login-error';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+import { restoreTempFolder, testApp } from '@test-utils';
+import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
+import { LoginCommand } from '../../src/commands/login';
 
 describe(`login-key (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
+  let apiKey: string;
   let instanceUrl: string;
+
   spyOnConsole();
 
   beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
+    await testApp.create();
     if (!process.env.IMMICH_INSTANCE_URL) {
       throw new Error('IMMICH_INSTANCE_URL environment variable not set');
     } else {
@@ -30,19 +25,18 @@ describe(`login-key (e2e)`, () => {
   beforeEach(async () => {
     await testApp.reset();
     await restoreTempFolder();
-    await api.authApi.adminSignUp(server);
-    admin = await api.authApi.adminLogin(server);
-    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
-    process.env.IMMICH_API_KEY = apiKey.secret;
+
+    const api = await setup();
+    apiKey = api.apiKey;
   });
 
   it('should error when providing an invalid API key', async () => {
-    await expect(async () => await new LoginKey(CLI_BASE_OPTIONS).run(instanceUrl, 'invalid')).rejects.toThrow(
-      new LoginError(`Failed to connect to server ${instanceUrl}: Request failed with status code 401`),
+    await expect(new LoginCommand(CLI_BASE_OPTIONS).run(instanceUrl, 'invalid')).rejects.toThrow(
+      `Failed to connect to server ${instanceUrl}: Request failed with status code 401`,
     );
   });
 
   it('should log in when providing the correct API key', async () => {
-    await new LoginKey(CLI_BASE_OPTIONS).run(instanceUrl, apiKey.secret);
+    await new LoginCommand(CLI_BASE_OPTIONS).run(instanceUrl, apiKey);
   });
 });

cli/test/e2e/server-info.e2e-spec.ts

@@ -1,18 +1,12 @@
-import { api } from '@test/api';
-import { restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import ServerInfo from 'src/commands/server-info';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+import { restoreTempFolder, testApp } from '@test-utils';
+import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
+import { ServerInfoCommand } from '../../src/commands/server-info.command';
 
 describe(`server-info (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
   const consoleSpy = spyOnConsole();
 
   beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
+    await testApp.create();
   });
 
   afterAll(async () => {
@@ -23,20 +17,18 @@ describe(`server-info (e2e)`, () => {
   beforeEach(async () => {
     await testApp.reset();
     await restoreTempFolder();
-    await api.authApi.adminSignUp(server);
-    admin = await api.authApi.adminLogin(server);
-    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
-    process.env.IMMICH_API_KEY = apiKey.secret;
+    const api = await setup();
+    process.env.IMMICH_API_KEY = api.apiKey;
   });
 
   it('should show server version', async () => {
-    await new ServerInfo(CLI_BASE_OPTIONS).run();
+    await new ServerInfoCommand(CLI_BASE_OPTIONS).run();
 
     expect(consoleSpy.mock.calls).toEqual([
-      [expect.stringMatching(new RegExp('Server is running version \\d+.\\d+.\\d+'))],
-      [expect.stringMatching('Supported image types: .*')],
-      [expect.stringMatching('Supported video types: .*')],
-      ['Images: 0, Videos: 0, Total: 0'],
+      [expect.stringMatching(new RegExp('Server Version: \\d+.\\d+.\\d+'))],
+      [expect.stringMatching('Image Types: .*')],
+      [expect.stringMatching('Video Types: .*')],
+      ['Statistics:\n  Images: 0\n  Videos: 0\n  Total: 0'],
     ]);
   });
 });

cli/test/e2e/setup.ts

@@ -37,7 +37,6 @@ export default async () => {
   }
 
   process.env.NODE_ENV = 'development';
-  process.env.IMMICH_TEST_ENV = 'true';
-  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/test/e2e/immich-e2e-config.json`);
+  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/e2e/jobs/immich-e2e-config.json`);
   process.env.TZ = 'Z';
 };

cli/test/e2e/upload.e2e-spec.ts

@@ -1,18 +1,15 @@
-import { api } from '@test/api';
-import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import Upload from 'src/commands/upload';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from '@test-utils';
+import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
+import { UploadCommand } from '../../src/commands/upload.command';
+import { ImmichApi } from '../../src/services/api.service';
 
 describe(`upload (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
+  let api: ImmichApi;
+
   spyOnConsole();
 
   beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
+    await testApp.create();
   });
 
   afterAll(async () => {
@@ -23,60 +20,58 @@ describe(`upload (e2e)`, () => {
   beforeEach(async () => {
     await testApp.reset();
     await restoreTempFolder();
-    await api.authApi.adminSignUp(server);
-    admin = await api.authApi.adminLogin(server);
-    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
-    process.env.IMMICH_API_KEY = apiKey.secret;
+    api = await setup();
+    process.env.IMMICH_API_KEY = api.apiKey;
   });
 
   it('should upload a folder recursively', async () => {
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
-    const assets = await api.assetApi.getAllAssets(server, admin.accessToken);
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
+    const { data: assets } = await api.assetApi.getAllAssets({}, { headers: { 'x-api-key': api.apiKey } });
     expect(assets.length).toBeGreaterThan(4);
   });
 
   it('should not create a new album', async () => {
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
+    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
     expect(albums.length).toEqual(0);
   });
 
   it('should create album from folder name', async () => {
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
       recursive: true,
       album: true,
     });
 
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
+    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
     expect(albums.length).toEqual(1);
     const natureAlbum = albums[0];
     expect(natureAlbum.albumName).toEqual('nature');
   });
 
   it('should add existing assets to album', async () => {
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
       recursive: true,
     });
 
-    // Upload again, but this time add to album
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
+    // upload again, but this time add to album
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
       recursive: true,
       album: true,
     });
 
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
+    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
     expect(albums.length).toEqual(1);
     const natureAlbum = albums[0];
     expect(natureAlbum.albumName).toEqual('nature');
   });
 
   it('should upload to the specified album name', async () => {
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
+    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
       recursive: true,
       albumName: 'testAlbum',
     });
 
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
+    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
     expect(albums.length).toEqual(1);
     const testAlbum = albums[0];
     expect(testAlbum.albumName).toEqual('testAlbum');

cli/test/e2e/vitest.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@test-utils': new URL('../../../server/dist/test-utils/utils.js', import.meta.url).pathname,
+    },
+  },
+  test: {
+    include: ['**/*.e2e-spec.ts'],
+    globals: true,
+    globalSetup: 'test/e2e/setup.ts',
+    pool: 'forks',
+    poolOptions: {
+      forks: {
+        maxForks: 1,
+        minForks: 1,
+      },
+    },
+    testTimeout: 10000,
+  },
+});

cli/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "module": "Node16",
+    "module": "esnext",
+    "moduleResolution": "bundler",
     "strict": true,
     "declaration": true,
     "removeComments": true,
@@ -9,7 +10,6 @@
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
     "target": "es2021",
-    "moduleResolution": "node16",
     "sourceMap": true,
     "outDir": "./dist",
     "incremental": true,
@@ -20,13 +20,15 @@
     "paths": {
       "@test": ["../server/test"],
       "@test/*": ["../server/test/*"],
+      "@test-utils": ["../server/src/test-utils/utils"],
       "@app/immich": ["../server/src/immich"],
       "@app/immich/*": ["../server/src/immich/*"],
       "@app/infra": ["../server/src/infra"],
       "@app/infra/*": ["../server/src/infra/*"],
       "@app/domain": ["../server/src/domain"],
       "@app/domain/*": ["../server/src/domain/*"]
-    }
+    },
+    "types": ["vitest/globals"]
   },
   "exclude": ["dist", "node_modules", "upload"]
 }

cli/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+  },
+});

docker/docker-compose.dev.yml

@@ -15,7 +15,9 @@ x-server-build: &server-common
   restart: always
   volumes:
     - ../server:/usr/src/app
+    - ../open-api:/usr/src/open-api
     - ${UPLOAD_LOCATION}/photos:/usr/src/app/upload
+    - ${UPLOAD_LOCATION}/photos/upload:/usr/src/app/upload/upload
     - /usr/src/app/node_modules
     - /etc/localtime:/etc/localtime:ro
   env_file:
@@ -42,8 +44,8 @@ services:
     command: [ "/usr/src/app/bin/immich-dev", "microservices" ]
     <<: *server-common
     # extends:
-    #   file: hwaccel.yml
-    #   service: hwaccel
+    #   file: hwaccel.transcoding.yml
+    #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
     ports:
       - 9231:9230
     depends_on:
@@ -52,11 +54,10 @@ services:
 
   immich-web:
     container_name: immich_web
-    image: immich-web-dev:1.9.0
+    image: immich-web-dev:latest
     build:
       context: ../web
-      dockerfile: Dockerfile
-    command: "node ./node_modules/.bin/vite dev --host 0.0.0.0 --port 3000"
+    command: "/usr/src/app/bin/immich-web"
     env_file:
       - .env
     ports:
@@ -64,6 +65,7 @@ services:
       - 24678:24678
     volumes:
       - ../web:/usr/src/app
+      - ../open-api/:/usr/src/open-api/
       - /usr/src/app/node_modules
     ulimits:
       nofile:
@@ -76,9 +78,14 @@ services:
   immich-machine-learning:
     container_name: immich_machine_learning
     image: immich-machine-learning-dev:latest
+    # extends:
+    #   file: hwaccel.ml.yml
+    #   service: cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference
     build:
       context: ../machine-learning
       dockerfile: Dockerfile
+      args:
+        - DEVICE=cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference
     ports:
       - 3003:3003
     volumes:
@@ -92,7 +99,7 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:afb290a0a0d0b2bd7537b62ebff1eb84d045c757c1c31ca2ca48c79536c0de82
 
   database:
     container_name: immich_postgres

docker/docker-compose.prod.yml

@@ -30,8 +30,8 @@ services:
     command: [ "./start-microservices.sh" ]
     <<: *server-common
     # extends:
-    #   file: hwaccel.yml
-    #   service: hwaccel
+    #   file: hwaccel.transcoding.yml
+    #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
     depends_on:
       - redis
       - database
@@ -40,9 +40,14 @@ services:
   immich-machine-learning:
     container_name: immich_machine_learning
     image: immich-machine-learning:latest
+    # extends:
+    #   file: hwaccel.ml.yml
+    #   service: cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference
     build:
       context: ../machine-learning
       dockerfile: Dockerfile
+      args:
+        - DEVICE=cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference
     volumes:
       - model-cache:/cache
     env_file:
@@ -51,7 +56,7 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:afb290a0a0d0b2bd7537b62ebff1eb84d045c757c1c31ca2ca48c79536c0de82
     restart: always
 
   database:

docker/docker-compose.yml

@@ -30,9 +30,9 @@ services:
   immich-microservices:
     container_name: immich_microservices
     image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
-    # extends:
-    #   file: hwaccel.yml
-    #   service: hwaccel
+    # extends: # uncomment this section for hardware acceleration - see https://immich.app/docs/features/hardware-transcoding
+    #   file: hwaccel.transcoding.yml 
+    #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
     command: [ "start.sh", "microservices" ]
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
@@ -46,7 +46,12 @@ services:
 
   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:
@@ -55,7 +60,7 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:afb290a0a0d0b2bd7537b62ebff1eb84d045c757c1c31ca2ca48c79536c0de82
     restart: always
 
   database:

docker/hwaccel-rkmpp.yml

@@ -1,24 +0,0 @@
-version: "3.8"
-
-# Hardware acceleration for transcoding using RKMPP for Rockchip SOCs
-# This is only needed if you want to use hardware acceleration for transcoding.
-# Supported host OS is Ubuntu Jammy 22.04 with custom ffmpeg from ppa:liujianfeng1994/rockchip-multimedia
-
-services:
-  hwaccel:
-    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
-    volumes:
-      - /usr/bin/ffmpeg:/usr/bin/ffmpeg_mpp:ro
-      - /lib/aarch64-linux-gnu:/lib/ffmpeg-mpp:ro
-      - /lib/aarch64-linux-gnu/libblas.so.3:/lib/ffmpeg-mpp/libblas.so.3:ro # symlink is resolved by mounting
-      - /lib/aarch64-linux-gnu/liblapack.so.3:/lib/ffmpeg-mpp/liblapack.so.3:ro # symlink is resolved by mounting
-      - /lib/aarch64-linux-gnu/pulseaudio/libpulsecommon-15.99.so:/lib/ffmpeg-mpp/libpulsecommon-15.99.so:ro

docker/hwaccel.ml.yml

@@ -0,0 +1,47 @@
+version: "3.8"
+
+# 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
+                - compute
+                - video
+
+  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

docker/hwaccel.transcoding.yml

@@ -0,0 +1,59 @@
+version: "3.8"
+
+# 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
+    volumes:
+      - /usr/bin/ffmpeg:/usr/bin/ffmpeg_mpp:ro
+      - /lib/aarch64-linux-gnu:/lib/ffmpeg-mpp:ro
+      - /lib/aarch64-linux-gnu/libblas.so.3:/lib/ffmpeg-mpp/libblas.so.3:ro # symlink is resolved by mounting
+      - /lib/aarch64-linux-gnu/liblapack.so.3:/lib/ffmpeg-mpp/liblapack.so.3:ro # symlink is resolved by mounting
+      - /lib/aarch64-linux-gnu/pulseaudio/libpulsecommon-15.99.so:/lib/ffmpeg-mpp/libpulsecommon-15.99.so:ro
+
+  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:
+      - LD_LIBRARY_PATH=/usr/lib/wsl/lib
+      - LIBVA_DRIVER_NAME=d3d12

docker/hwaccel.yml

@@ -1,22 +0,0 @@
-version: "3.8"
-
-# Hardware acceleration for transcoding - Optional
-# This is only needed if you want to use hardware acceleration for transcoding.
-# Depending on your hardware, you should uncomment the relevant lines below.
-
-services:
-  hwaccel:
-    # devices:
-    #   - /dev/dri:/dev/dri  # If using Intel QuickSync or VAAPI
-    # volumes:
-    #   - /usr/lib/wsl:/usr/lib/wsl # If using VAAPI in WSL2
-    # environment:
-    #   - LD_LIBRARY_PATH=/usr/lib/wsl/lib # If using VAAPI in WSL2
-    #   - LIBVA_DRIVER_NAME=d3d12 # If using VAAPI in WSL2
-    # deploy: # Uncomment this section if using NVIDIA GPU
-    #   resources:
-    #     reservations:
-    #       devices:
-    #         - driver: nvidia
-    #           count: 1
-    #           capabilities: [gpu,video]

docs/blog/2023/2023-recap.mdx

@@ -2,6 +2,7 @@
 title: Immich Recap 2023
 authors: [alextran]
 tags: [update, recap-2023]
+date: 2023-12-30T00:00
 ---
 
 Hi everyone,

docs/docs/FAQ.md

@@ -1,122 +0,0 @@
----
-sidebar_position: 7
----
-
-# FAQ
-
-### What is the difference between the cloud icon on the mobile app?
-
-| Icon                               | Description                                                                                                                                     |
-| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| ![cloud](/img/cloud.svg)           | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload |
-| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up                                                                                  |
-| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device                      |
-
-### Can I add my existing photo library?
-
-Yes, with an [external library](/docs/features/libraries.md).
-
-### Why are only photos and not videos being uploaded to Immich?
-
-This often happens when using a reverse proxy or cloudflare tunnel in front of Immich. Make sure to set your reverse proxy to allow large POST requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Cloudflare tunnels are limited to 100 mb file sizes. Also check the disk space of your reverse proxy, in some cases proxies caches requests to disk before passing them on, and if disk space runs out the request fails.
-
-### Why is Immich slow on low-memory systems like the Raspberry Pi?
-
-Immich optionally uses machine learning for several features. However, it can be too heavy to run on a Raspberry Pi. You can [mitigate](/docs/FAQ#how-can-i-lower-immichs-cpu-usage) this or [disable](/docs/FAQ.md#how-can-i-disable-machine-learning) machine learning entirely.
-
-### How can I lower Immich's CPU usage?
-
-The initial backup is the most intensive due to the number of jobs running. The most CPU-intensive ones are transcoding and machine learning jobs (Tag Images, Smart Search, Recognize Faces), and to a lesser extent thumbnail generation. Here are some ways to lower their CPU usage:
-
-- Lower the job concurrency for these jobs to 1.
-- Under Settings > Transcoding Settings > Threads, set the number of threads to a low number like 1 or 2.
-- Under Settings > Machine Learning Settings > Facial Recognition > Model Name, you can change the facial recognition model to `buffalo_s` instead of `buffalo_l`. The former is a smaller and faster model, albeit not as good.
-  - You _must_ re-run the Recognize Faces job for all images after this for facial recognition on new images to work properly.
-- If these changes are not enough, see [below](/docs/FAQ.md#how-can-i-disable-machine-learning) for how you can disable machine learning.
-
-### How can I disable machine learning?
-
-:::info
-Disabling machine learning will result in a poor experience for searching and the 'Explore' page, as these are reliant on it to work as intended.
-:::
-
-Machine learning can be disabled under Settings > Machine Learning Settings, either entirely or by model type. For instance, you can choose to disable smart search with CLIP, but keep facial recognition enabled. This means that the machine learning service will only process the enabled jobs.
-
-However, disabling all jobs will not disable the machine learning service itself. To prevent it from starting up at all in this case, you can comment out the `immich-machine-learning` section of the docker-compose.yml.
-
-### I'm getting errors about models being corrupt or failing to download. What do I do?
-
-You can delete the model cache volume, which is where models are downloaded. This will give the service a clean environment to download the model again.
-
-### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
-
-Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
-
-### In the uploads folder, why are photos stored in the wrong date?
-
-This is fixed by running the storage migration job.
-
-### Why are there so many thumbnail generation jobs?
-
-Immich generates three thumbnails for each asset (blurred, small, and large), as well as a thumbnail for each recognized face.
-
-### How can I see Immich logs?
-
-Most Immich components are typically deployed using docker. To see logs for deployed docker containers, you can use the [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli/), specifically the `docker logs` command. For examples, see [Docker Help](/docs/guides/docker-help.md)
-
-### How can I run Immich as a non-root user?
-
-1. Set the `PUID`/`PGID` environment variables (in `.env`).
-2. Set the corresponding `user` argument in `docker-compose` for each service.
-3. Add an additional volume to `immich-microservices` that mounts internally to `/usr/src/app/.reverse-geocoding-dump`.
-
-The non-root user/group needs read/write access to the volume mounts, including `UPLOAD_LOCATION`.
-
-### How can I reset the admin password?
-
-The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.
-
-### How can I backup data from Immich?
-
-See [backup and restore](/docs/administration/backup-and-restore.md).
-
-### How can I **purge** data from Immich?
-
-Data for Immich comes in two forms:
-
-1. **Metadata** stored in a postgres database, persisted via the `pg_data` volume
-2. **Files** (originals, thumbs, profile, etc.), stored in the `UPLOAD_LOCATION` folder.
-
-To remove the **Metadata** you can stop Immich and delete the volume.
-
-```bash title="Remove Immich (containers and volumes)"
-docker-compose down -v
-```
-
-After removing the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting an unwanted files or folders.
-
-### How can I move all data (photos, persons, albums) from one user to another?
-
-This requires some database queries. You can do this on the command line (in the PostgreSQL container using the psql command), or you can add for example an [Adminer](https://www.adminer.org/) container to the `docker-compose.yml` file, so that you can use a web-interface.
-
-:::warning
-This is an advanced operation. If you can't to do it with the steps described here, this is not for you.
-:::
-
-1. **MAKE A BACKUP** - See [backup and restore](/docs/administration/backup-and-restore.md).
-2. Find the id of both the 'source' and the 'destination' user (it's the id column in the users table)
-3. Three tables need to be updated:
-
-   ```sql
-   // reassign albums
-   update albums set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>';
-
-   // reassign people
-   update person set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>';
-
-   // reassign assets
-   update assets set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>'
-    and checksum not in (select checksum from assets where "ownerId" = '<destinationId>');
-   ```
-
-4. There might be left-over assets in the 'source' user's library if they are skipped by the last query because of duplicate checksums. These are probably duplicates anyway, and can probably be removed.

docs/docs/FAQ.mdx

@@ -0,0 +1,329 @@
+# FAQ
+
+## User
+
+### How can I reset the admin password?
+
+The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.
+
+### How can I see list of all users in Immich?
+
+You can see the list of all users by running [list-users](/docs/administration/server-commands.md) Command on the Immich-server.
+
+---
+
+## Mobile App
+
+### What is the difference between the cloud icons on the mobile app?
+
+| Icon                               | Description                                                                                                                                     |
+| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| ![cloud](/img/cloud.svg)           | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload |
+| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up                                                                                  |
+| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up to the server; the original file is still on the device                                |
+
+### I cannot log into the application after an update. What can I do?
+
+First, verify that the mobile app and server are both running the same version (major and minor).
+
+:::note
+App store updates sometimes take longer because the stores (play store; Google and app store; Apple)
+need to approve the update first which may take some time.
+:::
+
+If you still cannot login to the app, try the following:
+
+- Check the mobile logs
+- Make sure login credentials are correct by logging in on the web app
+
+---
+
+## Assets
+
+### Can I add my existing photo library?
+
+Yes, with an [External Library](/docs/features/libraries.md).
+
+### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
+
+Template changes will only apply to _new_ assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
+
+### Why are only photos and not videos being uploaded to Immich?
+
+This often happens when using a reverse proxy (such as nginx or Cloudflare tunnel) in front of Immich. Make sure to set your reverse proxy to allow large `POST` requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Also check the disk space of your reverse proxy, in some cases proxies cache requests to disk before passing them on, and if disk space runs out the request fails.
+
+### Why are some photos stored in the file system with the wrong date?
+
+There are a few different scenarios that can lead to this situation. The solution is to simply run the storage migration job again. The job is only _automatically_ run once per asset, after upload. If metadata extraction originally failed, the jobs were cleared/cancelled, etc. the job may not have run automatically the first time.
+
+### How can I hide photos from the timeline?
+
+You can _archive_ them.
+
+### How can I backup data from Immich?
+
+See [Backup and Restore](/docs/administration/backup-and-restore.md).
+
+### Does Immich support reading existing face tag metadata?
+
+No, it currently does not.
+
+### Does Immich support filtering of NSFW images?
+
+No, it currently does not, but there is an [open discussion about it On Github](https://github.com/immich-app/immich/discussions/2451). You can submit a pull request or vote for the discussion.
+
+### Why are there so many thumbnail generation jobs?
+
+There are three thubmanil jobs for each asset:
+
+- Blurred (thumbhash)
+- Small (webp)
+- Large (jpeg)
+
+Also, there are additional jobs for person (face) thumbnails.
+
+### What happens if an asset exists in more than one account?
+
+There are no requirements for assets to be unique across users. If multiple users upload the same image they are processed as if they were distinct assets and jobs run and thumbnails are generated accordingly.
+
+### Why do HDR videos appear pale in Immich player but look normal after download?
+
+Immich uses a player with known HDR color display issues. We are experimenting with a different player that provides better color profiles for HDR content for future improvements.
+
+### How can I delete transcoded videos without deleting the original?
+
+The transcode of an asset can be deleted by setting a transcode policy that makes it unnecessary, then running a transcoding job for that asset. This can be done on a per-asset basis by starting a transcoding job for an asset (with the _Refresh encoded videos_ button in the asset viewer options. Or, for all assets by running transcoding jobs for all assets.
+
+To update the transcode policy, navigate to Administration > Video Transcoding Settings > Transcoding Policy and select a policy from the drop-down. This policy will determine whether an existing transcode will be deleted or overwritten in the transcoding job. If a video should be transcoded according to this policy, an existing transcode is overwritten. If not, then it is deleted.
+
+:::note
+For example, say you have existing transcodes with the policy "Videos higher than normal resolution or not in the desired format" and switch to a narrower policy: "Videos not in the desired format". If an asset was only transcoded due to its resolution, then running a transcoding job for it will now delete the existing transcode. This is because resolution is no longer part of the transcode policy and the transcode is unnecessary as a result. Likewise, if you set the policy to "Don't transcode any videos" and run transcoding jobs for all assets, this will delete all existing transcodes as they are all unnecessary.
+:::
+
+### Is it possible to compress images during backup?
+
+No. Our golden rule is that the original assets should always be untouched, so we don't think this feature is a good fit for Immich.
+
+### How can I move all data (photos, persons, albums) from one user to another?
+
+This is not officially supported, but can be accomplished with some database updates. You can do this on the command line (in the PostgreSQL container using the psql command), or you can add for example an [Adminer](https://www.adminer.org/) container to the `docker-compose.yml` file, so that you can use a web-interface.
+
+:::warning
+This is an advanced operation. If you can't do it with the steps described here, this is not for you.
+:::
+
+<details>
+<summary>Steps</summary>
+
+1. **MAKE A BACKUP** - See [backup and restore](/docs/administration/backup-and-restore.md).
+
+2. Find the id of both the 'source' and the 'destination' user (it's the id column in the users table)
+
+3. Three tables need to be updated:
+
+```sql
+// reassign albums
+UPDATE albums SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
+
+// reassign people
+UPDATE person SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
+
+// reassign assets
+UPDATE assets SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>'
+ AND CHECKSUM NOT IN (SELECT CHECKSUM FROM assets WHERE "ownerId" = '<destinationId>');
+```
+
+4. There might be left-over assets in the 'source' user's library if they are skipped by the last query because of duplicate checksums. These are probably duplicates anyway, and can probably be removed.
+
+</details>
+
+---
+
+## Albums
+
+### Can I keep my existing album structure while importing assets into Immich?
+
+Yes. You can by use [Immich CLI](/docs/features/command-line-interface) along with the `--album` flag.
+
+### Is there a way to reorder photos within an album?
+
+No, not yet. For updates on this planned feature, follow the [GitHub discussion](https://github.com/immich-app/immich/discussions/1689),
+
+---
+
+## External Library
+
+### Can I add an external library while keeping the existing albums structure?
+
+We haven't put in an official mechanism to create albums from external libraries at the moment., but there are some [workarounds from the community](https://github.com/immich-app/immich/discussions/4279) which you can find here to help you achieve that.
+
+### What happens to duplicates in external libraries?
+
+Duplicate checking only exists for upload libraries, using the file hash. Furthermore, duplicate checking is not global, but _per library_. Therefore, a situation where the same file appears twice in the timeline is possible, especially for external libraries.
+
+---
+
+## Machine Learning
+
+### How does smart search work?
+
+Immich uses CLIP models, for more information about CLIP and its capabilities read about it [here](https://openai.com/research/clip).
+
+### How does facial recognition work?
+
+For face detection and recognition, Immich uses [InsightFace models](https://github.com/deepinsight/insightface/tree/master/model_zoo).
+
+### How can I disable machine learning?
+
+:::info
+Disabling machine learning will result in a poor experience for searching and the 'Explore' page, as these are reliant on it to work as intended.
+:::
+
+Machine learning can be disabled under Administration > Settings > Machine Learning Settings, either entirely or by model type. For instance, you can choose to disable smart search with CLIP, but keep facial recognition enabled. This means that the machine learning service will only process the enabled jobs.
+
+However, disabling all jobs will not disable the machine learning service itself. To prevent it from starting up at all in this case, you can comment out the `immich-machine-learning` section of the docker-compose.yml.
+
+### I'm getting errors about models being corrupt or failing to download. What do I do?
+
+You can delete the model cache volume, which is where models are downloaded to. This will give the service a clean environment to download the model again.
+
+### Why did Immich decide to remove object detection?
+
+The feature added keywords to images for metadata search, but wasn't used for smart search. Smart search made it unnecessary as it isn't limited to exact keywords. Combined with it causing crashes on some devices, using many dependencies and causing user confusion as to how search worked, it was better to remove the job altogether.
+For more info see [here](https://github.com/immich-app/immich/pull/5903)
+
+### Can I use a custom CLIP model?
+
+No, this is not supported. Only models listed in the [Huggingface](https://huggingface.co/immich-app) are compatible. Feel free to make a feature request if there's a model not listed here that you think should be added.
+
+### I want to be able to search in other languages besides English. How can I do that?
+
+You can change to a multilingual model listed [here](https://huggingface.co/collections/immich-app/multilingual-clip-654eb08c2382f591eeb8c2a7) by going to Administration > Machine Learning Settings > Smart Search and replacing the name of the model. Be sure to re-run Smart Search on all assets after this change. You can then search in over 100 languages.
+
+:::note
+Feel free to make a feature request if there's a model you want to use that isn't in [Immich Huggingface list](https://huggingface.co/immich-app).
+:::
+
+### Does Immich support Facial Recognition for videos ?
+
+This is not currently implemented, but may be in the future.
+
+On the other hand, Immich does scan video thumbnails for faces, so it can perform recognition if the face is clear in the video thumbnail.
+
+### Does Immich have animal recognition?
+
+No.
+
+### I'm getting a lot of "faces" that aren't faces, what can I do?
+
+You can increase the MIN DETECTION SCORE to 0.8 to help prevent bad thumbnails. However, a score of 0.9 might filter out too many real faces depending on the library used. If you just want to hide specific faces, you can adjust the 'MIN FACES DETECTED' setting in the administration panel  
+to increase the bar for what the algorithm considers a "core face" for that person, reducing the chance of bad thumbnails being chosen.
+
+### The immich_model-cache volume takes up a lot of space, what could be the problem?
+
+If you installed several models and chose not to use some of them, it might be worth deleting the old models that are in immich_model-cache.
+
+To do this you can run:
+
+- `docker run -it --rm -v immich_model-cache:/mnt ubuntu bash`
+- `cd mnt`
+- `ls`
+- and delete unused models with `rm -r <model_name>`.
+
+---
+
+## Performance
+
+### Why is Immich slow on low-memory systems like the Raspberry Pi?
+
+Immich optionally uses machine learning for several features. However, it can be too heavy to run on a Raspberry Pi. You can [mitigate](/docs/FAQ#can-i-lower-cpu-and-ram-usage) this or transfer to host Immich's machine-learning container on a [more powerful system](/docs/guides/remote-machine-learning) ,or [disable](/docs/FAQ#how-can-i-disable-machine-learning) machine learning entirely.
+
+### Can I lower CPU and RAM usage?
+
+The initial backup is the most intensive due to the number of jobs running. The most CPU-intensive ones are transcoding and machine learning jobs (Smart Search, Face Detection), and to a lesser extent thumbnail generation. Here are some ways to lower their CPU usage:
+
+- Lower the job concurrency for these jobs to 1.
+- Under Settings > Transcoding Settings > Threads, set the number of threads to a low number like 1 or 2.
+- Under Settings > Machine Learning Settings > Facial Recognition > Model Name, you can change the facial recognition model to `buffalo_s` instead of `buffalo_l`. The former is a smaller and faster model, albeit not as good.
+  - You _must_ re-run the Face Detection job for all images after this for facial recognition on new images to work properly.
+- If these changes are not enough, see [below](/docs/FAQ#how-can-i-disable-machine-learning) for how you can disable machine learning.
+
+### Can I limit the amount of CPU and RAM usage?
+
+By default, a container has no resource constraints and can use as much of a given resource as the host's kernel scheduler allows.
+You can look at the [original docker docs](https://docs.docker.com/config/containers/resource_constraints/) or use this [guide](https://www.baeldung.com/ops/docker-memory-limit) to learn how to do this.
+
+### How an I boost machine learning speed?
+
+:::note
+This advice improves throughput, not latency. This is to say that it will make Smart Search jobs process more quickly, but it won't make searching faster.
+:::
+
+You can increase throughput by increasing the job concurrency for machine learning jobs (Smart Search, Face Detection). With higher concurrency, the host will work on more assets in parallel. You can do this by navigating to Administration > Settings > Job Settings and increasing concurrency as needed.
+
+:::danger
+On a normal machine, 2 or 3 concurrent jobs can probably max the CPU, so if you're not hitting those maximums with, say, 30 jobs.
+Note that storage speed and latency may quickly become the limiting factor; particularly when using HDDs.
+
+Do not exaggerate with the amount of jobs because you're probably thoroughly overloading the server.
+
+more info [here](https://discord.com/channels/979116623879368755/994044917355663450/1174711719994605708)
+:::
+
+### Why is Immich using so much of my CPU?
+
+When a large amount of assets are uploaded to Immich it makes sense that the CPU and RAM will be heavily used due to machine learning work and creating image thumbnails after that, the percentage of CPU usage will drop to around 3-5% usage
+
+---
+
+## Docker
+
+### How can I see Immich logs?
+
+Most Immich components are typically deployed using docker. To see logs for deployed docker containers, you can use the [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli/), specifically the `docker logs` command. For examples, see [Docker Help](/docs/guides/docker-help.md).
+
+### How can I run Immich as a non-root user?
+
+1. Set the `PUID`/`PGID` environment variables (in `.env`).
+2. Set the corresponding `user` argument in `docker-compose` for each service.
+3. Add an additional volume to `immich-microservices` that mounts internally to `/usr/src/app/.reverse-geocoding-dump`.
+
+The non-root user/group needs read/write access to the volume mounts, including `UPLOAD_LOCATION`.
+
+### How can I **purge** data from Immich?
+
+Data for Immich comes in two forms:
+
+1. **Metadata** stored in a postgres database, persisted via the `pg_data` volume
+2. **Files** (originals, thumbs, profile, etc.), stored in the `UPLOAD_LOCATION` folder, more [info](/docs/administration/backup-and-restore#asset-types-and-storage-locations).
+
+To remove the **Metadata** you can stop Immich and delete the volume.
+
+```bash title="Remove Immich (containers and volumes)"
+docker compose down -v
+```
+
+:::note Portainer
+If you use portainer, bring down the stack in portainer. Go into the volumes section  
+and remove all the volumes related to immcih then restart the stack.
+:::
+
+After removing the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting any unwanted files or folders.
+
+### Why does the machine learning service report workers crashing?
+
+:::note
+If the error says the worker is exiting, then this is normal. This is a feature intended to reduce RAM consumption when the service isn't being used.
+:::
+
+There are a few reasons why this can happen.
+
+If the error mentions SIGKILL or error code 137, it most likely means the service is running out of memory. Consider either increasing the server's RAM or moving the service to a server with more RAM.
+
+If it mentions SIGILL (note the lack of a K) or error code 132, it most likely means your server's CPU is incompatible. This is unlikely to occur on version 1.92.0 or later. Consider upgrading if your version of Immich is below that.
+
+If your version of Immich is below 1.92.0 and the crash occurs after logs about tracing or exporting a model, consider either upgrading or disabling the Tag Objects job.
+
+### Why do I get the error "duplicate key value violates unique constraint" in the log files?
+
+Because of Immich's container structure, this error can be seen when both immich and immich-microservices start at the same time and attempt to migrate or create the database structure. Since the database migration is run sequentially and inside of transactions, this error message does not cause harm to your installation of Immich and can safely be ignored. If needed, you can manually restart Immich by running `docker restart immich immich-microservices`.

docs/docs/administration/backup-and-restore.md

@@ -1,5 +1,10 @@
 # Backup and Restore
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+A [3-2-1 backup strategy](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) is recommended to protect your data. You should keep copies of your uploaded photos/videos as well as the Immich database for a comprehensive backup solution. This page provides an overview on how to backup the database and the location of user-uploaded pictures and videos. A template bash script that can be run as a cron job is provided [here](/docs/guides/template-backup-script.md)
+
 ## Database
 
 :::caution
@@ -12,7 +17,10 @@ Refer to the official [postgres documentation](https://www.postgresql.org/docs/c
 
 The recommended way to backup and restore the Immich database is to use the `pg_dumpall` command.
 
-```bash title='Backup'
+<Tabs>
+  <TabItem value="Linux system based Backup" label="Linux system based Backup" default>
+
+```bash title='Bash'
 docker exec -t immich_postgres pg_dumpall -c -U postgres | gzip > "/path/to/backup/dump.sql.gz"
 ```
 
@@ -26,6 +34,26 @@ gunzip < "/path/to/backup/dump.sql.gz" | docker exec -i immich_postgres psql -U
 docker compose up -d    # Start remainder of Immich apps
 ```
 
+</TabItem>
+  <TabItem value="Windows system based Backup" label="Windows system based Backup">
+
+```powershell title='Backup'
+docker exec -t immich_postgres pg_dumpall -c -U postgres > "\path\to\backup\dump.sql"
+```
+
+```powershell title='Restore'
+docker compose down -v  # CAUTION! Deletes all Immich data to start from scratch.
+docker compose pull     # Update to latest version of Immich (if desired)
+docker compose create   # Create Docker containers for Immich apps without running them.
+docker start immich_postgres    # Start Postgres server
+sleep 10    # Wait for Postgres server to start up
+gc "C:\path\to\backup\dump.sql" | docker exec -i immich_postgres psql -U postgres -d immich    # Restore Backup
+docker compose up -d    # Start remainder of Immich apps
+```
+
+</TabItem>
+</Tabs>
+
 Note that for the database restore to proceed properly, it requires a completely fresh install (i.e. the Immich server has never run since creating the Docker containers). If the Immich app has run, Postgres conflicts may be encountered upon database restoration (relation already exists, violated foreign key constraints, multiple primary keys, etc.).
 
 The database dumps can also be automated (using [this image](https://github.com/prodrigestivill/docker-postgres-backup-local)) by editing the docker compose file to match the following:
@@ -62,5 +90,80 @@ gunzip < db_dumps/last/immich-latest.sql.gz | docker exec -i immich_postgres psq
 Immich stores two types of content in the filesystem: (1) original, unmodified content, and (2) generated content. Only the original content needs to be backed-up, which includes the following folders:
 
 1. `UPLOAD_LOCATION/library`
-1. `UPLOAD_LOCATION/upload`
-1. `UPLOAD_LOCATION/profile`
+2. `UPLOAD_LOCATION/upload`
+3. `UPLOAD_LOCATION/profile`
+
+### Asset Types and Storage Locations
+
+Some storage locations are impacted by the Storage Template. See below for more details.
+
+<Tabs>
+  <TabItem value="Storage Template Off (Default)." label="Storage Template Off (Default)." default>
+
+:::note
+`UPLOAD_LOCATION/library` folder is not used by default on new machines running version 1.92.0. These are if the system administrator activated the storage template engine, for [more info](https://github.com/immich-app/immich/releases#:~:text=the%20partner%E2%80%99s%20assets.-,Hardening%20storage%20template,-We%20have%20further).
+:::
+
+**1. User-Specific Folders:**
+
+- Each user has a unique string representing them.
+- You can find your user ID in Account Account Settings -> Account -> User ID.
+
+**2. Asset Types and Storage Locations:**
+
+- **Source Assets:**
+  - Original assets uploaded through the browser interface & mobile & CLI.
+  - Stored in `/library/upload/<userID>`.
+- **Avatar Images:**
+  - User profile images.
+  - Stored in `/library/profile/<userID>`.
+- **Thumbs Images:**
+  - Preview images (blurred, small, large) for each asset and thumbnails for recognized faces.
+  - Stored in `/library/thumbs/<userID>`.
+- **Encoded Assets:**
+  - By default, unless otherwise specified re-encoded video assets for wider compatibility.
+  - Stored in `/library/encoded-video/<userID>`.
+
+</TabItem>
+  <TabItem value="Storage Template On" label="Storage Template On">
+
+:::note
+If you choose to activate the storage template engine, it will move all assets to `UPLOAD_LOCATION/library/<userID>`.
+
+When you turn off the storage template engine, it will leave the assets in `UPLOAD_LOCATION/library/<userID>` and will not return them to `/library/upload`.  
+**New assets** will be saved to `/library/upload`.
+:::
+
+**1. User-Specific Folders:**
+
+- Each user has a unique string representing them.
+  - The main user is "Admin" (but only for `UPLOAD_LOCATION/library`)
+  - Other users have different string identifiers.
+- You can find your user ID in Account Account Settings -> Account -> User ID.
+
+**2. Asset Types and Storage Locations:**
+
+- **Source Assets:**
+  - Original assets uploaded through the browser interface & mobile & CLI.
+  - Stored in `UPLOAD_LOCATION/library/<userID>`.
+- **Avatar Images:**
+  - User profile images.
+  - Stored in `/library/profile/<userID>`.
+- **Thumbs Images:**
+  - Preview images (blurred, small, large) for each asset and thumbnails for recognized faces.
+  - Stored in `/library/thumbs/<userID>`.
+- **Encoded Assets:**
+  - By default, unless otherwise specified re-encoded video assets for wider compatibility .
+  - Stored in `/library/encoded-video/<userID>`.
+- **Files in Upload Queue (Mobile):**
+  - Files uploaded through mobile apps.
+  - Temporarily located in `/library/upload/<userID>`.
+  - Transferred to `UPLOAD_LOCATION/library/<userID>` upon successful upload.
+
+</TabItem>
+</Tabs>
+
+:::danger
+Do not touch the files inside these folders under any circumstances except taking a backup, changing or removing an asset can cause untracked and missing files.
+You can think of it as App-Which-Must-Not-Be-Named, the only access to viewing, changing and deleting assets is only through the mobile or browser interface.
+:::

docs/docs/administration/reverse-proxy.md

@@ -38,3 +38,29 @@ immich.example.org {
     reverse_proxy http://<snip>:2283
 }
 ```
+
+### Apache example config
+
+Below is an example config for Apache2 site configuration.
+
+```
+<VirtualHost *:80>
+    ServerName <snip>
+
+    ProxyRequests off
+    ProxyVia on
+
+    RewriteEngine On
+    RewriteCond %{REQUEST_URI}  ^/api/socket.io            [NC]
+    RewriteCond %{QUERY_STRING} transport=websocket    [NC]
+    RewriteRule /(.*)           ws://localhost:2283/$1 [P,L]
+
+    ProxyPass        /api/socket.io ws://localhost:2283/api/socket.io
+    ProxyPassReverse /api/socket.io ws://localhost:2283/api/socket.io
+
+    <Location />
+        ProxyPass http://localhost:2283/
+        ProxyPassReverse http://localhost:2283/
+    </Location>
+</VirtualHost>
+```

docs/docs/administration/storage-template.mdx

@@ -1,4 +1,4 @@
-import StorageTemplate from '../partials/_storage-template.md';
+import StorageTemplate from '/docs/partials/_storage-template.md';
 
 # Storage Template
 

docs/docs/administration/user-management.mdx

@@ -1,5 +1,5 @@
-import RegisterAdminUser from '../partials/_register-admin.md';
-import UserCreate from '../partials/_user-create.md';
+import RegisterAdminUser from '/docs/partials/_register-admin.md';
+import UserCreate from '/docs/partials/_user-create.md';
 
 # User Management
 

docs/docs/developer/architecture.mdx

@@ -107,4 +107,4 @@ See [Database Migrations](./database-migrations.md) for more information about h
 
 ### Redis
 
-Immich uses [Redis](https://redis.com/) via [BullMQ](https://docs.bullmq.io/) to manage job queues. Some jobs trigger subsequent jobs. For example, object detection relies on thumbnail generation and automatically run after one is generated.
+Immich uses [Redis](https://redis.com/) via [BullMQ](https://docs.bullmq.io/) to manage job queues. Some jobs trigger subsequent jobs. For example, Smart Search and Facial Recognition relies on thumbnail generation and automatically run after one is generated.

docs/docs/developer/database-migrations.md

@@ -1,6 +1,6 @@
 # Database Migrations
 
-After making any changes in the `server/src/infra/database/entities`, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.
+After making any changes in the `server/src/infra/entities`, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.
 
 1. Run the command
 

docs/docs/developer/open-api.md

@@ -7,11 +7,7 @@ Immich uses the [OpenAPI](https://swagger.io/specification/) standard to generat
 OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). The generated SDK is based on the `immich-openapi-specs.json` file, which is autogenerated by the server **when running in development mode**. The `immich-openapi-specs.json` file can be modified with `@nestjs/swagger` decorators used or referenced by controller endpoints. See the [NestJS OpenAPI docs](https://docs.nestjs.com/openapi/types-and-parameters) for more info. When you add a new endpoint or modify an existing one, you must run the server in development mode and run the command below to update the client SDK.
 
 ```bash
-npm run api:generate # Run from the `server/` directory
+make open-api
 ```
 
-You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
-
-:::tip
-This can also be run via `make api` from the project root directory (not in the `server` folder)
-:::
+You can find the generated client SDK in the `open-api/typescript-sdk/client` for Typescript SDK and `mobile/openapi` for Dart SDK.

docs/docs/developer/pr-checklist.md

@@ -6,7 +6,7 @@ When contributing code through a pull request, please check the following:
 
 - [ ] `npm run lint` (linting via ESLint)
 - [ ] `npm run format` (formatting via Prettier)
-- [ ] `npm run check` (Type checking via SvelteKit)
+- [ ] `npm run check:svelte` (Type checking via SvelteKit)
 - [ ] `npm test` (Tests via Jest)
 
 :::tip

docs/docs/developer/setup.md

@@ -4,6 +4,16 @@ sidebar_position: 2
 
 # Setup
 
+:::note
+If there's a feature you're planning to work on, just give us a heads up in [Discord](https://discord.com/channels/979116623879368755/1071165397228855327) so we can:
+
+1. Let you know if it's something we would accept into Immich
+2. Provide any guidance on how something like that would ideally be implemented
+3. Ensure nobody is already working on that issue/feature so we don't duplicate effort
+
+Thanks for being interested in contributing 😊
+:::
+
 ## Environment
 
 ### Server and web app
@@ -16,7 +26,6 @@ This environment includes the following services:
 - Web app - `/web`
 - Redis
 - PostgreSQL development database with exposed port `5432` so you can use any database client to acess it
-- NGINX Proxy - `nginx/nginx.conf`
 
 All the services are packaged to run as with single Docker Compose command.
 
@@ -37,9 +46,11 @@ All the services will be started with hot-reloading enabled for a quick feedback
 
 You can access the web from `http://your-machine-ip:2283` or `http://localhost:2283` and access the server from the mobile app at `http://your-machine-ip:2283/api`
 
+**Note:** the "web" development container runs with uid 1000. If that uid does not have read/write permissions on the mounted volumes, you may encounter errors
+
 ### Mobile app
 
-The mobile app `(/mobile)` will required Flutter toolchain to be installed on your system.
+The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system.
 
 Please refer to the [Flutter's official documentation](https://flutter.dev/docs/get-started/install) for more information on setting up the toolchain on your machine.
 

docs/docs/developer/testing.md

@@ -8,10 +8,15 @@ Unit are run by calling `npm run test` from the `server` directory.
 
 ### End to end tests
 
-The backend has an end-to-end test suite that can be called with `npm run test:e2e` from the `server` directory. This will set up a dummy database inside a temporary container and run the tests against it. Setup and teardown is automatically taken care of. That test, however, can not set up all prerequisites to parse file formats, as that is very complex and error-prone. As such, this test excludes some test cases like HEIC file imports. The test suite will also print a friendly warning to remind you that not all tests are being run.
+The backend has two end-to-end test suites that can be called with the following two commands from the project root directory:
 
-Note that there is a bug in nodejs <20.8 that causes segmentation faults when running these tests. If you run into segfaults, ensure you are using at least version 20.8.
+- `make server-e2e-api`
+- `make server-e2e-jobs`
 
-To perform a full e2e test, you need to run e2e tests inside docker. The easiest way to do that is to run `make test-e2e` in the root directory. This will build and start a docker-compose consisting of the server, microservices, and a postgres database. It will then perform the tests and exit.
+#### API (e2e)
 
-If you manually install the dependencies (see the DOCKERFILE) on your development machine, you can also run the full e2e tests manually by setting the `IMMICH_RUN_ALL_TESTS` environment value to true, i.e. `IMMICH_RUN_ALL_TESTS=true npm run test:e2e`.
+The API e2e tests spin up a test database and execute http requests against the server, validating the expected response codes and functionality for API endpoints.
+
+#### Jobs (e2e)
+
+The Jobs e2e tests spin up a docker test environment where thumbnail generation, library scanning, and other _job_ workflows are validated.

docs/docs/features/command-line-interface.md

@@ -10,7 +10,7 @@ Immich has a CLI that allows you to perform certain actions from the command lin
 More features are planned for the future.
 
 :::tip Google Photos Takeout
-If you are looking to import your Google Photos takeout, we recommed this community maintained tool [immich-go](https://github.com/simulot/immich-go)
+If you are looking to import your Google Photos takeout, we recommend this community maintained tool [immich-go](https://github.com/simulot/immich-go)
 :::
 
 ## Requirements

docs/docs/features/facial-recognition.md

@@ -25,6 +25,6 @@ Additional actions you can do with a detected person are:
 - Merge two or more detected faces into one person
 - Hide face
 
-It can be found from the app bar when you access the detial view of a person
+It can be found from the app bar when you access the detail view of a person.
 
 <img src={require('./img/facial-recognition-4.png').default} title='Facial Recognition 4' width="70%"/>

docs/docs/features/hardware-transcoding.md

@@ -43,12 +43,28 @@ As this is a new feature, it is still experimental and may not work on all syste
 
 ## Setup
 
+#### Initial Setup
+
 1. If you do not already have it, download the latest [`hwaccel.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`.
 2. Uncomment the lines that apply to your system and desired usage.
 3. In the `docker-compose.yml` under `immich-microservices`, uncomment the lines relating to the `hwaccel.yml` file.
 4. Redeploy the `immich-microservices` container with these updated settings.
 5. In the Admin page under `FFmpeg settings`, change the hardware acceleration setting to the appropriate option and save.
 
+#### All-In-One - Unraid Setup
+
+##### NVENC - NVIDIA GPUs
+
+- If you are using other backends. You will still need to implement [`hwaccel.yml`][hw-file] file into the `immich-microservices` service directly, please see the "Initial Setup" section above on how to do that.
+- As of v1.92.0, steps 1 and 2 are no longer necessary. If your version of Immich is below that or missing the environment variables, please follow these steps. Otherwise, skip to step 3.
+- Please note that`NVIDIA_DRIVER_CAPABILITIES` is no longer required to enter as a variable.
+
+1. Assuming you already have the Nvidia Driver Plugin installed on your Unraid Server. Please confirm that your Nvida GPU is showing up with its GPU ID in the Nvidia Driver Plugin. The ID will be `GPU-LONG_STRING_OF_CHARACTERS`. Copy the GPU ID.
+2. In the Imagegenius/Immich Docker Container app, add two new variables: Key=`NVIDIA_VISIBLE_DEVICES` Value=`GPU-LONG_STRING_OF_CHARACTERS` and Key=`NVIDIA_DRIVER_CAPABILITIES` Value=`all`
+3. While you are in the docker container app, change the Container from Basic Mode to Advanced Mode and add the following parameter to the Extra Parameters field: `--runtime=nvidia`
+4. Restart the Imagegenius/Immich Docker Container app.
+5. In the Admin page under FFmpeg settings, change the hardware acceleration setting to the appropriate option and save.
+
 ## Tips
 
 - You may want to choose a slower preset than for software transcoding to maintain quality and efficiency

docs/docs/features/libraries.md

@@ -34,9 +34,11 @@ If you add assets from an external library to an album and then move the asset t
 
 ### Deleted External Assets
 
+Note: Either a manual or scheduled library scan must have been performed to identify offline assets before this process will work.
+
 In all above scan methods, Immich will check if any files are missing. This can happen if files are deleted, or if they are on a storage location that is currently unavailable, like a network drive that is not mounted, or a USB drive that has been unplugged. In order to prevent accidental deletion of assets, Immich will not immediately delete an asset from the library if the file is missing. Instead, the asset will be internally marked as offline and will still be visible in the main timeline. If the file is moved back to its original location and the library is scanned again, the asset will be restored.
 
-Finally, files can be deleted from Immich via the `Remove Offline Files` job. Any assets marked as offline will then be removed from Immich. Run this job whenever files have been deleted from the file system and you want to remove them from Immich. Note that a library scan must be performed first to mark the assets as offline.
+Finally, files can be deleted from Immich via the `Remove Offline Files` job. This job can be found by the three dots menu for the associated external storage that was configured under user account settings > libraries (the same location described at [create external libraries](#create-external-libraries)). When this job is run, any assets marked as offline will then be removed from Immich. Run this job whenever files have been deleted from the file system and you want to remove them from Immich.
 
 ### Import Paths
 
@@ -50,7 +52,11 @@ Sometimes, an external library will not scan correctly. This can happen if the i
 - In the docker-compose file, are the volumes mounted correctly?
 - Are the volumes identical between the `server` and `microservices` container?
 - Are the import paths set correctly, and do they match the path set in docker-compose file?
+- Are you using symbolic link in your import library?
 - Are the permissions set correctly?
+- Are you using forward slashes everywhere? (`/`)
+- Are you using symlink across docker mounts?
+- Are you using [spaces in the internal path](/docs/features/libraries#:~:text=can%20be%20accessed.-,NOTE,-Spaces%20in%20the)?
 
 If all else fails, you can always start a shell inside the container and check if the path is accessible. For example, `docker exec -it immich_microservices /bin/bash` will start a bash shell. If your import path, for instance, is `/data/import/photos`, you can check if the files are accessible by running `ls /data/import/photos`. Also check the `immich_server` container in the same way.
 
@@ -66,16 +72,25 @@ For security purposes, each Immich user is disallowed to add external files by d
 
 With the `external path` set, a user is restricted to accessing external files to files or directories within that path. The Immich admin should still be careful not set the external path too generously. For example, `user1` wants to read their photos in to `/home/user1`. A lazy admin sets that user's external path to `/home/` since it "gets the job done". However, that user will then be able to read all photos in `/home/user2/private-photos`, too! Please set the external path as specific as possible. If multiple folders must be added, do this using the docker volume mount feature described below.
 
-### Exclusion Patterns and Scan Settings
+### Exclusion Patterns
 
 By default, all files in the import paths will be added to the library. If there are files that should not be added, exclusion patterns can be used to exclude them. Exclusion patterns are glob patterns are matched against the full file path. If a file matches an exclusion pattern, it will not be added to the library. Exclusion patterns can be added in the Scan Settings page for each library. Under the hood, Immich uses the [glob](https://www.npmjs.com/package/glob) package to match patterns, so please refer to [their documentation](https://github.com/isaacs/node-glob#glob-primer) to see what patterns are supported.
 
 Some basic examples:
 
-- `*.tif` will exclude all files with the extension `.tif`
-- `hidden.jpg` will exclude all files named `hidden.jpg`
+- `**/*.tif` will exclude all files with the extension `.tif`
+- `**/hidden.jpg` will exclude all files named `hidden.jpg`
 - `**/Raw/**` will exclude all files in any directory named `Raw`
-- `*.{tif,jpg}` will exclude all files with the extension `.tif` or `.jpg`
+- `**/*.{tif,jpg}` will exclude all files with the extension `.tif` or `.jpg`
+
+### Automatic watching (EXPERIMENTAL)
+
+This feature - currently hidden in the config file - is considered experimental and for advanced users only. If enabled, it will allow automatic watching of the filesystem which means new assets are automatically imported to Immich without needing to rescan. Deleted assets are, as always, marked as offline and can be removed with the "Remove offline files" button.
+
+If your photos are on a network drive you will likely have to enable filesystem polling. The performance hit for polling large libraries is currently unknown, feel free to test this feature and report back. In addition to the boolean feature flag, the configuration file allows customization of the following parameters, please see the [chokidar documentation](https://github.com/paulmillr/chokidar?tab=readme-ov-file#performance) for reference.
+
+- `usePolling` (default: `false`).
+- `interval`. (default: 10000). When using polling, this is how often (in milliseconds) the filesystem is polled.
 
 ### Nightly job
 
@@ -102,6 +117,7 @@ First, we need to plan how we want to organize the libraries. The christmas trip
 +     - /mnt/nas/christmas-trip:/mnt/media/christmas-trip:ro
 +     - /home/user/old-pics:/mnt/media/old-pics:ro
 +     - /mnt/media/videos:/mnt/media/videos:ro
++     - "C:/Users/user_name/Desktop/my media:/mnt/media/my-media:ro" # import path in Windows system.
 
 
   immich-microservices:
@@ -110,13 +126,16 @@ First, we need to plan how we want to organize the libraries. The christmas trip
 +     - /mnt/nas/christmas-trip:/mnt/media/christmas-trip:ro
 +     - /home/user/old-pics:/mnt/media/old-pics:ro
 +     - /mnt/media/videos:/mnt/media/videos:ro
++     - "C:/Users/user_name/Desktop/my media:/mnt/media/my-media:ro" # import path in Windows system.
 ```
 
 :::tip
 The `ro` flag at the end only gives read-only access to the volumes. While Immich does not modify files, it's a good practice to mount read-only.
 :::
 
-_Remember to bring the container down/up to register the changes. Make sure you can see the mounted path in the container._
+:::info
+_Remember to bring the container `docker compose down/up` to register the changes. Make sure you can see the mounted path in the container._
+:::
 
 ### Set External Path
 
@@ -125,6 +144,14 @@ Only an admin can do this.
 - Navigate to `Administration > Users` page on the web.
 - Click on the user edit button.
 - Set `/mnt/media` to be the external path. This folder will only contain the three folders that we want to import, so nothing else can be accessed.
+  :::note
+  Spaces in the internal path aren't currently supported.
+
+  You must import it as:
+  `..:/mnt/media/my-media:ro`
+  instead of
+  `..:/mnt/media/my media:ro`
+  :::
 
 ### Create External Libraries
 

docs/docs/features/mobile-app.mdx

@@ -1,6 +1,6 @@
-import MobileAppDownload from '../partials/_mobile-app-download.md';
-import MobileAppLogin from '../partials/_mobile-app-login.md';
-import MobileAppBackup from '../partials/_mobile-app-backup.md';
+import MobileAppDownload from '/docs/partials/_mobile-app-download.md';
+import MobileAppLogin from '/docs/partials/_mobile-app-login.md';
+import MobileAppBackup from '/docs/partials/_mobile-app-backup.md';
 
 # Mobile App
 

docs/docs/features/search.md

@@ -6,6 +6,8 @@ Smart search is powered by the [pgvecto.rs](https://github.com/tensorchord/pgvec
 
 Metadata search (prefixed with `m:`) can search specifically by text without the use of a model.
 
+Archived photos are not included in search results by default. To include them, add the query parameter `withArchived=true` to the url.
+
 Some search examples:
 <img src={require('./img/search-ex-2.webp').default} title='Search Example 1' />
 

docs/docs/guides/database-gui.md

@@ -0,0 +1,49 @@
+# Database GUI
+
+A short guide on connecting [pgAdmin](https://www.pgadmin.org/) to Immich.
+
+:::note
+
+In order to connect to the database the immich_postgres container **must be running**.
+
+The passwords and usernames used below match the ones specified in the example `.env` file. If changed, please use actual values instead.
+
+**Optional:** To connect to the database **outside** of your Docker's network:
+
+- Expose port 5432 in your `docker-compose.yml` file.
+- Edit the PostgreSQL [`pg_hba.conf`](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html) file.
+- Make sure your firewall does not block access to port 5432.
+  Note that exposing the database port increases the risk of getting attacked by hackers.  
+  Make sure to remove the binding port after finishing the database's tasks.
+
+:::
+
+## 1. Install pgAdmin
+
+Download and install [pgAdmin](https://www.pgadmin.org/download/) following the official documentation.
+
+## 2. Add a Server
+
+Open pgAdmin and click "Add New Server".
+
+<img src={require('./img/add-new-server-option.png').default} width="50%" title="new server option" />
+
+## 3. Enter Connection Details
+
+| Name                 | Value       |
+| -------------------- | ----------- |
+| Host name/address    | `localhost` |
+| Port                 | `5432`      |
+| Maintenance database | `immich`    |
+| Username             | `postgres`  |
+| Password             | `postgres`  |
+
+<img src={require('./img/Connection-Pgadmin.png').default} width="75%" title="Connection" />
+
+## 4. Save Connection
+
+Click on "Save" to connect to the Immich database.
+
+:::tip
+View [Database Queries](https://immich.app/docs/guides/database-queries/) for common database queries.
+:::

docs/docs/guides/database-queries.md

@@ -7,7 +7,7 @@ Keep in mind that mucking around in the database might set the moon on fire. Avo
 :::tip
 Run `docker exec -it immich_postgres psql immich <DB_USERNAME>` to connect to the database via the container directly.
 
-(Replace `<DB_USERNAME>` wit the value from your [`.env` file](/docs/install/environment-variables#database)).
+(Replace `<DB_USERNAME>` with the value from your [`.env` file](/docs/install/environment-variables#database)).
 :::
 
 ## Assets

docs/docs/guides/external-library.md

@@ -1,6 +1,6 @@
 # External Library
 
-This guide walks you through adding an [External Library](../features/libraries#external-libraries).
+This guide walks you through adding an [External Library](/docs/features/libraries#external-libraries).
 This guide assumes you are running Immich in Docker and that the files you wish to access are stored
 in a directory on the same machine.
 
@@ -78,7 +78,7 @@ In the Immich web UI:
 - Click \*_Add path_
   <img src={require('./img/add-path-button.png').default} width="50%" title="Add Path button" />
 
-- Enter **.** as the path and click Add
+- Enter **/usr/src/app/external** as the path and click Add
   <img src={require('./img/add-path-field.png').default} width="50%" title="Add Path field" />
 
 - Save the new path

docs/docs/guides/remote-access.md

@@ -1,6 +1,7 @@
 # Remote Access
 
 This page gives a few pointers on how to access your Immich instance from outside your LAN.
+You can read the [full discussion in Discord](https://discord.com/channels/979116623879368755/1122615710846308484)
 
 :::danger
 Never forward port 2283 directly to the internet without additional configuration. This will expose the web interface via http to the internet, making you succeptible to [man in the middle](https://en.wikipedia.org/wiki/Man-in-the-middle_attack) attacks.
@@ -41,7 +42,7 @@ If you are unable to open a port on your router for Wireguard or OpenVPN to your
 
 A reverse proxy is a service that sits between web servers and clients. A reverse proxy can either be hosted on the server itself or remotely. Clients can connect to the reverse proxy via https, and the proxy relays data to Immich. This setup makes most sense if you have your own domain and want to access your Immich instance just like any other website, from outside your LAN. You can also use a DDNS provider like DuckDNS or no-ip if you don't have a domain. This configuration allows the Immich Android and iphone apps to connect to your server without a VPN or tailscale app on the client side.
 
-If you're hosting your own reverse proxy, [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) is a great option. An example configuration for Nginx is provided [here](https://immich.app/docs/administration/reverse-proxy).
+If you're hosting your own reverse proxy, [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) is a great option. An example configuration for Nginx is provided [here](/docs/administration/reverse-proxy.md).
 
 You'll also need your own certificate to authenticate https connections. If you're making Immich publicly accesible, [Let's Encrypt](https://letsencrypt.org/) can provide a free certificate for your domain and is the recommended option. Alternatively, a [self-signed certificate](https://en.wikipedia.org/wiki/Self-signed_certificate) allows you to encrypt your connection to Immich, but it raises a security warning on the client's browser.
 

docs/docs/guides/remote-machine-learning.md

@@ -1,11 +1,15 @@
 # Remote Machine Learning
 
-To alleviate [performance issues on low-memory systems](/docs/FAQ.md#why-is-immich-slow-on-low-memory-systems-like-the-raspberry-pi) like the Raspberry Pi, you may also host Immich's machine-learning container on a more powerful system (e.g. your laptop or desktop computer):
+To alleviate [performance issues on low-memory systems](/docs/FAQ.mdx#why-is-immich-slow-on-low-memory-systems-like-the-raspberry-pi) like the Raspberry Pi, you may also host Immich's machine-learning container on a more powerful system (e.g. your laptop or desktop computer):
 
 - Set the URL in Machine Learning Settings on the Admin Settings page to point to the designated ML system, e.g. `http://workstation:3003`.
 - Copy the following `docker-compose.yml` to your ML system.
 - Start the container by running `docker-compose up -d` or `docker compose up -d` (depending on your Docker version).
 
+:::note Info
+Starting with version v1.93.0 face detection work and face recognize were split. From now on face detection is done in the immich_machine_learning service, but facial recognition is done in the immich_microservices service.
+:::
+
 ```yaml
 version: '3.8'