Version v1.95.0

Prefer sharing local assets to remote

.dockerignore

@@ -24,5 +24,7 @@ cli/.reverse-geocoding-dump/
 cli/upload/
 cli/dist/
 
+e2e/
+
 open-api/typescript-sdk/node_modules/
 open-api/typescript-sdk/build/

.gitattributes

@@ -8,9 +8,9 @@ mobile/openapi/.openapi-generator/FILES linguist-generated=true
 mobile/lib/**/*.g.dart -diff -merge
 mobile/lib/**/*.g.dart 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
+open-api/typescript-sdk/axios-client/**/* -diff -merge
+open-api/typescript-sdk/axios-client/**/* linguist-generated=true
+open-api/typescript-sdk/fetch-client.ts -diff -merge
+open-api/typescript-sdk/fetch-client.ts linguist-generated=true
 
 *.sh text eol=lf

.github/release.yml

@@ -28,14 +28,13 @@ changelog:
       labels:
         - documentation
 
-    - title: 🔨 Build
+    - title: 🔨 Maintenance
       labels:
         - deployment
-
-    - title: 🤖 Dependencies
-      labels:
         - 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/cli-release.yml

@@ -1,23 +0,0 @@
-name: CLI Release
-on:
-  workflow_dispatch:
-
-jobs:
-  publish:
-    name: Publish
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./cli
-
-    steps:
-      - uses: actions/checkout@v4
-      # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "20.x"
-          registry-url: "https://registry.npmjs.org"
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/cli.yml

@@ -0,0 +1,98 @@
+name: CLI Build
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths:
+      - "cli/**"
+      - ".github/workflows/cli.yml"
+  pull_request:
+    branches: [main]
+    paths:
+      - "cli/**"
+      - ".github/workflows/cli.yml"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  packages: write
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cli
+
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+      - name: Prepare SDK
+        run: npm ci --prefix ../open-api/typescript-sdk/
+      - name: Build SDK
+        run: npm run build --prefix ../open-api/typescript-sdk/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  docker:
+    name: Docker
+    runs-on: ubuntu-latest
+    needs: publish
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.0.0
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        if: ${{ !github.event.pull_request.head.repo.fork }}
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get package version
+        id: package-version
+        run: |
+          version=$(jq -r '.version' cli/package.json)
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Generate docker image tags
+        id: metadata
+        uses: docker/metadata-action@v5
+        with:
+          flavor: |
+            latest=false
+          images: |
+            name=ghcr.io/${{ github.repository_owner }}/immich-cli
+          tags: |
+            type=raw,value=${{ steps.package-version.outputs.version }},enable=${{ github.event_name == 'workflow_dispatch' }}
+            type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v5.1.0
+        with:
+          file: cli/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name == 'workflow_dispatch' }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}

.github/workflows/docker-cleanup.yml

@@ -35,7 +35,7 @@ jobs:
     steps:
       - name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.4.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.5.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "immich-app"
@@ -64,7 +64,7 @@ jobs:
     steps:
       - name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.4.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.5.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "immich-app"

.github/workflows/docker.yml

@@ -25,14 +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
@@ -79,12 +103,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 +130,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
@@ -32,7 +32,11 @@ jobs:
       - name: Run dart analyze
         run: dart analyze --fatal-infos
         working-directory: ./mobile
-      
+
+      - name: Run dart format
+        run: dart format lib/ --set-exit-if-changed
+        working-directory: ./mobile
+
       # Enable after riverpod generator migration is completed
       # - name: Run dart custom lint
       #   run: dart run custom_lint

.github/workflows/test.yml

@@ -103,6 +103,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
       - name: Run setup typescript-sdk
         run: npm ci && npm run build
         working-directory: ./open-api/typescript-sdk
@@ -130,33 +135,6 @@ jobs:
         run: npm run test:cov
         if: ${{ !cancelled() }}
 
-  cli-e2e-tests:
-    name: CLI (e2e)
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./cli
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: "recursive"
-
-      - 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 (server)
-        run: npm ci
-        working-directory: ./server
-
-      - name: Run e2e tests
-        run: npm run test:e2e
-
   web-unit-tests:
     name: Web
     runs-on: ubuntu-latest
@@ -195,6 +173,47 @@ jobs:
         run: npm run test:cov
         if: ${{ !cancelled() }}
 
+  e2e-tests:
+    name: End-to-End Tests
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./e2e
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Run setup typescript-sdk
+        run: npm ci && npm run build
+        working-directory: ./open-api/typescript-sdk
+
+      - name: Run setup cli
+        run: npm ci && npm run build
+        working-directory: ./cli
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+
+      - name: Docker build
+        run: docker compose build
+
+      - name: Run e2e tests (api & cli)
+        run: npm run test
+
+      - name: Run e2e tests (web)
+        run: npx playwright test
+
   mobile-unit-tests:
     name: Mobile
     runs-on: ubuntu-latest
@@ -204,7 +223,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
@@ -225,7 +244,7 @@ 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 --output-format=github app export
@@ -237,7 +256,20 @@ jobs:
           poetry run mypy --install-types --non-interactive --strict app/
       - name: Run tests and coverage
         run: |
-          poetry run pytest --cov app
+          poetry run pytest app --cov=app --cov-report term-missing
+
+  shellcheck:
+    name: ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          ignore_paths: >-
+            **/open-api/**
+            **/openapi/**
+            **/node_modules/**
 
   generated-api-up-to-date:
     name: OpenAPI Clients
@@ -247,7 +279,7 @@ jobs:
       - name: Run API generation
         run: make open-api
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v18
         id: verify-changed-files
         with:
           files: |
@@ -265,7 +297,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       postgres:
-        image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+        image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
         env:
           POSTGRES_PASSWORD: postgres
           POSTGRES_USER: postgres
@@ -302,7 +334,7 @@ jobs:
         run: npm run typeorm:migrations:generate ./src/infra/migrations/TestMigration
 
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v18
         id: verify-changed-files
         with:
           files: |
@@ -320,7 +352,7 @@ jobs:
           DB_URL: postgres://postgres:postgres@localhost:5432/immich
 
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v18
         id: verify-changed-sql-files
         with:
           files: |

LICENSE

@@ -1,21 +1,620 @@
-MIT License
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
-Copyright (c) 2022 Hau Tran
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+                            Preamble
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

Makefile

@@ -19,6 +19,13 @@ pull-stage:
 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
+
+.PHONY: e2e
+e2e:
+	docker compose -f ./e2e/docker-compose.yml up --build -V --remove-orphans
+
 prod:
 	docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
 

README.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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>
@@ -69,12 +69,17 @@ password: demo
 Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 ```
 
+## Activities
+![Activities](https://repobeats.axiom.co/api/embed/9e86d9dc3ddd137161f2f6d2e758d7863b1789cb.svg "Repobeats analytics image")
+
 ## 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 |
@@ -89,6 +94,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 |
@@ -110,14 +116,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
+- [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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - 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

@@ -1,6 +1,6 @@
 <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=Llicència&logoColor=000000&labelColor=ececec" alt="Llicència: MIT"></a>
+  <a href="https://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=Llicència&logoColor=000000&labelColor=ececec" alt="Llicència: 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" atl="Discord"/>
   </a>
@@ -106,9 +106,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_de_DE.md

@@ -1,6 +1,6 @@
 <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="Lizenz: MIT"></a>
+  <a href="https://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="Lizenz: 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>
@@ -113,7 +113,7 @@ Wenn Du denkst, dass dies die richtige Sache ist und dich selbst die App für ei
 - [Einmalige Spende](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=immich-app) via GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
 
 ## Mitwirkende

README_es_ES.md

@@ -1,6 +1,6 @@
 <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="Licencia: MIT"></a>
+  <a href="https://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="Licencia: 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" atl="Discord"/>
   </a>
@@ -107,9 +107,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_fr_FR.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -108,9 +108,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_it_IT.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -109,9 +109,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_ja_JP.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7

README_ko_KR.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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>
@@ -109,9 +109,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_nl_NL.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -108,9 +108,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_ru_RU.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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>
@@ -111,11 +111,11 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 
 ### Пожертвование
 
-- [Ежемесячное пожертвование](https://github.com/sponsors/alextran1502) via GitHub Sponsors
-- [Одноразовое пожертвование](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
+- [Ежемесячное пожертвование](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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
 
 ## Авторы

README_tr_TR.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -105,9 +105,9 @@ 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
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_zh_CN.md

@@ -1,6 +1,6 @@
 <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://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></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" atl="Discord"/>
   </a>
@@ -115,11 +115,11 @@
 
 ## 捐赠
 
-- 通过 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
+- 比特币: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
 
 ## 贡献者

cli/.eslintrc.cjs

@@ -6,11 +6,10 @@ module.exports = {
     tsconfigRootDir: __dirname,
   },
   plugins: ['@typescript-eslint/eslint-plugin'],
-  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended', 'plugin:unicorn/recommended'],
   root: true,
   env: {
     node: true,
-    jest: true,
   },
   ignorePatterns: ['.eslintrc.js'],
   rules: {
@@ -19,6 +18,9 @@ module.exports = {
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-floating-promises': 'error',
+    'unicorn/prefer-module': 'off',
+    curly: 2,
     'prettier/prettier': 0,
+    'unicorn/prevent-abbreviations': 'error',
   },
 };

cli/.npmignore

@@ -1,5 +1,4 @@
 **/*.spec.js
-test/**
 upload/**
 .editorconfig
 .eslintignore

cli/.prettierrc

@@ -2,5 +2,7 @@
   "singleQuote": true,
   "trailingComma": "all",
   "printWidth": 120,
-  "semi": true
+  "semi": true,
+  "plugins": ["prettier-plugin-organize-imports"],
+  "organizeImportsSkipDestructiveCodeActions": true
 }

cli/Dockerfile

@@ -1,19 +1,19 @@
-FROM ghcr.io/immich-app/base-server-dev:20240111@sha256:5acf773796f93c7a3216ffdbdb3604dc812f2b2317b84a1b57b65674826b746a as test
+FROM node:20-alpine3.19@sha256:c0a3badbd8a0a760de903e00cedbca94588e609299820557e72cba2a53dbaa2c as core
 
-WORKDIR /usr/src/app/server
-COPY server/package.json server/package-lock.json ./
+WORKDIR /usr/src/open-api/typescript-sdk
+COPY open-api/typescript-sdk/package*.json open-api/typescript-sdk/tsconfig*.json ./
 RUN npm ci
-COPY ./server/ .
+COPY open-api/typescript-sdk/ ./
+RUN npm run build
+
+WORKDIR /usr/src/app
 
-WORKDIR /usr/src/app/cli
 COPY cli/package.json cli/package-lock.json ./
 RUN npm ci
-COPY ./cli/ .
 
-FROM ghcr.io/immich-app/base-server-prod:20240111@sha256:e917605008977f68dc3b6f7879c264cae4bff6c4186b119a6e114a60f8f5a354
+COPY cli .
+RUN npm run build
 
-VOLUME /usr/src/app/upload
+WORKDIR /import
 
-EXPOSE 3001
-
-ENTRYPOINT ["tini", "--", "/bin/sh"]
+ENTRYPOINT ["node", "/usr/src/app/dist"]

cli/LICENSE

@@ -1,21 +1,620 @@
-MIT License
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
-Copyright (c) 2022 Hau Tran
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+                            Preamble
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

cli/package.json

@@ -1,94 +1,64 @@
 {
   "name": "@immich/cli",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "Command Line Interface (CLI) for Immich",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
   "bin": {
-    "immich": "./dist/src/index.js"
+    "immich": "dist/index.js"
   },
-  "license": "MIT",
+  "license": "GNU Affero General Public License version 3",
   "keywords": [
     "immich",
     "cli"
   ],
-  "dependencies": {
-    "@immich/sdk": "file:../open-api/typescript-sdk",
-    "axios": "^1.6.2",
-    "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",
+    "@immich/sdk": "file:../open-api/typescript-sdk",
+    "@testcontainers/postgresql": "^10.7.1",
     "@types/byte-size": "^8.1.0",
     "@types/cli-progress": "^3.11.0",
-    "@types/jest": "^29.5.2",
+    "@types/lodash-es": "^4.17.12",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^20.3.1",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "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": "^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",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^1.2.2",
+    "byte-size": "^8.1.1",
+    "cli-progress": "^3.12.0",
+    "commander": "^12.0.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-unicorn": "^51.0.0",
+    "glob": "^10.3.1",
     "mock-fs": "^5.2.0",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.5.3",
-    "typescript": "^5.0.0"
+    "prettier": "^3.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.12",
+    "vitest": "^1.2.2",
+    "yaml": "^2.3.1"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
+    "build": "vite build",
+    "lint": "eslint \"src/**/*.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": "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"
+    "check": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
-    "url": "github:immich-app/immich",
+    "url": "git+https://github.com/immich-app/immich.git",
     "directory": "cli"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "lodash-es": "^4.17.21"
   }
 }

cli/src/api/client.ts

@@ -1,52 +0,0 @@
-import {
-  AlbumApi,
-  APIKeyApi,
-  AssetApi,
-  AuthenticationApi,
-  Configuration,
-  JobApi,
-  OAuthApi,
-  ServerInfoApi,
-  SystemConfigApi,
-  UserApi,
-} from '@immich/sdk';
-import { ApiConfiguration } from '../cores/api-configuration';
-import FormData from 'form-data';
-
-export class ImmichApi {
-  public userApi: UserApi;
-  public albumApi: AlbumApi;
-  public assetApi: AssetApi;
-  public authenticationApi: AuthenticationApi;
-  public oauthApi: OAuthApi;
-  public serverInfoApi: ServerInfoApi;
-  public jobApi: JobApi;
-  public keyApi: APIKeyApi;
-  public systemConfigApi: SystemConfigApi;
-
-  private readonly config;
-  public readonly apiConfiguration: ApiConfiguration;
-
-  constructor(instanceUrl: string, apiKey: string) {
-    this.apiConfiguration = new ApiConfiguration(instanceUrl, apiKey);
-    this.config = new Configuration({
-      basePath: instanceUrl,
-      baseOptions: {
-        headers: {
-          'x-api-key': apiKey,
-        },
-      },
-      formDataCtor: FormData,
-    });
-
-    this.userApi = new UserApi(this.config);
-    this.albumApi = new AlbumApi(this.config);
-    this.assetApi = new AssetApi(this.config);
-    this.authenticationApi = new AuthenticationApi(this.config);
-    this.oauthApi = new OAuthApi(this.config);
-    this.serverInfoApi = new ServerInfoApi(this.config);
-    this.jobApi = new JobApi(this.config);
-    this.keyApi = new APIKeyApi(this.config);
-    this.systemConfigApi = new SystemConfigApi(this.config);
-  }
-}

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 '@immich/sdk';
-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,20 @@
+import { ServerVersionResponseDto, UserResponseDto } from '@immich/sdk';
+import { ImmichApi } from 'src/services/api.service';
+import { SessionService } from '../services/session.service';
+
+export abstract class BaseCommand {
+  protected sessionService!: SessionService;
+  protected user!: UserResponseDto;
+  protected serverVersion!: ServerVersionResponseDto;
+
+  constructor(options: { configDirectory?: string }) {
+    if (!options.configDirectory) {
+      throw new Error('Config directory is required');
+    }
+    this.sessionService = new SessionService(options.configDirectory);
+  }
+
+  public async connect(): Promise<ImmichApi> {
+    return await this.sessionService.connect();
+  }
+}

cli/src/commands/login.command.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 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 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() {
+    const api = await this.connect();
+    const versionInfo = await api.getServerVersion();
+    const mediaTypes = await api.getSupportedMediaTypes();
+    const statistics = await api.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 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

@@ -0,0 +1,444 @@
+import { AssetBulkUploadCheckResult } from '@immich/sdk';
+import byteSize from 'byte-size';
+import cliProgress from 'cli-progress';
+import { chunk, zip } from 'lodash-es';
+import { createHash } from 'node:crypto';
+import fs, { createReadStream } from 'node:fs';
+import { access, constants, stat, unlink } from 'node:fs/promises';
+import os from 'node:os';
+import { basename } from 'node:path';
+import { ImmichApi } from 'src/services/api.service';
+import { CrawlService } from '../services/crawl.service';
+import { BaseCommand } from './base-command';
+
+const zipDefined = zip as <T, U>(a: T[], b: U[]) => [T, U][];
+
+enum CheckResponseStatus {
+  ACCEPT = 'accept',
+  REJECT = 'reject',
+  DUPLICATE = 'duplicate',
+}
+
+class Asset {
+  readonly path: string;
+
+  id?: string;
+  deviceAssetId?: string;
+  fileCreatedAt?: Date;
+  fileModifiedAt?: Date;
+  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}`.replaceAll(/\s+/g, '');
+    this.fileCreatedAt = stats.mtime;
+    this.fileModifiedAt = stats.mtime;
+    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: Blob | undefined = undefined;
+    try {
+      await access(sideCarPath, constants.R_OK);
+      sidecarData = new File([await fs.openAsBlob(sideCarPath)], basename(sideCarPath));
+    } catch {}
+
+    const data: any = {
+      assetData: new File([await fs.openAsBlob(this.path)], basename(this.path)),
+      deviceAssetId: this.deviceAssetId,
+      deviceId: 'CLI',
+      fileCreatedAt: this.fileCreatedAt,
+      fileModifiedAt: this.fileModifiedAt,
+      isFavorite: String(false),
+    };
+    const formData = new FormData();
+
+    for (const property in data) {
+      formData.append(property, data[property]);
+    }
+
+    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 | undefined {
+    return os.platform() === 'win32' ? this.path.split('\\').at(-2) : this.path.split('/').at(-2);
+  }
+}
+
+export class UploadOptionsDto {
+  recursive? = false;
+  exclusionPatterns?: string[] = [];
+  dryRun? = false;
+  skipHash? = false;
+  delete? = false;
+  album? = false;
+  albumName? = '';
+  includeHidden? = false;
+  concurrency? = 4;
+}
+
+export class UploadCommand extends BaseCommand {
+  api!: ImmichApi;
+
+  public async run(paths: string[], options: UploadOptionsDto): Promise<void> {
+    this.api = await this.connect();
+
+    console.log('Crawling for assets...');
+    const files = await this.getFiles(paths, options);
+
+    if (files.length === 0) {
+      console.log('No assets found, exiting');
+      return;
+    }
+
+    const assetsToCheck = files.map((path) => new Asset(path));
+
+    const { newAssets, duplicateAssets } = await this.checkAssets(assetsToCheck, options.concurrency ?? 4);
+
+    const totalSizeUploaded = await this.upload(newAssets, options);
+    const messageStart = options.dryRun ? 'Would have' : 'Successfully';
+    if (newAssets.length === 0) {
+      console.log('All assets were already uploaded, nothing to do.');
+    } else {
+      console.log(
+        `${messageStart} uploaded ${newAssets.length} asset${newAssets.length === 1 ? '' : 's'} (${byteSize(totalSizeUploaded)})`,
+      );
+    }
+
+    if (options.album || options.albumName) {
+      const { createdAlbumCount, updatedAssetCount } = await this.updateAlbums(
+        [...newAssets, ...duplicateAssets],
+        options,
+      );
+      console.log(`${messageStart} created ${createdAlbumCount} new album${createdAlbumCount === 1 ? '' : 's'}`);
+      console.log(`${messageStart} updated ${updatedAssetCount} asset${updatedAssetCount === 1 ? '' : 's'}`);
+    }
+
+    if (!options.delete) {
+      return;
+    }
+
+    if (options.dryRun) {
+      console.log(`Would now have deleted assets, but skipped due to dry run`);
+      return;
+    }
+
+    console.log('Deleting assets that have been uploaded...');
+
+    await this.deleteAssets(newAssets, options);
+  }
+
+  public async checkAssets(
+    assetsToCheck: Asset[],
+    concurrency: number,
+  ): Promise<{ newAssets: Asset[]; duplicateAssets: Asset[]; rejectedAssets: Asset[] }> {
+    for (const assets of chunk(assetsToCheck, concurrency)) {
+      await Promise.all(assets.map((asset: Asset) => asset.prepare()));
+    }
+
+    const checkProgress = new cliProgress.SingleBar(
+      { format: 'Checking assets | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets' },
+      cliProgress.Presets.shades_classic,
+    );
+    checkProgress.start(assetsToCheck.length, 0);
+
+    const newAssets = [];
+    const duplicateAssets = [];
+    const rejectedAssets = [];
+    try {
+      for (const assets of chunk(assetsToCheck, concurrency)) {
+        const checkedAssets = await this.getStatus(assets);
+        for (const checked of checkedAssets) {
+          if (checked.status === CheckResponseStatus.ACCEPT) {
+            newAssets.push(checked.asset);
+          } else if (checked.status === CheckResponseStatus.DUPLICATE) {
+            duplicateAssets.push(checked.asset);
+          } else {
+            rejectedAssets.push(checked.asset);
+          }
+          checkProgress.increment();
+        }
+      }
+    } finally {
+      checkProgress.stop();
+    }
+
+    return { newAssets, duplicateAssets, rejectedAssets };
+  }
+
+  public async upload(assetsToUpload: Asset[], options: UploadOptionsDto): Promise<number> {
+    let totalSize = 0;
+
+    // Compute total size first
+    for (const asset of assetsToUpload) {
+      totalSize += asset.fileSize ?? 0;
+    }
+
+    if (options.dryRun) {
+      return totalSize;
+    }
+
+    const uploadProgress = new cliProgress.SingleBar(
+      {
+        format: 'Uploading assets | {bar} | {percentage}% | ETA: {eta_formatted} | {value_formatted}/{total_formatted}',
+      },
+      cliProgress.Presets.shades_classic,
+    );
+    uploadProgress.start(totalSize, 0);
+    uploadProgress.update({ value_formatted: 0, total_formatted: byteSize(totalSize) });
+
+    let totalSizeUploaded = 0;
+    try {
+      for (const assets of chunk(assetsToUpload, options.concurrency)) {
+        const ids = await this.uploadAssets(assets);
+        for (const [asset, id] of zipDefined(assets, ids)) {
+          asset.id = id;
+          if (asset.fileSize) {
+            totalSizeUploaded += asset.fileSize ?? 0;
+          } else {
+            console.log(`Could not determine file size for ${asset.path}`);
+          }
+        }
+        uploadProgress.update(totalSizeUploaded, { value_formatted: byteSize(totalSizeUploaded) });
+      }
+    } finally {
+      uploadProgress.stop();
+    }
+
+    return totalSizeUploaded;
+  }
+
+  public async getFiles(paths: string[], options: UploadOptionsDto): Promise<string[]> {
+    const inputFiles: string[] = [];
+    for (const pathArgument of paths) {
+      const fileStat = await fs.promises.lstat(pathArgument);
+      if (fileStat.isFile()) {
+        inputFiles.push(pathArgument);
+      }
+    }
+
+    const files: string[] = await this.crawl(paths, options);
+    files.push(...inputFiles);
+    return files;
+  }
+
+  public async getAlbums(): Promise<Map<string, string>> {
+    const existingAlbums = await this.api.getAllAlbums();
+
+    const albumMapping = new Map<string, string>();
+    for (const album of existingAlbums) {
+      albumMapping.set(album.albumName, album.id);
+    }
+
+    return albumMapping;
+  }
+
+  public async updateAlbums(
+    assets: Asset[],
+    options: UploadOptionsDto,
+  ): Promise<{ createdAlbumCount: number; updatedAssetCount: number }> {
+    if (options.albumName) {
+      for (const asset of assets) {
+        asset.albumName = options.albumName;
+      }
+    }
+
+    const existingAlbums = await this.getAlbums();
+    const assetsToUpdate = assets.filter(
+      (asset): asset is Asset & { albumName: string; id: string } => !!(asset.albumName && asset.id),
+    );
+
+    const newAlbumsSet: Set<string> = new Set();
+    for (const asset of assetsToUpdate) {
+      if (!existingAlbums.has(asset.albumName)) {
+        newAlbumsSet.add(asset.albumName);
+      }
+    }
+
+    const newAlbums = [...newAlbumsSet];
+
+    if (options.dryRun) {
+      return { createdAlbumCount: newAlbums.length, updatedAssetCount: assetsToUpdate.length };
+    }
+
+    const albumCreationProgress = new cliProgress.SingleBar(
+      {
+        format: 'Creating albums | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} albums',
+      },
+      cliProgress.Presets.shades_classic,
+    );
+    albumCreationProgress.start(newAlbums.length, 0);
+
+    try {
+      for (const albumNames of chunk(newAlbums, options.concurrency)) {
+        const newAlbumIds = await Promise.all(
+          albumNames.map((albumName: string) => this.api.createAlbum({ albumName }).then((r) => r.id)),
+        );
+
+        for (const [albumName, albumId] of zipDefined(albumNames, newAlbumIds)) {
+          existingAlbums.set(albumName, albumId);
+        }
+
+        albumCreationProgress.increment(albumNames.length);
+      }
+    } finally {
+      albumCreationProgress.stop();
+    }
+
+    const albumToAssets = new Map<string, string[]>();
+    for (const asset of assetsToUpdate) {
+      const albumId = existingAlbums.get(asset.albumName);
+      if (albumId) {
+        if (!albumToAssets.has(albumId)) {
+          albumToAssets.set(albumId, []);
+        }
+        albumToAssets.get(albumId)?.push(asset.id);
+      }
+    }
+
+    const albumUpdateProgress = new cliProgress.SingleBar(
+      {
+        format: 'Adding assets to albums | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets',
+      },
+      cliProgress.Presets.shades_classic,
+    );
+    albumUpdateProgress.start(assetsToUpdate.length, 0);
+
+    try {
+      for (const [albumId, assets] of albumToAssets.entries()) {
+        for (const assetBatch of chunk(assets, Math.min(1000 * (options.concurrency ?? 4), 65_000))) {
+          await this.api.addAssetsToAlbum(albumId, { ids: assetBatch });
+          albumUpdateProgress.increment(assetBatch.length);
+        }
+      }
+    } finally {
+      albumUpdateProgress.stop();
+    }
+
+    return { createdAlbumCount: newAlbums.length, updatedAssetCount: assetsToUpdate.length };
+  }
+
+  public async deleteAssets(assets: Asset[], options: UploadOptionsDto): Promise<void> {
+    const deletionProgress = new cliProgress.SingleBar(
+      {
+        format: 'Deleting local assets | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets',
+      },
+      cliProgress.Presets.shades_classic,
+    );
+    deletionProgress.start(assets.length, 0);
+
+    try {
+      for (const assetBatch of chunk(assets, options.concurrency)) {
+        await Promise.all(assetBatch.map((asset: Asset) => asset.delete()));
+        deletionProgress.update(assetBatch.length);
+      }
+    } finally {
+      deletionProgress.stop();
+    }
+  }
+
+  private async getStatus(assets: Asset[]): Promise<{ asset: Asset; status: CheckResponseStatus }[]> {
+    const checkResponse = await this.checkHashes(assets);
+
+    const responses = [];
+    for (const [check, asset] of zipDefined(checkResponse, assets)) {
+      if (check.assetId) {
+        asset.id = check.assetId;
+      }
+
+      if (check.action === 'accept') {
+        responses.push({ asset, status: CheckResponseStatus.ACCEPT });
+      } else if (check.reason === 'duplicate') {
+        responses.push({ asset, status: CheckResponseStatus.DUPLICATE });
+      } else {
+        responses.push({ asset, status: CheckResponseStatus.REJECT });
+      }
+    }
+
+    return responses;
+  }
+
+  private async checkHashes(assetsToCheck: Asset[]): Promise<AssetBulkUploadCheckResult[]> {
+    const checksums = await Promise.all(assetsToCheck.map((asset) => asset.hash()));
+    const assetBulkUploadCheckDto = {
+      assets: zipDefined(assetsToCheck, checksums).map(([asset, checksum]) => ({ id: asset.path, checksum })),
+    };
+    const checkResponse = await this.api.checkBulkUpload(assetBulkUploadCheckDto);
+    return checkResponse.results;
+  }
+
+  private async uploadAssets(assets: Asset[]): Promise<string[]> {
+    const fileRequests = await Promise.all(assets.map((asset) => asset.getUploadFormData()));
+    return Promise.all(fileRequests.map((request) => this.uploadAsset(request).then((response) => response.id)));
+  }
+
+  private async crawl(paths: string[], options: UploadOptionsDto): Promise<string[]> {
+    const formatResponse = await this.api.getSupportedMediaTypes();
+    const crawlService = new CrawlService(formatResponse.image, formatResponse.video);
+
+    return crawlService.crawl({
+      pathsToCrawl: paths,
+      recursive: options.recursive,
+      exclusionPatterns: options.exclusionPatterns,
+      includeHidden: options.includeHidden,
+    });
+  }
+
+  private async uploadAsset(data: FormData): Promise<{ id: string }> {
+    const url = this.api.instanceUrl + '/asset/upload';
+
+    const response = await fetch(url, {
+      method: 'post',
+      redirect: 'error',
+      headers: {
+        'x-api-key': this.api.apiKey,
+      },
+      body: data,
+    });
+    if (response.status !== 200 && response.status !== 201) {
+      throw new Error(await response.text());
+    }
+    return response.json();
+  }
+}

cli/src/commands/upload.ts

@@ -1,193 +0,0 @@
-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 byteSize from 'byte-size';
-import { BaseCommand } from '../cli/base-command';
-import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-import FormData from 'form-data';
-
-export class Upload extends BaseCommand {
-  uploadLength!: number;
-
-  public async run(paths: string[], options: UploadOptionsDto): Promise<void> {
-    await this.connect();
-
-    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[] = [];
-
-    for (const pathArgument of paths) {
-      const fileStat = await fs.promises.lstat(pathArgument);
-
-      if (fileStat.isFile()) {
-        files.push(pathArgument);
-      }
-    }
-
-    const crawledFiles: string[] = await crawlService.crawl(crawlOptions);
-
-    crawledFiles.push(...files);
-
-    if (crawledFiles.length === 0) {
-      console.log('No assets found, exiting');
-      return;
-    }
-
-    const assetsToUpload = crawledFiles.map((path) => new Asset(path));
-
-    const uploadProgress = new cliProgress.SingleBar(
-      {
-        format: '{bar} | {percentage}% | ETA: {eta_formatted} | {value_formatted}/{total_formatted}: {filename}',
-      },
-      cliProgress.Presets.shades_classic,
-    );
-
-    let totalSize = 0;
-    let sizeSoFar = 0;
-
-    let totalSizeUploaded = 0;
-    let uploadCounter = 0;
-
-    for (const asset of assetsToUpload) {
-      // Compute total size first
-      await asset.prepare();
-      totalSize += asset.fileSize;
-
-      if (options.albumName) {
-        asset.albumName = options.albumName;
-      }
-    }
-
-    const existingAlbums = (await this.immichApi.albumApi.getAllAlbums()).data;
-
-    uploadProgress.start(totalSize, 0);
-    uploadProgress.update({ value_formatted: 0, total_formatted: byteSize(totalSize) });
-
-    try {
-      for (const asset of assetsToUpload) {
-        uploadProgress.update({
-          filename: asset.path,
-        });
-
-        let skipUpload = false;
-
-        let skipAsset = false;
-        let existingAssetId: string | undefined = undefined;
-
-        if (!options.skipHash) {
-          const assetBulkUploadCheckDto = { assets: [{ id: asset.path, checksum: await asset.hash() }] };
-
-          const checkResponse = await this.immichApi.assetApi.checkBulkUpload({
-            assetBulkUploadCheckDto,
-          });
-
-          skipUpload = checkResponse.data.results[0].action === 'reject';
-
-          const isDuplicate = checkResponse.data.results[0].reason === 'duplicate';
-          if (isDuplicate) {
-            existingAssetId = checkResponse.data.results[0].assetId;
-          }
-
-          skipAsset = skipUpload && !isDuplicate;
-        }
-
-        if (!skipAsset) {
-          if (!options.dryRun) {
-            if (!skipUpload) {
-              const formData = asset.getUploadFormData();
-              const res = await this.uploadAsset(formData);
-              existingAssetId = res.data.id;
-              uploadCounter++;
-              totalSizeUploaded += asset.fileSize;
-            }
-
-            if ((options.album || options.albumName) && asset.albumName !== undefined) {
-              let album = existingAlbums.find((album) => album.albumName === asset.albumName);
-              if (!album) {
-                const res = await this.immichApi.albumApi.createAlbum({
-                  createAlbumDto: { albumName: asset.albumName },
-                });
-                album = res.data;
-                existingAlbums.push(album);
-              }
-
-              if (existingAssetId) {
-                await this.immichApi.albumApi.addAssetsToAlbum({
-                  id: album.id,
-                  bulkIdsDto: { ids: [existingAssetId] },
-                });
-              }
-            }
-          }
-        }
-
-        sizeSoFar += asset.fileSize;
-
-        uploadProgress.update(sizeSoFar, { value_formatted: byteSize(sizeSoFar) });
-      }
-    } finally {
-      uploadProgress.stop();
-    }
-
-    let messageStart;
-    if (options.dryRun) {
-      messageStart = 'Would have';
-    } else {
-      messageStart = 'Successfully';
-    }
-
-    if (uploadCounter === 0) {
-      console.log('All assets were already uploaded, nothing to do.');
-    } else {
-      console.log(`${messageStart} uploaded ${uploadCounter} assets (${byteSize(totalSizeUploaded)})`);
-    }
-    if (options.delete) {
-      if (options.dryRun) {
-        console.log(`Would now have deleted assets, but skipped due to dry run`);
-      } else {
-        console.log('Deleting assets that have been uploaded...');
-        const deletionProgress = new cliProgress.SingleBar(cliProgress.Presets.shades_classic);
-        deletionProgress.start(crawledFiles.length, 0);
-
-        for (const asset of assetsToUpload) {
-          if (!options.dryRun) {
-            await asset.delete();
-          }
-          deletionProgress.increment();
-        }
-        deletionProgress.stop();
-        console.log('Deletion complete');
-      }
-    }
-  }
-
-  private async uploadAsset(data: FormData): Promise<AxiosResponse> {
-    const url = this.immichApi.apiConfiguration.instanceUrl + '/asset/upload';
-
-    const config: AxiosRequestConfig = {
-      method: 'post',
-      maxRedirects: 0,
-      url,
-      headers: {
-        'x-api-key': this.immichApi.apiConfiguration.apiKey,
-        ...data.getHeaders(),
-      },
-      maxContentLength: Infinity,
-      maxBodyLength: Infinity,
-      data,
-    };
-
-    const res = await axios(config);
-    return res;
-  }
-}

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,91 +0,0 @@
-import crypto from 'crypto';
-import FormData from 'form-data';
-import * as fs from 'graceful-fs';
-import { createReadStream } from 'node:fs';
-import { basename } from 'node:path';
-import Os from 'os';
-
-export 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 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();
-  }
-
-  getUploadFormData(): 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: fs.ReadStream | undefined = undefined;
-    try {
-      fs.accessSync(sideCarPath, fs.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 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,23 +1,24 @@
 #! /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 os from 'node:os';
 import path from 'node:path';
-import os from 'os';
+import { version } from '../package.json';
+import { LoginCommand } from './commands/login.command';
+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/');
+const defaultConfigDirectory = path.join(os.homedir(), '.config/immich/');
 
 const program = new Command()
   .name('immich')
   .version(version)
   .description('Command line interface for Immich')
-  .addOption(new Option('-d, --config', 'Configuration directory').env('IMMICH_CONFIG_DIR').default(configDir));
+  .addOption(
+    new Option('-d, --config-directory <directory>', 'Configuration directory where auth.yml will be stored')
+      .env('IMMICH_CONFIG_DIR')
+      .default(defaultConfigDirectory),
+  );
 
 program
   .command('upload')
@@ -26,7 +27,7 @@ program
   .addOption(new Option('-r, --recursive', 'Recursive').env('IMMICH_RECURSIVE').default(false))
   .addOption(new Option('-i, --ignore [paths...]', 'Paths to ignore').env('IMMICH_IGNORE_PATHS'))
   .addOption(new Option('-h, --skip-hash', "Don't hash files before upload").env('IMMICH_SKIP_HASH').default(false))
-  .addOption(new Option('-i, --include-hidden', 'Include hidden folders').env('IMMICH_INCLUDE_HIDDEN').default(false))
+  .addOption(new Option('-H, --include-hidden', 'Include hidden folders').env('IMMICH_INCLUDE_HIDDEN').default(false))
   .addOption(
     new Option('-a, --album', 'Automatically create albums based on folder name')
       .env('IMMICH_AUTO_CREATE_ALBUM')
@@ -42,34 +43,39 @@ program
       .env('IMMICH_DRY_RUN')
       .default(false),
   )
+  .addOption(
+    new Option('-c, --concurrency', 'Number of assets to upload at the same time')
+      .env('IMMICH_UPLOAD_CONCURRENCY')
+      .default(4),
+  )
   .addOption(new Option('--delete', 'Delete local assets after upload').env('IMMICH_DELETE_ASSETS'))
   .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
   .command('login-key')
   .description('Login using an API key')
-  .argument('[instanceUrl]')
-  .argument('[apiKey]')
-  .action(async (paths, options) => {
-    await new LoginKey(program.opts()).run(paths, options);
+  .argument('url')
+  .argument('key')
+  .action(async (url, key) => {
+    await new LoginCommand(program.opts()).run(url, key);
   });
 
 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

@@ -0,0 +1,106 @@
+import {
+  ApiKeyCreateDto,
+  AssetBulkUploadCheckDto,
+  BulkIdsDto,
+  CreateAlbumDto,
+  CreateAssetDto,
+  LoginCredentialDto,
+  SignUpDto,
+  addAssetsToAlbum,
+  checkBulkUpload,
+  createAlbum,
+  createApiKey,
+  getAllAlbums,
+  getAllAssets,
+  getAssetStatistics,
+  getMyUserInfo,
+  getServerVersion,
+  getSupportedMediaTypes,
+  login,
+  pingServer,
+  signUpAdmin,
+  uploadFile,
+} from '@immich/sdk';
+
+/**
+ * Wraps the underlying API to abstract away the options and make API calls mockable for testing.
+ */
+export class ImmichApi {
+  private readonly options;
+
+  constructor(
+    public instanceUrl: string,
+    public apiKey: string,
+  ) {
+    this.options = {
+      baseUrl: instanceUrl,
+      headers: {
+        'x-api-key': apiKey,
+      },
+    };
+  }
+
+  setApiKey(apiKey: string) {
+    this.apiKey = apiKey;
+    if (!this.options.headers) {
+      throw new Error('missing headers');
+    }
+    this.options.headers['x-api-key'] = apiKey;
+  }
+
+  addAssetsToAlbum(id: string, bulkIdsDto: BulkIdsDto) {
+    return addAssetsToAlbum({ id, bulkIdsDto }, this.options);
+  }
+
+  checkBulkUpload(assetBulkUploadCheckDto: AssetBulkUploadCheckDto) {
+    return checkBulkUpload({ assetBulkUploadCheckDto }, this.options);
+  }
+
+  createAlbum(createAlbumDto: CreateAlbumDto) {
+    return createAlbum({ createAlbumDto }, this.options);
+  }
+
+  createApiKey(apiKeyCreateDto: ApiKeyCreateDto, options: { headers: { Authorization: string } }) {
+    return createApiKey({ apiKeyCreateDto }, { ...this.options, ...options });
+  }
+
+  getAllAlbums() {
+    return getAllAlbums({}, this.options);
+  }
+
+  getAllAssets() {
+    return getAllAssets({}, this.options);
+  }
+
+  getAssetStatistics() {
+    return getAssetStatistics({}, this.options);
+  }
+
+  getMyUserInfo() {
+    return getMyUserInfo(this.options);
+  }
+
+  getServerVersion() {
+    return getServerVersion(this.options);
+  }
+
+  getSupportedMediaTypes() {
+    return getSupportedMediaTypes(this.options);
+  }
+
+  login(loginCredentialDto: LoginCredentialDto) {
+    return login({ loginCredentialDto }, this.options);
+  }
+
+  pingServer() {
+    return pingServer(this.options);
+  }
+
+  signUpAdmin(signUpDto: SignUpDto) {
+    return signUpAdmin({ signUpDto }, this.options);
+  }
+
+  uploadFile(createAssetDto: CreateAssetDto) {
+    return uploadFile({ createAssetDto }, this.options);
+  }
+}

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 { CrawlOptions, CrawlService } from './crawl.service';
 
 interface Test {
   test: string;
-  options: CrawlOptionsDto;
+  options: CrawlOptions;
   files: Record<string, boolean>;
 }
 

cli/src/services/crawl.service.ts

@@ -1,18 +1,25 @@
-import { CrawlOptionsDto } from 'src/cores/dto/crawl-options-dto';
 import { glob } from 'glob';
-import * as fs from 'fs';
+import * as fs from 'node:fs';
+
+export class CrawlOptions {
+  pathsToCrawl!: string[];
+  recursive? = false;
+  includeHidden? = false;
+  exclusionPatterns?: string[];
+}
 
 export class CrawlService {
   private readonly extensions!: string[];
 
   constructor(image: string[], video: string[]) {
-    this.extensions = image.concat(video).map((extension) => extension.replace('.', ''));
+    this.extensions = [...image, ...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([]);
+      return [];
     }
 
     const patterns: string[] = [];
@@ -44,7 +51,7 @@ export class CrawlService {
       searchPattern = '{' + patterns.join(',') + '}';
     }
 
-    if (crawlOptions.recursive) {
+    if (recursive) {
       searchPattern = searchPattern + '/**/';
     }
 
@@ -58,8 +65,6 @@ export class CrawlService {
       ignore: exclusionPatterns,
     });
 
-    const returnedFiles = crawledFiles.concat(globbedFiles);
-    returnedFiles.sort();
-    return returnedFiles;
+    return [...crawledFiles, ...globbedFiles].sort();
   }
 }

cli/src/services/index.ts

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

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

@@ -1,40 +1,58 @@
-import { SessionService } from './session.service';
 import fs from 'node:fs';
+import path from 'node:path';
 import yaml from 'yaml';
-import { LoginError } from '../cores/errors/login-error';
-import {
-  TEST_AUTH_FILE,
-  TEST_CONFIG_DIR,
-  TEST_IMMICH_API_KEY,
-  TEST_IMMICH_INSTANCE_URL,
-  createTestAuthFile,
-  deleteAuthFile,
-  readTestAuthFile,
-  spyOnConsole,
-} from '../../test/cli-test-utils';
+import { SessionService } from './session.service';
 
-const mockPingServer = jest.fn(() => Promise.resolve({ data: { res: 'pong' } }));
-const mockUserInfo = jest.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
+const TEST_CONFIG_DIR = '/tmp/immich/';
+const TEST_AUTH_FILE = path.join(TEST_CONFIG_DIR, 'auth.yml');
+const TEST_IMMICH_INSTANCE_URL = 'https://test/api';
+const TEST_IMMICH_API_KEY = 'pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg';
 
-jest.mock('@immich/sdk', () => {
+const spyOnConsole = () => vi.spyOn(console, 'log').mockImplementation(() => {});
+
+const createTestAuthFile = async (contents: string) => {
+  if (!fs.existsSync(TEST_CONFIG_DIR)) {
+    // Create config folder if it doesn't exist
+    const created = await fs.promises.mkdir(TEST_CONFIG_DIR, { recursive: true });
+    if (!created) {
+      throw new Error(`Failed to create config folder ${TEST_CONFIG_DIR}`);
+    }
+  }
+
+  fs.writeFileSync(TEST_AUTH_FILE, contents);
+};
+
+const readTestAuthFile = async (): Promise<string> => {
+  return await fs.promises.readFile(TEST_AUTH_FILE, 'utf8');
+};
+
+const deleteAuthFile = () => {
+  try {
+    fs.unlinkSync(TEST_AUTH_FILE);
+  } catch (error: any) {
+    if (error.code !== 'ENOENT') {
+      throw error;
+    }
+  }
+};
+
+const mocks = vi.hoisted(() => {
   return {
-    ...jest.requireActual('@immich/sdk'),
-    UserApi: jest.fn().mockImplementation(() => {
-      return { getMyUserInfo: mockUserInfo };
-    }),
-    ServerInfoApi: jest.fn().mockImplementation(() => {
-      return { pingServer: mockPingServer };
-    }),
+    getMyUserInfo: vi.fn(() => Promise.resolve({ email: 'admin@example.com' })),
+    pingServer: vi.fn(() => Promise.resolve({ res: 'pong' })),
   };
 });
 
+vi.mock('./api.service', async (importOriginal) => {
+  const module = await importOriginal<typeof import('./api.service')>();
+  // @ts-expect-error this is only a partial implementation of the return value
+  module.ImmichApi.prototype.getMyUserInfo = mocks.getMyUserInfo;
+  module.ImmichApi.prototype.pingServer = mocks.pingServer;
+  return module;
+});
+
 describe('SessionService', () => {
   let sessionService: SessionService;
-  let consoleSpy: jest.SpyInstance;
-
-  beforeAll(() => {
-    consoleSpy = spyOnConsole();
-  });
 
   beforeEach(() => {
     deleteAuthFile();
@@ -54,7 +72,7 @@ describe('SessionService', () => {
     );
 
     await sessionService.connect();
-    expect(mockPingServer).toHaveBeenCalledTimes(1);
+    expect(mocks.pingServer).toHaveBeenCalledTimes(1);
   });
 
   it('should error if no auth file exists', async () => {
@@ -70,7 +88,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}`);
     });
   });
@@ -82,13 +99,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);
@@ -97,6 +112,8 @@ describe('SessionService', () => {
   });
 
   it('should delete auth file when logging out', async () => {
+    const consoleSpy = spyOnConsole();
+
     await createTestAuthFile(
       JSON.stringify({
         apiKey: TEST_IMMICH_API_KEY,
@@ -109,6 +126,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,39 @@
-import fs from 'node:fs';
-import yaml from 'yaml';
+import { existsSync } from 'node: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 configDirectory!: string;
   readonly authPath!: string;
-  private api!: ImmichApi;
 
-  constructor(configDir: string) {
-    this.configDir = configDir;
-    this.authPath = path.join(configDir, '/auth.yml');
+  constructor(configDirectory: string) {
+    this.configDirectory = configDirectory;
+    this.authPath = path.join(configDirectory, '/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 +48,54 @@ export class SessionService {
       }
     }
 
-    this.api = new ImmichApi(instanceUrl, apiKey);
+    const api = new ImmichApi(instanceUrl, apiKey);
 
-    await this.ping();
+    const pingResponse = await api.pingServer().catch((error) => {
+      throw new Error(`Failed to connect to server ${instanceUrl}: ${error.message}`, error);
+    });
 
-    return this.api;
+    if (pingResponse.res !== 'pong') {
+      throw new Error(`Could not parse response. Is Immich listening on ${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 userInfo = await api.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.configDirectory)) {
       // Create config folder if it doesn't exist
-      const created = await fs.promises.mkdir(this.configDir, { recursive: true });
+      const created = await mkdir(this.configDirectory, { recursive: true });
       if (!created) {
-        throw new Error(`Failed to create config folder ${this.configDir}`);
+        throw new Error(`Failed to create config folder ${this.configDirectory}`);
       }
     }
 
-    fs.writeFileSync(this.authPath, yaml.stringify({ instanceUrl, apiKey }));
+    await writeFile(this.authPath, yaml.stringify({ instanceUrl, apiKey }), { mode: 0o600 });
 
     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';
+import { version } 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 {
-    const regex = /(?:v)?(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/i;
+  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(version);

cli/test/cli-test-utils.ts

@@ -1,38 +0,0 @@
-import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
-import fs from 'node:fs';
-import path from 'node:path';
-
-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 spyOnConsole = () => jest.spyOn(console, 'log').mockImplementation();
-
-export const createTestAuthFile = async (contents: string) => {
-  if (!fs.existsSync(TEST_CONFIG_DIR)) {
-    // Create config folder if it doesn't exist
-    const created = await fs.promises.mkdir(TEST_CONFIG_DIR, { recursive: true });
-    if (!created) {
-      throw new Error(`Failed to create config folder ${TEST_CONFIG_DIR}`);
-    }
-  }
-
-  fs.writeFileSync(TEST_AUTH_FILE, contents);
-};
-
-export const readTestAuthFile = async (): Promise<string> => {
-  return await fs.promises.readFile(TEST_AUTH_FILE, 'utf8');
-};
-
-export const deleteAuthFile = () => {
-  try {
-    fs.unlinkSync(TEST_AUTH_FILE);
-  } catch (error: any) {
-    if (error.code !== 'ENOENT') {
-      throw error;
-    }
-  }
-};

cli/test/e2e/jest-e2e.json

@@ -1,24 +0,0 @@
-{
-  "moduleFileExtensions": ["js", "json", "ts"],
-  "modulePaths": ["<rootDir>"],
-  "rootDir": "../..",
-  "globalSetup": "<rootDir>/test/e2e/setup.ts",
-  "testEnvironment": "node",
-  "testRegex": ".e2e-spec.ts$",
-  "testTimeout": 6000000,
-  "transform": {
-    "^.+\\.ts$": "ts-jest"
-  },
-  "collectCoverageFrom": [
-    "<rootDir>/src/**/*.(t|j)s",
-    "!<rootDir>/src/**/*.spec.(t|s)s",
-    "!<rootDir>/src/infra/migrations/**"
-  ],
-  "coverageDirectory": "./coverage",
-  "moduleNameMapper": {
-    "^@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"
-  }
-}

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

@@ -1,48 +0,0 @@
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { api } from '@test/../e2e/api/client';
-import { restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
-import { LoginResponseDto } from '@immich/sdk';
-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';
-
-describe(`login-key (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
-  let instanceUrl: string;
-  spyOnConsole();
-
-  beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
-    if (!process.env.IMMICH_INSTANCE_URL) {
-      throw new Error('IMMICH_INSTANCE_URL environment variable not set');
-    } else {
-      instanceUrl = process.env.IMMICH_INSTANCE_URL;
-    }
-  });
-
-  afterAll(async () => {
-    await testApp.teardown();
-    await restoreTempFolder();
-  });
-
-  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;
-  });
-
-  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`),
-    );
-  });
-
-  it('should log in when providing the correct API key', async () => {
-    await new LoginKey(CLI_BASE_OPTIONS).run(instanceUrl, apiKey.secret);
-  });
-});

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

@@ -1,42 +0,0 @@
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { api } from '@test/../e2e/api/client';
-import { restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
-import { LoginResponseDto } from '@immich/sdk';
-import { ServerInfo } from 'src/commands/server-info';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
-
-describe(`server-info (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
-  const consoleSpy = spyOnConsole();
-
-  beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
-  });
-
-  afterAll(async () => {
-    await testApp.teardown();
-    await restoreTempFolder();
-  });
-
-  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;
-  });
-
-  it('should show server version', async () => {
-    await new ServerInfo(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'],
-    ]);
-  });
-});

cli/test/e2e/setup.ts

@@ -1,42 +0,0 @@
-import path from 'path';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { access } from 'fs/promises';
-
-export default async () => {
-  let IMMICH_TEST_ASSET_PATH: string = '';
-
-  if (process.env.IMMICH_TEST_ASSET_PATH === undefined) {
-    IMMICH_TEST_ASSET_PATH = path.normalize(`${__dirname}/../../../server/test/assets/`);
-    process.env.IMMICH_TEST_ASSET_PATH = IMMICH_TEST_ASSET_PATH;
-  } else {
-    IMMICH_TEST_ASSET_PATH = process.env.IMMICH_TEST_ASSET_PATH;
-  }
-
-  const directoryExists = async (dirPath: string) =>
-    await access(dirPath)
-      .then(() => true)
-      .catch(() => false);
-
-  if (!(await directoryExists(`${IMMICH_TEST_ASSET_PATH}/albums`))) {
-    throw new Error(
-      `Test assets not found. Please checkout https://github.com/immich-app/test-assets into ${IMMICH_TEST_ASSET_PATH} before testing`,
-    );
-  }
-
-  if (process.env.DB_HOSTNAME === undefined) {
-    // DB hostname not set which likely means we're not running e2e through docker compose. Start a local postgres container.
-    const pg = await new PostgreSqlContainer('tensorchord/pgvecto-rs:pg14-v0.1.11')
-      .withExposedPorts(5432)
-      .withDatabase('immich')
-      .withUsername('postgres')
-      .withPassword('postgres')
-      .withReuse()
-      .start();
-
-    process.env.DB_URL = pg.getConnectionUri();
-  }
-
-  process.env.NODE_ENV = 'development';
-  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,84 +0,0 @@
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { api } from '@test/../e2e/api/client';
-import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
-import { LoginResponseDto } from '@immich/sdk';
-import { Upload } from 'src/commands/upload';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
-
-describe(`upload (e2e)`, () => {
-  let server: any;
-  let admin: LoginResponseDto;
-  let apiKey: APIKeyCreateResponseDto;
-  spyOnConsole();
-
-  beforeAll(async () => {
-    server = (await testApp.create()).getHttpServer();
-  });
-
-  afterAll(async () => {
-    await testApp.teardown();
-    await restoreTempFolder();
-  });
-
-  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;
-  });
-
-  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);
-    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);
-    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/`], {
-      recursive: true,
-      album: true,
-    });
-
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
-    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/`], {
-      recursive: true,
-    });
-
-    // Upload again, but this time add to album
-    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
-      recursive: true,
-      album: true,
-    });
-
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
-    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/`], {
-      recursive: true,
-      albumName: 'testAlbum',
-    });
-
-    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
-    expect(albums.length).toEqual(1);
-    const testAlbum = albums[0];
-    expect(testAlbum.albumName).toEqual('testAlbum');
-  });
-});

cli/test/global-setup.js

@@ -1,3 +0,0 @@
-module.exports = async () => {
-  process.env.TZ = 'UTC';
-};

cli/testSetup.js

@@ -1,3 +0,0 @@
-// add all jest-extended matchers
-import * as matchers from 'jest-extended';
-expect.extend(matchers);

cli/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": ["dist", "node_modules", "upload", "test", "**/*spec.ts"]
-}

cli/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "esnext",
+    "moduleResolution": "bundler",
     "strict": true,
     "declaration": true,
     "removeComments": true,
@@ -8,7 +9,7 @@
     "experimentalDecorators": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
-    "target": "es2021",
+    "target": "es2022",
     "sourceMap": true,
     "outDir": "./dist",
     "incremental": true,
@@ -19,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"]
+  "exclude": ["dist", "node_modules"]
 }

cli/vite.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  build: {
+    rollupOptions: {
+      input: 'src/index.ts',
+      output: {
+        dir: 'dist',
+      },
+    },
+    ssr: true,
+  },
+  ssr: {
+    // bundle everything except for Node built-ins
+    noExternal: /^(?!node:).*$/,
+  },
+});

cli/vitest.config.ts

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

docker/docker-compose.dev.yml

@@ -44,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:
@@ -54,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:
@@ -79,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:
@@ -95,11 +99,11 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:c5a607fb6e1bb15d32bbcf14db22787d19e428d59e31a5da67511b49bb0f1ccc
+    image: redis:6.2-alpine@sha256:51d6c56749a4243096327e3fb964a48ed92254357108449cb6e23999c37773c5
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+    image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
     env_file:
       - .env
     environment:

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,12 +56,12 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:c5a607fb6e1bb15d32bbcf14db22787d19e428d59e31a5da67511b49bb0f1ccc
+    image: redis:6.2-alpine@sha256:51d6c56749a4243096327e3fb964a48ed92254357108449cb6e23999c37773c5
     restart: always
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+    image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
     env_file:
       - .env
     environment:
@@ -65,7 +70,8 @@ services:
       POSTGRES_DB: ${DB_DATABASE_NAME}
     volumes:
       - ${UPLOAD_LOCATION}/postgres:/var/lib/postgresql/data
-    restart: always
+    ports:
+      - 5432:5432
 
 volumes:
   model-cache:

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,14 +60,12 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:c5a607fb6e1bb15d32bbcf14db22787d19e428d59e31a5da67511b49bb0f1ccc
+    image: redis:6.2-alpine@sha256:51d6c56749a4243096327e3fb964a48ed92254357108449cb6e23999c37773c5
     restart: always
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
-    env_file:
-      - .env
+    image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
     environment:
       POSTGRES_PASSWORD: ${DB_PASSWORD}
       POSTGRES_USER: ${DB_USERNAME}

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]

docker/mlaccel-armnn.yml

@@ -1,11 +0,0 @@
-version: "3.8"
-
-# ML acceleration on supported Mali ARM GPUs using ARM-NN
-
-services:
-  mlaccel:
-    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)

docs/blog/2023/06-24/update.mdx

@@ -91,7 +91,7 @@ Thank you, and I am asking for your support for the project. I hope to be a full
 - One-time donation via [GitHub Sponsors](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
 - [Liberapay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - Give a project a star - the contributors love gazing at the stars and seeing their creations shining in the sky.
 
 Join our friendly [Discord](https://discord.gg/D8JsnBEuKb) to talk and discuss Immich, tech, or anything

docs/blog/2023/07-29/update.mdx

@@ -139,7 +139,7 @@ Thank you, and I am asking for your support for the project. I hope to be a full
 - One-time donation via [GitHub Sponsors](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
 - [Liberapay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
+- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
 - Give a project a star - the contributors love gazing at the stars and seeing their creations shining in the sky.
 
 Join our friendly [Discord](https://discord.gg/D8JsnBEuKb) to talk and discuss Immich, tech, or anything

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.mdx

@@ -16,18 +16,18 @@ You can see the list of all users by running [list-users](/docs/administration/s
 
 ### 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                                |
+| Icon                               | Description                                                                                                                                      |
+| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| ![cloud](/img/cloud.svg)           | Asset is only available on the server 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)
+App store updates sometimes take longer because the stores (Google play store and Apple app store)
 need to approve the update first which may take some time.
 :::
 
@@ -54,7 +54,7 @@ This often happens when using a reverse proxy (such as nginx or Cloudflare tunne
 
 ### 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.
+There are a few different scenarios that can lead to this situation. The solution is to 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?
 
@@ -66,11 +66,11 @@ See [Backup and Restore](/docs/administration/backup-and-restore.md).
 
 ### Does Immich support reading existing face tag metadata?
 
-No, it currently does not.
+No, it currently does not. There is an [open feature request on GitHub](https://github.com/immich-app/immich/discussions/4348).
 
 ### 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.
+No, it currently does not. There is an [open feature request on Github](https://github.com/immich-app/immich/discussions/2451).
 
 ### Why are there so many thumbnail generation jobs?
 
@@ -86,9 +86,17 @@ Also, there are additional jobs for person (face) thumbnails.
 
 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.
+
+### Why does Immich transcode my videos to a lower quality?
+
+Immich always keeps your original files. Alongside that, it generates a transcoded version for compatibility and performance reasons.
+
 ### 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.
+The transcoded version 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 a single asset with the _Refresh encoded videos_ button in the asset viewer options, or for all assets by running transcoding jobs for all assets from the administration page.
 
 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.
 
@@ -139,19 +147,19 @@ UPDATE assets SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>'
 
 ### 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.
+Yes, by using the [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),
+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?
+### Can I add an external library while keeping the existing album 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.
+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) to help you achieve that.
 
 ### What happens to duplicates in external libraries?
 
@@ -181,7 +189,7 @@ However, disabling all jobs will not disable the machine learning service itself
 
 ### 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.
+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. If models are failing to download entirely, you can manually download them from [Huggingface](https://huggingface.co/immich-app) and place them in the cache folder.
 
 ### Why did Immich decide to remove object detection?
 
@@ -190,7 +198,7 @@ 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.
+No, this is not supported. Only models listed in the [Huggingface](https://huggingface.co/immich-app) page 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?
 
@@ -202,14 +210,18 @@ Feel free to make a feature request if there's a model you want to use that isn'
 
 ### 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.
+Immich's machine learning feature operate on the generated thumbnail. If a face is visible in the video's thumbnail it will be picked up by facial recognition.
+Scanning the entire video for faces may be implemented in the future.
 
 ### 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. Setting the score too high (above 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.
@@ -227,7 +239,7 @@ To do this you can run:
 
 ### 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.
+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 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?
 
@@ -242,9 +254,9 @@ The initial backup is the most intensive due to the number of jobs running. The
 ### 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.
+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 limit this.
 
-### How an I boost machine learning speed?
+### How can 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.
@@ -253,17 +265,17 @@ This advice improves throughput, not latency. This is to say that it will make S
 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.
+On a normal machine, 2 or 3 concurrent jobs can probably max the CPU. Beyond this, 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)
+More detail can be found [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
+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.
+Once this process completes, the percentage of CPU usage will drop to around 3-5% usage
 
 ---
 
@@ -271,13 +283,12 @@ When a large amount of assets are uploaded to Immich it makes sense that the CPU
 
 ### 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).
+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`.
+You can change the user in the container by setting the `user` argument in `docker-compose.yml` for each service.
+You may need to 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`.
 
@@ -286,15 +297,24 @@ The non-root user/group needs read/write access to the volume mounts, including
 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.
+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.
 
+:::warning
+This will destroy your database and reset your instance, meaning that you start from scratch.
+:::
+
 ```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 any unwanted files or folders.
+:::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** should be removed from the `UPLOAD_LOCATION` to provide a clean start.
 
 ### Why does the machine learning service report workers crashing?
 
@@ -309,3 +329,7 @@ If the error mentions SIGKILL or error code 137, it most likely means the servic
 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 does Immich log migration errors on startup?
+
+Sometimes Immich logs errors such as "duplicate key value violates unique constraint" or "column (...) of relation (...) already exists". 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,8 @@
 # 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
@@ -14,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"
 ```
 
@@ -28,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:
@@ -64,34 +90,78 @@ 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.
-  - The main user is "Admin" (but only for `\library\library\`)
-  - Other users have different string identifiers.
-- You can find your user ID in Account Account Settings > Account > User ID.
+- 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\library\<userID>`.
+  - Original assets uploaded through the browser interface & mobile & CLI.
+  - Stored in `/library/upload/<userID>`.
 - **Avatar Images:**
   - User profile images.
-  - Stored in `\library\profile\<userID>`.
+  - 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>`.
+  - 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>`.
+  - Stored in `/library/encoded-video/<userID>`.
 - **Files in Upload Queue (Mobile):**
   - Files uploaded through mobile apps.
-  - Temporarily located in `\library\upload\<userID>`.
-  - Transferred to `\library\library\<userID>` upon successful upload.
+  - 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.

docs/docs/administration/oauth.md

@@ -66,8 +66,10 @@ Once you have a new OAuth client application configured, Immich can be configure
 | Client ID                                            | string  | (required)           | Required. Client ID (from previous step)                                            |
 | Client Secret                                        | string  | (required)           | Required. Client Secret (previous step)                                             |
 | Scope                                                | string  | openid email profile | Full list of scopes to send with the request (space delimited)                      |
+| Signing Algorithm                                    | string  | RS256                | The algorithm used to sign the id token (examples: RS256, HS256)                    |
 | Button Text                                          | string  | Login with OAuth     | Text for the OAuth button on the web                                                |
 | Auto Register                                        | boolean | true                 | When true, will automatically register a user the first time they sign in           |
+| Storage Claim                                        | string  | preferred_username   | Claim mapping for the user's storage label                                          |
 | [Auto Launch](#auto-launch)                          | boolean | false                | When true, will skip the login page and automatically start the OAuth login process |
 | [Mobile Redirect URI Override](#mobile-redirect-uri) | URL     | (empty)              | Http(s) alternative mobile redirect URI                                             |
 

docs/docs/administration/reverse-proxy.md

@@ -10,7 +10,6 @@ Below is an example config for nginx. Make sure to include `client_max_body_size
 server {
     server_name <snip>
 
-    # https://github.com/immich-app/immich/blob/main/nginx/templates/default.conf.template#L28
     client_max_body_size 50000M;
 
     location / {
@@ -38,3 +37,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/developer/pr-checklist.md

@@ -7,7 +7,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:svelte` (Type checking via SvelteKit)
-- [ ] `npm test` (Tests via Jest)
+- [ ] `npm test` (unit tests)
 
 :::tip
 Run all web checks with `npm run check:all`
@@ -18,7 +18,7 @@ Run all web checks with `npm run check:all`
 - [ ] `npm run lint` (linting via ESLint)
 - [ ] `npm run format` (formatting via Prettier)
 - [ ] `npm run check` (Type checking via `tsc`)
-- [ ] `npm test` (Tests via Jest)
+- [ ] `npm test` (unit tests)
 
 :::tip
 Run all server checks with `npm run check:all`

docs/docs/developer/setup.md

@@ -26,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.
 
@@ -47,6 +46,8 @@ 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 3.13.x to be installed on your system.
@@ -57,12 +58,13 @@ Please refer to the [Flutter's official documentation](https://flutter.dev/docs/
 
 If you only want to do web development connected to an existing, remote backend, follow these steps:
 
-1. Enter the web directory - `cd web/`
-2. Install web dependencies - `npm i`
-3. Start the web development server
+1. Build the Immich SDK - `cd open-api/typescript-sdk && npm i && npm run build && cd -`
+2. Enter the web directory - `cd web/`
+3. Install web dependencies - `npm i`
+4. Start the web development server
 
-```
-IMMICH_SERVER_URL=https://demo.immich.app/api npm run dev
+```bash
+IMMICH_SERVER_URL=https://demo.immich.app/ npm run dev
 ```
 
 ## IDE setup

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 e2e:jobs`.
+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,15 +10,17 @@ 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
 
-- Node.js 20.0 or above
+- Node.js 20 or above
 - Npm
 
-## Installation
+If you can't install node/npm, there is also a Docker version available below.
+
+## Installation (NPM)
 
 ```bash
 npm i -g @immich/cli
@@ -30,6 +32,16 @@ NOTE: if you previously installed the legacy CLI, you will need to uninstall it
 npm uninstall -g immich
 ```
 
+## Installation (Docker)
+
+If npm is not available on your system you can try the Docker version
+
+```bash
+docker run -it -v "$(pwd)":/import:ro -e IMMICH_INSTANCE_URL=https://your-immich-instance/api -e IMMICH_API_KEY=your-api-key ghcr.io/immich-app/immich-cli:latest
+```
+
+Please modify the `IMMICH_INSTANCE_URL` and `IMMICH_API_KEY` environment variables as suitable. You can also use a Docker env file to store your sensitive API key.
+
 ## Usage
 
 ```
@@ -39,10 +51,11 @@ immich
 ```
 Usage: immich [options] [command]
 
-Immich command line interface
+Command line interface for Immich
 
 Options:
   -V, --version                     output the version number
+  -d, --config                      Configuration directory (env: IMMICH_CONFIG_DIR)
   -h, --help                        display help for command
 
 Commands:
@@ -69,7 +82,9 @@ Options:
   -r, --recursive          Recursive (default: false, env: IMMICH_RECURSIVE)
   -i, --ignore [paths...]  Paths to ignore (env: IMMICH_IGNORE_PATHS)
   -h, --skip-hash          Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH)
+  -H, --include-hidden     Include hidden folders (default: false, env: IMMICH_INCLUDE_HIDDEN)
   -a, --album              Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM)
+  -A, --album-name <name>  Add all assets to specified album (env: IMMICH_ALBUM_NAME)
   -n, --dry-run            Don't perform any actions, just show what will be done (default: false, env: IMMICH_DRY_RUN)
   --delete                 Delete local assets after upload (env: IMMICH_DELETE_ASSETS)
   --help                   display help for command
@@ -91,7 +106,7 @@ For instance,
 immich login-key http://192.168.1.216:2283/api HFEJ38DNSDUEG
 ```
 
-This will store your credentials in a file in your home directory. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.
+This will store your credentials in a `auth.yml` file in the configuration directory which defaults to `~/.config/`. The directory can be set with the `-d` option or the environment variable `IMMICH_CONFIG_DIR`. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.
 
 Once you are authenticated, you can upload assets to your Immich server.
 
@@ -123,6 +138,12 @@ You can automatically create albums based on the folder name by passing the `--a
 immich upload --album --recursive directory/
 ```
 
+You can also choose to upload all assets to a specific album with the `--album-name` option.
+
+```bash
+immich upload --album-name "My summer holiday" --recursive directory/
+```
+
 It is possible to skip assets matching a glob pattern by passing the `--ignore` option. See [the library documentation](docs/features/libraries.md) on how to use glob patterns. You can add several exclusion patterns if needed.
 
 ```bash
@@ -133,6 +154,12 @@ immich upload --ignore **/Raw/** --recursive directory/
 immich upload --ignore **/Raw/** **/*.tif --recursive directory/
 ```
 
+By default, hidden files are skipped. If you want to include hidden files, use the `--include-hidden` option:
+
+```bash
+immich upload --include-hidden --recursive directory/
+```
+
 ### Obtain the API Key
 
 The API key can be obtained in the user setting panel on the web interface.

docs/docs/features/hardware-transcoding.md

@@ -1,17 +1,19 @@
 # Hardware Transcoding [Experimental]
 
-This feature allows you to use a GPU or Intel Quick Sync to accelerate transcoding and reduce CPU load.
+This feature allows you to use a GPU to accelerate transcoding and reduce CPU load.
 Note that hardware transcoding is much less efficient for file sizes.
 As this is a new feature, it is still experimental and may not work on all systems.
 
+:::info
+You do not need to redo any transcoding jobs after enabling hardware acceleration. The acceleration device will be used for any jobs that run after enabling it.
+:::
+
 ## Supported APIs
 
-- NVENC
-  - NVIDIA GPUs
-- Quick Sync
-  - Intel CPUs
-- VAAPI
-  - GPUs
+- NVENC (NVIDIA)
+- Quick Sync (Intel)
+- RKMPP (Rockchip)
+- VAAPI (AMD / NVIDIA / Intel)
 
 ## Limitations
 
@@ -20,8 +22,7 @@ As this is a new feature, it is still experimental and may not work on all syste
 - WSL2 does not support Quick Sync.
 - Raspberry Pi is currently not supported.
 - Two-pass mode is only supported for NVENC. Other APIs will ignore this setting.
-- Only encoding is currently hardware accelerated, so the CPU is still used for software decoding.
-  - This is mainly because the original video may not be hardware-decodable.
+- Only encoding is currently hardware accelerated, so the CPU is still used for software decoding and tone-mapping.
 - Hardware dependent
   - Codec support varies, but H.264 and HEVC are usually supported.
     - Notably, NVIDIA and AMD GPUs do not support VP9 encoding.
@@ -43,34 +44,65 @@ As this is a new feature, it is still experimental and may not work on all syste
 
 ## Setup
 
-#### Initial Setup
+#### Basic 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.
+1. If you do not already have it, download the latest [`hwaccel.transcoding.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`.
+2. In the `docker-compose.yml` under `immich-microservices`, uncomment the `extends` section and change `cpu` to the appropriate backend.
+
+- For VAAPI on WSL2, be sure to use `vaapi-wsl` rather than `vaapi`
+
+3. Redeploy the `immich-microservices` container with these updated settings.
+4. In the Admin page under `Video transcoding settings`, change the hardware acceleration setting to the appropriate option and save.
+
+#### Single Compose File
+
+Some platforms, including Unraid and Portainer, do not support multiple Compose files as of writing. As an alternative, you can "inline" the relevant contents of the [`hwaccel.transcoding.yml`][hw-file] file into the `immich-microservices` service directly.
+
+For example, the `qsv` section in this file is:
+
+```yaml
+devices:
+  - /dev/dri:/dev/dri
+```
+
+You can add this to the `immich-microservices` service instead of extending from `hwaccel.transcoding.yml`:
+
+```yaml
+immich-microservices:
+  container_name: immich_microservices
+  image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+  # Note the lack of an `extends` section
+  devices:
+    - /dev/dri:/dev/dri
+  command: ['start.sh', 'microservices']
+  volumes:
+    - ${UPLOAD_LOCATION}:/usr/src/app/upload
+    - /etc/localtime:/etc/localtime:ro
+  env_file:
+    - .env
+  depends_on:
+    - redis
+    - database
+  restart: always
+```
+
+Once this is done, you can continue to step 3 of "Basic Setup".
 
 #### 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.
+1. In the container app, add this environmental variable: Key=`NVIDIA_VISIBLE_DEVICES` Value=`all`
+2. While still in the container app, change the container from Basic Mode to Advanced Mode and add the following parameter to the Extra Parameters field: `--runtime=nvidia`
+3. Restart the container app.
+4. Continue to step 4 of "Basic Setup".
 
 ## Tips
 
 - You may want to choose a slower preset than for software transcoding to maintain quality and efficiency
-- While you can use VAAPI with Nvidia GPUs and Intel CPUs, prefer the more specific APIs since they're more optimized for their respective devices
+- While you can use VAAPI with NVIDIA and Intel devices, prefer the more specific APIs since they're more optimized for their respective devices
 
-[hw-file]: https://github.com/immich-app/immich/releases/latest/download/hwaccel.yml
+[hw-file]: https://github.com/immich-app/immich/releases/latest/download/hwaccel.transcoding.yml
 [nvcr]: https://github.com/NVIDIA/nvidia-container-runtime/
 [jellyfin-lp]: https://jellyfin.org/docs/general/administration/hardware-acceleration/intel/#configure-and-verify-lp-mode-on-linux
 [jellyfin-kernel-bug]: https://jellyfin.org/docs/general/administration/hardware-acceleration/intel/#known-issues-and-limitations

docs/docs/features/libraries.md

@@ -42,20 +42,24 @@ Finally, files can be deleted from Immich via the `Remove Offline Files` job. Th
 
 ### Import Paths
 
-External libraries use import paths to determine which files to scan. Each library can have multiple import paths so that files from different locations can be added to the same library. Import paths are scanned recursively, and if a file is in multiple import paths, it will only be added once. If the import paths are edited in a way that an external file is no longer in any import path, it will be removed from the library in the same way a deleted file would. If the file is moved back to an import path, it will be added again as if it was a new file.
+External libraries use import paths to determine which files to scan. Each library can have multiple import paths so that files from different locations can be added to the same library. Import paths are scanned recursively, and if a file is in multiple import paths, it will only be added once. Each import file must be a readable directory that exists on the filesystem; the import path dialog will alert you of any paths that are not accessible.
+
+If the import paths are edited in a way that an external file is no longer in any import path, it will be removed from the library in the same way a deleted file would. If the file is moved back to an import path, it will be added again as if it was a new file.
 
 ### Troubleshooting
 
-Sometimes, an external library will not scan correctly. This can happen if the immich_server or immich_microservices can't access the files. Here are some things to check:
+Sometimes, an external library will not scan correctly. This can happen if immich_server or immich_microservices can't access the files. Here are some things to check:
 
-- Is the external path set correctly?
+- Is the external path set correctly? Each import path must be contained in the external path.
+- Make sure the external path does not contain spaces
 - 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?
+- Make sure you don't use symlinks in your import libraries, and that you aren't linking across docker mounts.
 - Are the permissions set correctly?
-- Are you using forward slashes everywhere? (`/`)
+- Make sure you are using forward slashes (`/`) and not backward slashes.
 
-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.
+To validate that Immich can reach your external library, start a shell inside the container. Run `docker exec -it immich_microservices /bin/bash` to a bash shell. If your import path is `/data/import/photos`, check it with `ls /data/import/photos`. Do the same check for the `immich_server` container. If you cannot access this directory in both the `microservices` and `server` containers, Immich won't be able to import files.
 
 ### Security Considerations
 
@@ -69,16 +73,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
 
@@ -121,7 +134,9 @@ First, we need to plan how we want to organize the libraries. The christmas trip
 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
 

docs/docs/features/ml-hardware-acceleration.md

@@ -0,0 +1,104 @@
+# Hardware-Accelerated Machine Learning [Experimental]
+
+This feature allows you to use a GPU to accelerate machine learning tasks, such as Smart Search and Facial Recognition, while reducing CPU load.
+As this is a new feature, it is still experimental and may not work on all systems.
+
+:::info
+You do not need to redo any machine learning jobs after enabling hardware acceleration. The acceleration device will be used for any jobs that run after enabling it.
+:::
+
+## Supported Backends
+
+- ARM NN (Mali)
+- CUDA (NVIDIA)
+- OpenVINO (Intel)
+
+## Limitations
+
+- The instructions and configurations here are specific to Docker Compose. Other container engines may require different configuration.
+- Only Linux and Windows (through WSL2) servers are supported.
+- ARM NN is only supported on devices with Mali GPUs. Other Arm devices are not supported.
+- There is currently an upstream issue with OpenVINO, so whether it will work is device-dependent.
+- Some models may not be compatible with certain backends. CUDA is the most reliable.
+
+## Prerequisites
+
+#### ARM NN
+
+- Make sure you have the appropriate linux kernel driver installed
+  - This is usually pre-installed on the device vendor's Linux images
+- `/dev/mali0` must be available in the host server
+  - You may confirm this by running `ls /dev` to check that it exists
+- You must have the closed-source `libmali.so` firmware (possibly with an additional firmware file)
+  - Where and how you can get this file depends on device and vendor, but typically, the device vendor also supplies these
+  - The `hwaccel.ml.yml` file assumes the path to it is `/usr/lib/libmali.so`, so update accordingly if it is elsewhere
+  - The `hwaccel.ml.yml` file assumes an additional file `/lib/firmware/mali_csffw.bin`, so update accordingly if your device's driver does not require this file
+
+#### CUDA
+
+- You must have the official NVIDIA driver installed on the server.
+- On Linux (except for WSL2), you also need to have [NVIDIA Container Runtime][nvcr] installed.
+
+## Setup
+
+1. If you do not already have it, download the latest [`hwaccel.ml.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`.
+2. In the `docker-compose.yml` under `immich-machine-learning`, uncomment the `extends` section and change `cpu` to the appropriate backend.
+3. Redeploy the `immich-machine-learning` container with these updated settings.
+
+#### Single Compose File
+
+Some platforms, including Unraid and Portainer, do not support multiple Compose files as of writing. As an alternative, you can "inline" the relevant contents of the [`hwaccel.ml.yml`][hw-file] file into the `immich-machine-learning` service directly.
+
+For example, the `cuda` section in this file is:
+
+```yaml
+deploy:
+  resources:
+    reservations:
+      devices:
+        - driver: nvidia
+          count: 1
+          capabilities:
+            - gpu
+            - compute
+            - video
+```
+
+You can add this to the `immich-machine-learning` service instead of extending from `hwaccel.ml.yml`:
+
+```yaml
+immich-machine-learning:
+  container_name: immich_machine_learning
+  image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}-cuda
+  # Note the lack of an `extends` section
+  deploy:
+    resources:
+      reservations:
+        devices:
+          - driver: nvidia
+            count: 1
+            capabilities:
+              - gpu
+              - compute
+              - video
+  volumes:
+    - model-cache:/cache
+  env_file:
+    - .env
+  restart: always
+```
+
+Once this is done, you can redeploy the `immich-machine-learning` container.
+
+:::info
+You can confirm the device is being recognized and used by checking its utilization (via `nvtop` for CUDA, `intel_gpu_top` for OpenVINO, etc.). You can also enable debug logging by setting `LOG_LEVEL=debug` in the `.env` file and restarting the `immich-machine-learning` container. When a Smart Search or Face Detection job begins, you should see a log for `Available ORT providers` containing the relevant provider. In the case of ARM NN, the absence of a `Could not load ANN shared libraries` log entry means it loaded successfully.
+:::
+
+[hw-file]: https://github.com/immich-app/immich/releases/latest/download/hwaccel.ml.yml
+[nvcr]: https://github.com/NVIDIA/nvidia-container-runtime/
+
+## Tips
+
+- If you encounter an error when a model is running, try a different model to see if the issue is model-specific.
+- You may want to increase concurrency past the default for higher utilization. However, keep in mind that this will also increase VRAM consumption.
+- Larger models benefit more from hardware acceleration, if you have the VRAM for them.

docs/docs/guides/database-gui.md

@@ -4,8 +4,17 @@ 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.
+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.
 
 :::
 

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/remote-machine-learning.md

@@ -6,6 +6,10 @@ To alleviate [performance issues on low-memory systems](/docs/FAQ.mdx#why-is-imm
 - 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'
 

docs/docs/guides/remove-offline-files.md

@@ -1,11 +1,146 @@
-# Remove Offline Files
+# Remove Offline Files [Community]
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 :::note
-**Before running the script**, please make sure you have a [backup](/docs/administration/backup-and-restore) of your assets and database
+**Before running the script**, please make sure you have a [backup](/docs/administration/backup-and-restore) of your assets and database.
+:::
+
+:::info
+**None** of the scripts can delete orphaned files from the external library.
 :::
 
 This page is a guide to get rid of offline files from the repair page.
 
+<Tabs>
+
+<TabItem value="Python script (Best way)" label="Python script (Best way)">
+
+This way works by retrieving a file that contains a list of all the files that are defined as offline files, running a script that uses the [Immich API](/docs/api/delete-assets) in order to remove the offline files.
+
+1. Create an API key under Admin User -> Account Settings -> API Keys -> New API Key -> Copy to clipboard.
+2. Copy and save the code to file -> `Immich Remove Offline Files.py`.
+3. Run the script and follow the instructions.
+
+:::note
+You might need to run `pip install halo tabulate tqdm` if these dependencies are missing on your machine.
+:::
+
+```bash title='Python'
+#!/usr/bin/env python3
+
+# Note: you might need to run "pip install halo tabulate tqdm" if these dependencies are missing on your machine
+
+import argparse
+import json
+import requests
+
+from datetime import datetime
+from halo import Halo
+from tabulate import tabulate
+from tqdm import tqdm
+from urllib.parse import urlparse
+
+def parse_arguments():
+    parser = argparse.ArgumentParser(description='Fetch file report and delete orphaned media assets from Immich.')
+    parser.add_argument('--apikey', help='Immich API key for authentication')
+    parser.add_argument('--immichaddress', help='Full address for Immich, including protocol and port')
+    parser.add_argument('--no_prompt', action='store_true', help='Delete orphaned media assets without confirmation')
+    args = parser.parse_args()
+    return args
+
+def filter_entities(response_json, entity_type):
+    return [
+        {'pathValue': entity['pathValue'], 'entityId': entity['entityId'], 'entityType': entity['entityType']}
+        for entity in response_json.get('orphans', []) if entity.get('entityType') == entity_type
+    ]
+
+def main():
+    args = parse_arguments()
+    try:
+        if args.apikey:
+            api_key = args.apikey
+        else:
+            api_key = input('Enter the Immich API key: ')
+
+        if args.immichaddress:
+            immich_server = args.immichaddress
+        else:
+            immich_server = input('Enter the full web address for Immich, including protocol and port: ')
+        immich_parsed_url = urlparse(immich_server)
+        base_url = f'{immich_parsed_url.scheme}://{immich_parsed_url.netloc}'
+        api_url = f'{base_url}/api'
+        file_report_url = api_url + '/audit/file-report'
+        headers = {'x-api-key': api_key}
+
+        print()
+        spinner = Halo(text='Retrieving list of orphaned media assets...', spinner='dots')
+        spinner.start()
+
+        try:
+            response = requests.get(file_report_url, headers=headers)
+            response.raise_for_status()
+            spinner.succeed('Success!')
+        except requests.exceptions.RequestException as e:
+            spinner.fail(f'Failed to fetch assets: {str(e)}')
+
+        person_assets = filter_entities(response.json(), 'person')
+        orphan_media_assets = filter_entities(response.json(), 'asset')
+
+        num_entries = len(orphan_media_assets)
+
+        if num_entries == 0:
+            print('No orphaned media assets found; exiting.')
+            return
+
+        else:
+            if not args.no_prompt:
+                table_data = []
+                for asset in orphan_media_assets:
+                    table_data.append([asset['pathValue'], asset['entityId']])
+                print(tabulate(table_data, headers=['Path Value', 'Entity ID'], tablefmt='pretty'))
+                print()
+
+                if person_assets:
+                    print('Found orphaned person assets! Please run the "RECOGNIZE FACES > ALL" job in Immich after running this tool to correct this.')
+                    print()
+
+                if num_entries > 0:
+                    summary = f'There {"is" if num_entries == 1 else "are"} {num_entries} orphaned media asset{"s" if num_entries != 1 else ""}. Would you like to delete {"them" if num_entries != 1 else "it"} from Immich? (yes/no): '
+                    user_input = input(summary).lower()
+                    print()
+
+                    if user_input not in ('y', 'yes'):
+                        print('Exiting without making any changes.')
+                        return
+
+            with tqdm(total=num_entries, desc="Deleting orphaned media assets", unit="asset") as progress_bar:
+                for asset in orphan_media_assets:
+                    entity_id = asset['entityId']
+                    asset_url = f'{api_url}/asset'
+                    delete_payload = json.dumps({'force': True, 'ids': [entity_id]})
+                    headers = {'Content-Type': 'application/json', 'x-api-key': api_key}
+                    response = requests.delete(asset_url, headers=headers, data=delete_payload)
+                    response.raise_for_status()
+                    progress_bar.set_postfix_str(entity_id)
+                    progress_bar.update(1)
+            print()
+            print('Orphaned media assets deleted successfully!')
+    except Exception as e:
+        print()
+        print(f"An error occurred: {str(e)}")
+
+if __name__ == '__main__':
+    main()
+```
+
+Thanks to [DooMRunneR](https://discord.com/channels/979116623879368755/1179655214870040596/1194308198413373482) and [Sircharlo](https://discord.com/channels/979116623879368755/1179655214870040596/1195038609812758639) for writing this script.
+
+</TabItem>
+
+<TabItem value="Bash and PowerShell script" label="Bash and PowerShell script" default>
+
 This way works by downloading a JSON file that contains a list of all the files that are defined as offline files, running a script that uses the [Immich API](/docs/api/delete-assets) in order to remove the offline files.
 
 1. Create an API key under Admin User -> Account Settings -> API Keys -> New API Key -> Copy to clipboard.
@@ -15,13 +150,13 @@ This way works by downloading a JSON file that contains a list of all the files
 
 ## Script for Linux based systems:
 
-```
+```bash title='Bash'
 awk -F\" '/entityId/ {print $4}' orphans.json | while read line; do curl --location --request DELETE 'http://YOUR_IP_HERE:2283/api/asset' --header 'Content- Type: application/json' --header 'x-api-key: YOUR_API_KEY_HERE' --data '{ "force": true, "ids": ["'"$line"'"]}';done
 ```
 
 ## Script for the Windows system (run through PowerShell):
 
-```
+```powershell title='PowerShell'
 Get-Content orphans.json | Select-String -Pattern 'entityId' | ForEach-Object {
   $line = $_ -split '"' | Select-Object -Index 3
   $body = [pscustomobject]@{
@@ -36,3 +171,6 @@ Get-Content orphans.json | Select-String -Pattern 'entityId' | ForEach-Object {
 ```
 
 Thanks to [DooMRunneR](https://discord.com/channels/979116623879368755/1179655214870040596/1194308198413373482) for writing this script.
+
+</TabItem>
+</Tabs>

docs/docs/install/config-file.md

@@ -129,6 +129,11 @@ The default configuration looks like this:
     "scan": {
       "enabled": true,
       "cronExpression": "0 0 * * *"
+    },
+    "watch": {
+      "enabled": false,
+      "usePolling": false,
+      "interval": 10000
     }
   }
 }

docs/docs/install/docker-compose.mdx

@@ -28,8 +28,12 @@ wget https://github.com/immich-app/immich/releases/latest/download/docker-compos
 wget -O .env https://github.com/immich-app/immich/releases/latest/download/example.env
 ```
 
-```bash title="(Optional) Get hwaccel.yml file"
-wget https://github.com/immich-app/immich/releases/latest/download/hwaccel.yml
+```bash title="(Optional) Get hwaccel.transcoding.yml file"
+wget https://github.com/immich-app/immich/releases/latest/download/hwaccel.transcoding.yml
+```
+
+```bash title="(Optional) Get hwaccel.ml.yml file"
+wget https://github.com/immich-app/immich/releases/latest/download/hwaccel.ml.yml
 ```
 
 or by downloading from your browser and moving the files to the directory that you created.
@@ -37,7 +41,7 @@ or by downloading from your browser and moving the files to the directory that y
 Note: If you downloaded the files from your browser, also ensure that you rename `example.env` to `.env`.
 
 :::info
-Optionally, you can use the [`hwaccel.yml`][hw-file] file to enable hardware acceleration for transcoding. See the [Hardware Transcoding](/docs/features/hardware-transcoding.md) guide for info on how to set this up.
+Optionally, you can enable hardware acceleration for machine learning and transcoding. See the [Hardware Transcoding](/docs/features/hardware-transcoding.md) and [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md) guides for info on how to set these up.
 :::
 
 ### Step 2 - Populate the .env file with custom values
@@ -98,5 +102,4 @@ Immich is currently under heavy development, which means you can expect breaking
 
 [compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
 [env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env
-[hw-file]: https://github.com/immich-app/immich/releases/latest/download/hwaccel.yml
 [watchtower]: https://containrrr.dev/watchtower/