merge main

.dockerignore

@@ -1,25 +0,0 @@
-.vscode/
-
-design/
-docker/
-docs/
-fastlane/
-machine-learning/
-misc/
-mobile/
-
-server/node_modules
-server/coverage/
-server/.reverse-geocoding-dump/
-server/upload/
-server/dist/
-
-web/node_modules/
-web/coverage/
-web/.svelte-kit
-web/build/
-
-cli/node_modules
-cli/.reverse-geocoding-dump/
-cli/upload/
-cli/dist/

.gitattributes

@@ -5,8 +5,6 @@ mobile/openapi/**/*.dart linguist-generated=true
 mobile/openapi/.openapi-generator/FILES -diff -merge
 mobile/openapi/.openapi-generator/FILES linguist-generated=true
 
-mobile/lib/**/*.g.dart -diff -merge
-mobile/lib/**/*.g.dart linguist-generated=true
 
 cli/src/api/open-api/**/*.md -diff -merge
 cli/src/api/open-api/**/*.md linguist-generated=true
@@ -17,5 +15,3 @@ web/src/api/open-api/**/*.md -diff -merge
 web/src/api/open-api/**/*.md linguist-generated=true
 web/src/api/open-api/**/*.ts -diff -merge
 web/src/api/open-api/**/*.ts linguist-generated=true
-
-*.sh text eol=lf

.github/FUNDING.yml

@@ -1,5 +1,5 @@
 # These are supported funding model platforms
 
-github: immich-app
+github: alextran1502
 liberapay: alex.tran1502
 custom: https://www.buymeacoffee.com/altran1502

.github/release.yml

@@ -1,29 +0,0 @@
-changelog:
-  categories:
-    - title: Breaking Changes 🛠
-      labels:
-        - breaking-change
-    - title: Server
-      labels:
-        - 🗄️server
-    - title: Mobile
-      labels:
-        - 📱mobile
-    - title: Web
-      labels:
-        - 🖥️web
-    - title: Machine Learning
-      labels:
-        - 🧠machine-learning
-    - title: CLI
-      labels:
-        - cli
-    - title: Documentation
-      labels:
-        - documentation
-    - title: Dependency updates
-      labels:
-        - renovate
-    - title: Other changes
-      labels:
-        - "*"

.github/workflows/build-mobile.yml

@@ -19,8 +19,8 @@ jobs:
   build-sign-android:
     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
+    if: ${{ !github.event.pull_request.head.repo.fork }}
+    runs-on: macos-12
 
     steps:
       - name: Determine ref
@@ -31,11 +31,11 @@ jobs:
           ref="${input_ref:-$github_ref}"
           echo "ref=$ref" >> $GITHUB_OUTPUT
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           ref: ${{ steps.get-ref.outputs.ref }}
 
-      - uses: actions/setup-java@v4
+      - uses: actions/setup-java@v3
         with:
           distribution: "zulu"
           java-version: "12.x"
@@ -45,7 +45,7 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.10.5"
           cache: true
 
       - name: Create the Keystore
@@ -64,12 +64,10 @@ jobs:
           ALIAS: ${{ secrets.ALIAS }}
           ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_KEY_PASSWORD }}
           ANDROID_STORE_PASSWORD: ${{ secrets.ANDROID_STORE_PASSWORD }}
-        run: |
-          flutter build apk --release
-          flutter build apk --release --split-per-abi --target-platform android-arm,android-arm64,android-x64
+        run: flutter build apk --release
 
       - name: Publish Android Artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v3
         with:
           name: release-apk-signed
-          path: mobile/build/app/outputs/flutter-apk/*.apk
+          path: mobile/build/app/outputs/flutter-apk/app-release.apk

.github/workflows/cache-cleanup.yml

@@ -1,4 +1,4 @@
-name: Cache Cleanup
+name: Clean up actions cache on PR close
 on:
   pull_request:
     types:
@@ -10,11 +10,10 @@ concurrency:
 
 jobs:
   cleanup:
-    name: Cleanup
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Cleanup
         run: |

.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/codeql-analysis.yml

@@ -42,11 +42,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -60,7 +60,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -73,6 +73,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v2
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/dispatch_sdk_update.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ !github.event.pull_request.head.repo.fork }}
     steps:
-      - uses: actions/github-script@v7
+      - uses: actions/github-script@v6
         with:
           github-token: ${{ secrets.GH_TOKEN }}
           script: |

.github/workflows/docker-cleanup.yml

@@ -5,7 +5,7 @@
 #
 # This workflow will not trigger runs on forked repos.
 
-name: Docker Cleanup
+name: Cleanup Old Docker Images
 
 on:
   pull_request:
@@ -29,13 +29,16 @@ jobs:
         include:
           - primary-name: "immich-server"
           - primary-name: "immich-machine-learning"
+          - primary-name: "immich-web"
+          - primary-name: "immich-proxy"
     env:
       # Requires a personal access token with the OAuth scope delete:packages
       TOKEN: ${{ secrets.PACKAGE_DELETE_TOKEN }}
     steps:
-      - name: Clean temporary images
+      -
+        name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.4.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.2.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "immich-app"
@@ -57,14 +60,17 @@ jobs:
         include:
           - primary-name: "immich-server"
           - primary-name: "immich-machine-learning"
+          - primary-name: "immich-web"
+          - primary-name: "immich-proxy"
           - primary-name: "immich-build-cache"
     env:
       # Requires a personal access token with the OAuth scope delete:packages
       TOKEN: ${{ secrets.PACKAGE_DELETE_TOKEN }}
     steps:
-      - name: Clean untagged images
+      -
+        name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.4.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.2.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "immich-app"

.github/workflows/docker.yml

@@ -1,4 +1,4 @@
-name: Docker
+name: Build and Push Docker Images
 
 on:
   workflow_dispatch:
@@ -18,31 +18,31 @@ permissions:
 
 jobs:
   build_and_push:
-    name: Build and Push
     runs-on: ubuntu-latest
     strategy:
       # Prevent a failure in one image from stopping the other builds
       fail-fast: false
       matrix:
         include:
+          - context: "web"
+            image: "immich-web"
+            platforms: "linux/amd64,linux/arm64"
           - 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"
+          - context: "nginx"
+            image: "immich-proxy"
+            platforms: "linux/amd64,linux/arm64"
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
+        uses: docker/setup-qemu-action@v2.2.0
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v2.9.1
         # Workaround to fix error:
         # failed to push: failed to copy: io: read/write on closed pipe
         # See https://github.com/docker/build-push-action/issues/761
@@ -53,13 +53,13 @@ jobs:
       - name: Login to Docker Hub
         # Only push to Docker Hub when making a release
         if: ${{ github.event_name == 'release' }}
-        uses: docker/login-action@v3
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
+        uses: docker/login-action@v2
         # Skip when PR from a fork
         if: ${{ !github.event.pull_request.head.repo.fork }}
         with:
@@ -69,7 +69,7 @@ jobs:
 
       - name: Generate docker image tags
         id: metadata
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@v4
         with:
           flavor: |
             # Disable latest tag
@@ -97,10 +97,93 @@ jobs:
           fi
 
       - name: Build and push image
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v4.1.1
+        with:
+          context: ${{ matrix.context }}
+          platforms: ${{ matrix.platforms }}
+          # Skip pushing when PR from a fork
+          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 }}
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}
+
+  build_and_push_server_arm_64:
+    runs-on: self-hosted
+    strategy:
+      # Prevent a failure in one image from stopping the other builds
+      fail-fast: false
+      matrix:
+        include:
+          - context: "server"
+            image: "immich-server"
+            platforms: "linux/arm64,linux/amd64"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2.2.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2.9.1
+        # Workaround to fix error:
+        # failed to push: failed to copy: io: read/write on closed pipe
+        # See https://github.com/docker/build-push-action/issues/761
+        with:
+          driver-opts: |
+            image=moby/buildkit:v0.10.6
+
+      - name: Login to Docker Hub
+        # Only push to Docker Hub when making a release
+        if: ${{ github.event_name == 'release' }}
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        # Skip when PR from a fork
+        if: ${{ !github.event.pull_request.head.repo.fork }}
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate docker image tags
+        id: metadata
+        uses: docker/metadata-action@v4
+        with:
+          flavor: |
+            # Disable latest tag
+            latest=false
+          images: |
+            name=ghcr.io/${{ github.repository_owner }}/${{matrix.image}}
+            name=altran1502/${{matrix.image}},enable=${{ github.event_name == 'release' }}
+          tags: |
+            # Tag with branch name
+            type=ref,event=branch
+            # Tag with pr-number
+            type=ref,event=pr
+            # Tag with git tag on release
+            type=ref,event=tag
+            type=raw,value=release,enable=${{ github.event_name == 'release' }}
+
+      - name: Determine build cache output
+        id: cache-target
+        run: |
+          if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+            # Essentially just ignore the cache output (PR can't write to registry cache)
+            echo "cache-to=type=local,dest=/tmp/discard,ignore-error=true" >> $GITHUB_OUTPUT
+          else
+            echo "cache-to=type=registry,mode=max,ref=ghcr.io/${{ github.repository_owner }}/immich-build-cache:${{ matrix.image }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Build and push image
+        uses: docker/build-push-action@v4.1.1
         with:
           context: ${{ matrix.context }}
-          file: ${{ matrix.file }}
           platforms: ${{ matrix.platforms }}
           # Skip pushing when PR from a fork
           push: ${{ !github.event.pull_request.head.repo.fork }}

.github/workflows/pr-require-label.yml

@@ -1,13 +0,0 @@
-name: Enforce PR labels
-
-on:
-  pull_request:
-    types: [labeled, unlabeled, opened, edited, synchronize]
-jobs:
-  enforce-label:
-    name: Enforce label
-    runs-on: ubuntu-latest
-    steps:
-    - if: toJson(github.event.pull_request.labels) == '[]'
-      run: exit 1
-

.github/workflows/prepare-release.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.ORG_RELEASE_TOKEN }}
 
@@ -64,12 +64,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.ORG_RELEASE_TOKEN }}
 
       - name: Download APK
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v3
         with:
           name: release-apk-signed
 

.github/workflows/static_analysis.yml

@@ -17,13 +17,13 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.10.5"
 
       - name: Install dependencies
         run: dart pub get
@@ -32,8 +32,3 @@ jobs:
       - name: Run dart analyze
         run: dart analyze --fatal-infos
         working-directory: ./mobile
-      
-      # Enable after riverpod generator migration is completed
-      # - name: Run dart custom lint
-      #   run: dart run custom_lint
-      #   working-directory: ./mobile

.github/workflows/test.yml

@@ -11,20 +11,25 @@ concurrency:
 
 jobs:
   e2e-tests:
-    name: Server (e2e)
+    name: Run end-to-end test suites
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./server
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: "recursive"
+        uses: actions/checkout@v3
+
+      - name: Run npm install
+        run: npm ci
 
       - name: Run e2e tests
-        run: make test-server-e2e
+        run: npm run test:e2e
+        if: ${{ !cancelled() }}
 
   doc-tests:
-    name: Docs
+    name: Run documentation checks
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -32,7 +37,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Run npm install
         run: npm ci
@@ -45,12 +50,8 @@ jobs:
         run: npm run check
         if: ${{ !cancelled() }}
 
-      - name: Run build
-        run: npm run build
-        if: ${{ !cancelled() }}
-
   server-unit-tests:
-    name: Server
+    name: Run server unit test suites and checks
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -58,7 +59,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Run npm install
         run: npm ci
@@ -80,7 +81,7 @@ jobs:
         if: ${{ !cancelled() }}
 
   cli-unit-tests:
-    name: CLI
+    name: Run cli test suites
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -88,15 +89,11 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
-      - name: Run npm install in cli
+      - name: Run npm install
         run: npm ci
 
-      - name: Run npm install in server
-        run: npm ci
-        working-directory: ./server
-
       - name: Run linter
         run: npm run lint
         if: ${{ !cancelled() }}
@@ -105,39 +102,12 @@ jobs:
         run: npm run format
         if: ${{ !cancelled() }}
 
-      - name: Run tsc
-        run: npm run check
-        if: ${{ !cancelled() }}
-
       - name: Run unit tests & coverage
         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 npm install in cli
-        run: npm ci
-
-      - name: Run npm install in server
-        run: npm ci
-        working-directory: ./server
-
-      - name: Run e2e tests
-        run: npm run test:e2e
-
   web-unit-tests:
-    name: Web
+    name: Run web unit test suites and checks
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -145,7 +115,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Run npm install
         run: npm ci
@@ -171,30 +141,30 @@ jobs:
       #   if: ${{ !cancelled() }}
 
   mobile-unit-tests:
-    name: Mobile
+    name: Run mobile unit tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.13.6"
+          flutter-version: "3.10.5"
       - name: Run tests
         working-directory: ./mobile
         run: flutter test -j 1
 
   ml-unit-tests:
-    name: Machine Learning
+    name: Run ML unit tests and checks
     runs-on: ubuntu-latest
     defaults:
       run:
         working-directory: ./machine-learning
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Install poetry
         run: pipx install poetry
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.11
           cache: "poetry"
@@ -203,22 +173,22 @@ jobs:
           poetry install --with dev
       - name: Lint with ruff
         run: |
-          poetry run ruff check --format=github app export
+          poetry run ruff check --format=github app
       - name: Check black formatting
         run: |
-          poetry run black --check app export
+          poetry run black --check app
       - name: Run mypy type checking
         run: |
-          poetry run mypy --install-types --non-interactive --strict app/ export/
+          poetry run mypy --install-types --non-interactive app/
       - name: Run tests and coverage
         run: |
           poetry run pytest --cov app
 
   generated-api-up-to-date:
-    name: OpenAPI Clients
+    name: Check generated files are up-to-date
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Run API generation
         run: npm --prefix server run api:generate
       - name: Find file changes
@@ -236,11 +206,11 @@ jobs:
           exit 1
 
   generated-typeorm-migrations-up-to-date:
-    name: TypeORM Checks
+    name: Check generated TypeORM migrations are up-to-date
     runs-on: ubuntu-latest
     services:
       postgres:
-        image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+        image: postgres
         env:
           POSTGRES_PASSWORD: postgres
           POSTGRES_USER: postgres
@@ -252,64 +222,33 @@ jobs:
           --health-retries 5
         ports:
           - 5432:5432
-    defaults:
-      run:
-        working-directory: ./server
-
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
+      - uses: actions/checkout@v3
       - name: Install server dependencies
-        run: npm ci
-
-      - name: Build the app
-        run: npm run build
-
+        run: npm --prefix server ci
       - name: Run existing migrations
-        run: npm run typeorm:migrations:run
-
+        run: npm --prefix server run typeorm:migrations:run
       - name: Generate new migrations
         continue-on-error: true
-        run: npm run typeorm:migrations:generate ./src/infra/migrations/TestMigration
-
+        run: npm --prefix server run typeorm:migrations:generate ./src/infra/migrations/TestMigration
       - name: Find file changes
         uses: tj-actions/verify-changed-files@v13.1
         id: verify-changed-files
         with:
           files: |
             server/src/infra/migrations/
-      - name: Verify migration files have not changed
+      - name: Verify files have not changed
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |
-          echo "ERROR: Generated migration files not up to date!"
+          echo "ERROR: Generated files not up to date!"
           echo "Changed files: ${{ steps.verify-changed-files.outputs.changed_files }}"
           exit 1
 
-      - name: Run SQL generation
-        run: npm run sql:generate
-        env:
-          DB_URL: postgres://postgres:postgres@localhost:5432/immich
-
-      - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
-        id: verify-changed-sql-files
-        with:
-          files: |
-            server/src/infra/sql
-
-      - name: Verify SQL files have not changed
-        if: steps.verify-changed-sql-files.outputs.files_changed == 'true'
-        run: |
-          echo "ERROR: Generated SQL files not up to date!"
-          echo "Changed files: ${{ steps.verify-changed-sql-files.outputs.changed_files }}"
-          exit 1
-
   # mobile-integration-tests:
   #   name: Run mobile end-to-end integration tests
   #   runs-on: macos-latest
   #   steps:
-  #     - uses: actions/checkout@v4
+  #     - uses: actions/checkout@v3
   #     - uses: actions/setup-java@v3
   #       with:
   #         distribution: 'zulu'

.gitignore

@@ -4,11 +4,9 @@
 .idea
 
 docker/upload
-docker/library
 uploads
 coverage
 
 mobile/gradle.properties
 mobile/openapi/pubspec.lock
 mobile/*.jks
-mobile/libisar.dylib

.gitmodules

@@ -1,6 +1,3 @@
 [submodule "mobile/.isar"]
 	path = mobile/.isar
 	url = https://github.com/isar/isar
-[submodule "server/test/assets"]
-	path = server/test/assets
-	url = https://github.com/immich-app/test-assets

Makefile

@@ -1,35 +1,35 @@
 dev:
-	docker compose -f ./docker/docker-compose.dev.yml up --remove-orphans || make dev-down
+	docker-compose -f ./docker/docker-compose.dev.yml up --remove-orphans
 
-dev-down:
-	docker compose -f ./docker/docker-compose.dev.yml down --remove-orphans
+dev-new:
+	docker compose -f ./docker/docker-compose.dev.yml up --remove-orphans
 
-dev-update:
+dev-new-update:
 	docker compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
 
+dev-update:
+	docker-compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
+
 dev-scale:
-	docker compose -f ./docker/docker-compose.dev.yml up --build -V  --scale immich-server=3 --remove-orphans
+	docker-compose -f ./docker/docker-compose.dev.yml up --build -V  --scale immich-server=3 --remove-orphans
 
 stage:
-	docker compose -f ./docker/docker-compose.staging.yml up --build -V --remove-orphans
+	docker-compose -f ./docker/docker-compose.staging.yml up --build -V --remove-orphans
 
 pull-stage:
-	docker compose -f ./docker/docker-compose.staging.yml pull
+	docker-compose -f ./docker/docker-compose.staging.yml pull
 
-test-server-e2e:
-	docker compose -f ./server/test/docker-compose.server-e2e.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
+test-e2e:
+	docker-compose -f ./docker/docker-compose.test.yml --env-file ./docker/.env.test -p immich-test-e2e up  --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server-test --remove-orphans --build
 
 prod:
-	docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
+	docker-compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
 
 prod-scale:
-	docker compose -f ./docker/docker-compose.prod.yml up --build -V --scale immich-server=3 --scale immich-microservices=3 --remove-orphans
+	docker-compose -f ./docker/docker-compose.prod.yml up --build -V --scale immich-server=3 --scale immich-microservices=3 --remove-orphans
 
 api:
-	npm --prefix server run api:generate
-
-sql:
-	npm --prefix server run sql:generate
+	cd ./server && npm run api:generate
 
 attach-server:
-	docker exec -it docker_immich-server_1 sh
+	docker exec -it docker_immich-server_1 sh

README.md

@@ -2,7 +2,7 @@
   <br/>  
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
   <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt="Discord"/>
+    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
   </a>
   <br/>  
   <br/>   
@@ -18,16 +18,10 @@
 </a>
 <br/>
 <p align="center">
+  <a href="README_zh_CN.md">中文</a>
+  <a href="README_tr_TR.md">Türkçe</a>
   <a href="README_ca_ES.md">Català</a>
   <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
 </p>
 
 ## Disclaimer
@@ -68,7 +62,7 @@ password: demo
 Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 ```
 
-## Features
+# Features
 
 | Features                                     | Mobile | Web |
 | -------------------------------------------- | ------ | --- |
@@ -87,19 +81,18 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | Virtual scroll                               | Yes    | Yes |
 | OAuth support                                | Yes    | Yes |
 | API Keys                                     | N/A    | Yes |
-| LivePhoto/MotionPhoto backup and playback    | Yes    | Yes |
+| LivePhoto backup and playback                | iOS    | Yes |
 | User-defined storage structure               | Yes    | Yes |
 | Public Sharing                               | No     | Yes |
 | Archive and Favorites                        | Yes    | Yes |
-| Global Map                                   | Yes    | Yes |
+| Global Map                                   | No     | Yes |
 | Partner Sharing                              | Yes    | Yes |
 | Facial recognition and clustering            | Yes    | Yes |
 | Memories (x years ago)                       | Yes    | Yes |
 | Offline support                              | Yes    | No  |
 | Read-only gallery                            | Yes    | Yes |
-| Stacked Photos                               | Yes    | Yes |
 
-## Support the project
+# Support the project
 
 I've committed to this project, and I will not stop. I will keep updating the docs, adding new features, and fixing bugs. But I can't do it alone. So I need your help to give me additional motivation to keep going.
 
@@ -107,16 +100,10 @@ As our hosts in the [selfhosted.show - In the episode 'The-organization-must-not
 
 If you feel like this is the right cause and the app is something you are seeing yourself using for a long time, please consider supporting the project with the option below.
 
-### Donation
+## Donation
 
 - [Monthly donation](https://github.com/sponsors/alextran1502) via GitHub Sponsors
 - [One-time donation](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
-
-## Contributors
-<a href="https://github.com/alextran1502/immich/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
-</a>

README_ca_ES.md

@@ -19,15 +19,9 @@
 <br/>
 <p align="center">
   <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
   <a href="README_zh_CN.md">中文</a>
+  <a href="README_tr_TR.md">Türkçe</a>
+  <a href="README_ca_ES.md">Español</a>
 </p>
 
 ## Avís legal
@@ -111,4 +105,4 @@ Si creieu que aquesta és una causa justa i l'aplicació és alguna cosa que us
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
+

README_de_DE.md

@@ -1,122 +0,0 @@
-<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://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login mit eigener URL">
-</p>
-<h3 align="center">Immich - Hoch performante, selbst gehostete Backup-Lösung für Fotos und Videos</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Haupt-Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## Warnung
-
-- ⚠️ Das Projekt befindet sich in **sehr aktiver** Entwicklung.
-- ⚠️ Erwarte Fehler und Änderungen mit Breaking-Changes.
-- ⚠️ **Nutze die App auf keinen Fall als einziges Speichermedium für deine Fotos und Videos.**
-- ⚠️ Befolge immer die [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) Backup-Regel für deine wertvollen Fotos und Videos!
-
-## Inhalt
-
-- [Offizielle Dokumentation](https://immich.app/docs)
-- [Roadmap](https://github.com/orgs/immich-app/projects/1)
-- [Demo](#demo)
-- [Funktionen](#funktionen)
-- [Einführung](https://immich.app/docs/overview/introduction)
-- [Installation](https://immich.app/docs/install/requirements)
-- [Beitragsrichtlinien](https://immich.app/docs/overview/support-the-project)
-- [Unterstütze das Projekt](#unterstütze-das-projekt)
-
-## Dokumentation
-
-Die Hauptdokumentation, inklusive Installationsanleitungen, ist unter https://immich.app zu finden.
-
-## Demo
-
-Die Web-Demo kannst Du unter https://demo.immich.app finden.
-
-Für die Handy-App kannst Du `https://demo.immich.app/api` als `Server Endpoint URL` angeben.
-
-```bash title="Demo Credential"
-Die Anmeldedaten
-email: demo@immich.app
-passwort: demo
-```
-
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-## Funktionen
-
-| Funktionen                                           | Mobil  | Web   |
-| ---------------------------------------------------- | ------ | ----- |
-| Fotos & Videos hochladen und ansehen                 | Ja     | Ja    |
-| Automatisches Backup wenn die App geöffnet ist       | Ja     | n. a. |
-| Selektive Auswahl von Alben zum Sichern              | Ja     | n. a. |
-| Fotos und Videos auf das Gerät herunterladen         | Ja     | Ja    |
-| Unterstützt mehrere Benutzer                         | Ja     | Ja    |
-| Album und geteilte Alben                             | Ja     | Ja    |
-| Scrollleiste                                         | Ja     | Ja    |
-| Unterstützt RAW Formate                              | Ja     | Ja    |
-| Metadaten anzeigen (EXIF, Karte)                     | Ja     | Ja    |
-| Suchen nach Metadaten, Objekten, Gesichtern und CLIP | Ja     | Ja    |
-| Administrative Funktionen (Benutzerverwaltung)       | Nein   | Ja    |
-| Backup im Hintergrund                                | Ja     | n. a. |
-| Virtuelles Scrollen                                  | Ja     | Ja    |
-| OAuth Unterstützung                                  | Ja     | Ja    |
-| API-Schlüssel                                        | n. a.  | Ja    |
-| LivePhoto/MotionPhoto Backup und Wiedergabe          | Ja     | Ja    |
-| Benutzerdefinierte Speicherstruktur                  | Ja     | Ja    |
-| Öffentliches Teilen                                  | Nein   | Ja    |
-| Archive und Favoriten                                | Ja     | Ja    |
-| Globale Karte                                        | Ja     | Ja    |
-| Teilen mit Partner                                   | Ja     | Ja    |
-| Gesichtserkennung und Gruppierung                    | Ja     | Ja    |
-| Rückblicke (heute vor x Jahren)                      | Ja     | Ja    |
-| Offline Unterstützung                                | Ja     | Nein  |
-| Schreibgeschützte Gallerie                           | Ja     | Ja    |
-| Gestapelte Bilder                                    | Ja     | Ja    |
-
-## Unterstütze das Projekt
-
-Ich habe mich diesem Projekt verpflichtet und werde nicht aufgeben. Ich werde die Dokumentation weiter aktualisieren, neue Funktionen hinzufügen und Fehler beheben. Allerdings kann ich das nicht alleine schaffen. Daher brauche ich Eure Unterstützung, um mir zusätzliche Motivation zu geben, weiterzumachen.
-
-Wie unsere Gastgeber in der [selfhosted.show - In der Episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) gesagt haben, ist dies ein riesiges Unterfangen, welchem das Team und ich uns annehmen. In Zukunft würde ich liebend gerne Vollzeit an dem Projekt arbeiten und bitte daher um Eure Unterstützung.
-
-Wenn Du denkst, dass dies die richtige Sache ist und dich selbst die App für eine längere Zeit nutzen siehst, dann denke bitte darüber nach, das Projekt mit einer der unten aufgelisteten Optionen zu unterstützen.  
-
-### Spenden
-
-- [Monatliche Spende](https://github.com/sponsors/immich-app) via GitHub Sponsors
-- [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
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
-
-## Mitwirkende
-<a href="https://github.com/alextran1502/immich/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
-</a>

README_es_ES.md

@@ -19,15 +19,9 @@
 <br/>
 <p align="center">
   <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
   <a href="README_zh_CN.md">中文</a>
+  <a href="README_tr_TR.md">Türkçe</a>
+  <a href="README_ca_ES.md">Català</a>
 </p>
 
 ## Descargo de responsabilidad
@@ -112,4 +106,3 @@ Si consideras que esta es una causa justa y la aplicación es algo que te gustar
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_fr_FR.md

@@ -1,116 +0,0 @@
-<p align="center"> 
-  <br/>  
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
-</p>
-<h3 align="center">Immich - Solution de sauvegarde performante et auto-hébergée des photos et des vidéos</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## Clause de non-responsabilité
-
-- ⚠️ Le projet est en **très fort** développement.
-- ⚠️ Attendez-vous à rencontrer des bugs et des changements importants.
-- ⚠️ **N'utilisez pas cette application comme seule façon de sauvegarder vos photos et vos vidéos.**
-- ⚠️ Ayez toujours un plan de sauvegarde en [3-2-1](https://www.seagate.com/fr/fr/blog/what-is-a-3-2-1-backup-strategy/) pour vos précieuses photos et vidéos !
-
-## Sommaire
-
-- [Documentation officielle](https://immich.app/docs)
-- [Feuille de route](https://github.com/orgs/immich-app/projects/1)
-- [Démo](#demo)
-- [Fonctionnalités](#features)
-- [Introduction](https://immich.app/docs/overview/introduction)
-- [Installation](https://immich.app/docs/install/requirements)
-- [Contribution](https://immich.app/docs/overview/support-the-project)
-- [Soutenir le projet](#support-the-project)
-
-## Documentation
-
-Vous pouvez trouver la documentation principale ainsi que les guides d'installation sur https://immich.app/.
-
-## Démo
-
-Vous pouvez accéder à la démo Web sur https://demo.immich.app
-
-Pour l'application mobile, vous pouvez utiliser `https://demo.immich.app/api` dans le champ 'URL du point d'accès au serveur'
-
-```bash title="Demo Credential"
-Les identifiants
-email: demo@immich.app
-mot de passe: demo
-```
-
-```
-Caractéristiques: Plan gratuit Oracle VM - Amsterdam - 2.4Ghz quatre-cœurs ARM64 CPU, 24GB RAM
-```
-
-# Fonctionnalités
-
-| Fonctionnalités                                                  | Mobile | Web |
-| ---------------------------------------------------------------- | ------ | --- |
-| Téléverser et voir les vidéos et photos                          | Oui    | Oui |
-| Sauvegarde automatique quand l'application est ouverte           | Oui    | N/A |
-| Sélection des albums à sauvegarder                               | Oui    | N/A |
-| Télécharger les photos et les vidéos sur l'appareil              | Oui    | Oui |
-| Support multi-utilisateur                                        | Oui    | Oui |
-| Albums et albums partagés                                        | Oui    | Oui |
-| Barre de défilement mobile                                       | Oui    | Oui |
-| Support des formats raw                                          | Oui    | Oui |
-| Vue sur les métadonnées (EXIF, carte)                            | Oui    | Oui |
-| Rechercher par métadonnées, objets, faces et CLIP                | Oui    | Oui |
-| Fonctions d'administration (gestion des utilisateurs)            | Non    | Oui |
-| Sauvegarde en tâche de fond                                      | Oui    | N/A |
-| Défilement virtuel                                               | Oui    | Oui |
-| Support de l'OAuth                                               | Oui    | Oui |
-| Clés d'API                                                       | N/A    | Oui |
-| Sauvegarde et lecture des LivePhotos                             | iOS    | Oui |
-| Structure de stockage définissable                               | Oui    | Oui |
-| Partage public                                                   | Non    | Oui |
-| Archives et favoris                                              | Oui    | Oui |
-| Carte globale                                                    | Non    | Oui |
-| Partage entre utilisateurs                                       | Oui    | Oui |
-| Reconnaissance et regroupement facial                            | Oui    | Oui |
-| Souvenirs (il y a x années)                                      | Oui    | Oui |
-| Support hors-ligne                                               | Oui    | Non |
-| Gallerie en lecture seule                                        | Oui    | Oui |
-
-# Soutenir le projet
-
-Je me suis engagé sur ce projet, et je ne compte pas m'arrêter. Je continuerai à mettre à jour les documentations, d'ajouter de nouvelles fonctionnalités et de résoudre des bugs. Mais je ne peux pas faire cela seul. Donc j'ai besoin de votre aide pour me donner encore plus de motivation et ainsi continuer.
-
-Comme l'ont dit nos hôtes dans le [selfhosted.show - Dans l'épisode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418), c'est un travail colossal ce que l'équipe et moi faisons. J'aimerais un jour être capable de faire ça à temps plein, c'est pourquoi je vous demande votre aide pour rendre cela possible.
-
-Si vous estimez que c'est pour la bonne cause et que vous prévoyez d'utiliser l'application pour un moment, s'il-vous-plaît, pensez à soutenir le projet avec les moyens ci-dessous.
-
-## 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
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_it_IT.md

@@ -1,117 +0,0 @@
-<p align="center"> 
-  <br/>  
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
-</p>
-<h3 align="center">Immich - Soluzione self-hosted ad alte prestazioni per backup di foto e video</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## Declino di responsabilità
-
-- ⚠️ Il progetto è in una fase **molto intensa** di sviluppo.
-- ⚠️ Possibilità di bug e cambiamenti rilevanti.
-- ⚠️ **Non utilizzare l'app come unico salvataggio delle tue foto e dei tuoi video.**
-- ⚠️ Utilizza sempre una tecnica [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) di backup per le foto e i video a cui tieni!
-
-## Contenuto
-
-- [Documentazione Ufficiale](https://immich.app/docs)
-- [Roadmap](https://github.com/orgs/immich-app/projects/1)
-- [Demo](#demo)
-- [Funzionalità](#features)
-- [Introduzione](https://immich.app/docs/overview/introduction)
-- [Installazione](https://immich.app/docs/install/requirements)
-- [Linee Guida per Contribuire](https://immich.app/docs/overview/support-the-project)
-- [Supporta il Progetto](#support-the-project)
-
-## Documentazione
-
-La documentazione ufficiale, inclusa la guida all'installazione, è disponibile qui: https://immich.app/.
-
-## Demo
-
-Prova la demo del progetto https://demo.immich.app
-
-Sull'app mobile, imposta `https://demo.immich.app/api` come `Server Endpoint URL`
-
-```bash title="Demo Credential"
-Credenziali di accesso
-email: demo@immich.app
-password: demo
-```
-
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-# Funzionalità
-
-| Funzionalità                                   | Mobile | Web |
-| ---------------------------------------------- | ------ | --- |
-| Caricamento e visualizzazione di foto e video  |   Sì   | Sì  |
-| Backup automatico quando l'app è in esecuzione |   Sì   | N/D |
-| Selezione degli album per backup               |   Sì   | N/D |
-| Download foto e video sul dispositivo          |   Sì   | Sì  |
-| Supporto multi utente                          |   Sì   | Sì  |
-| Album e album condivisi                        |   Sì   | Sì  |
-| Barra di scorrimento con trascinamento         |   Sì   | Sì  |
-| Supporto formati raw                           |   Sì   | Sì  |
-| Visualizzazione metadata (EXIF, map)           |   Sì   | Sì  |
-| Ricerca per metadata, oggetti, volti e CLIP    |   Sì   | Sì  |
-| Funzioni di amministrazione degli utenti       |   No   | Sì  |
-| Backup in background                           |   Sì   | N/D |
-| Scroll virtuale                                |   Sì   | Sì  |
-| Supporto OAuth                                 |   Sì   | Sì  |
-| API Keys                                       |  N/D   | Sì  |
-| Backup e riproduzione di LivePhoto             |  iOS   | Sì  |
-| Archiviazione impostata dall'utente            |   Sì   | Sì  |
-| Condivisione pubblica                          |   No   | Sì  |
-| Archivio e Preferiti                           |   Sì   | Sì  |
-| Mappa globale                                  |   Sì   | Sì  |
-| Collaborazione con utenti                      |   Sì   | Sì  |
-| Riconoscimento facciale e categorizzazione     |   Sì   | Sì  |
-| Ricordi (x anni fa)                            |   Sì   | Sì  |
-| Supporto offline                               |   Sì   | No  |
-| Galleria sola lettura                          |   Sì   | Sì  |
-| Foto raggruppate                               |   Sì   | Sì  |
-
-# Supporta il progetto
-
-Mi dedico al progetto e non smetterò di farlo. Manterrò aggiornata la documentazione, aggiungerò nuove funzioni e risolverò i bug, ma non posso farlo da solo. Ho bisogno del tuo aiuto che mi da motivazione per continuare.
-
-Come detto dal nostro host [selfhosted.show - Nell'episodio 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418), quello che il team ed io stiamo facendo è un lavoro enorme. Mi piacerebbe dedicarmi al progetto full-time e chiedo il tuo aiuto affinchè sia possibile.
-
-Se pensi che Immich sia una buona causa e che l'app sia qualcosa che useresti nel lungo termine, sappi che puoi supportare il progetto scegliendo tra le opzioni sotto elencate.
-
-## 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
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_ja_JP.md

@@ -1,115 +0,0 @@
-<p align="center">
-  <br/>
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>
-  <br/>
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
-</p>
-<h3 align="center">Immich - 高性能なセルフホスト 写真/ビデオバックアップソリューション</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## 免責事項
-
-- ⚠️ このプロジェクトは **非常に活発に** 開発中です。
-- ⚠️ バグの存在や変更が入ることも予想されます。
-- ⚠️ **写真やビデオを保存する唯一の方法としてこのアプリを使用しないでください。**
-- ⚠️ 大切な写真やビデオは、常に [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) のバックアッププランに従ってください！
-
-## コンテンツ
-
-- [公式ドキュメント](https://immich.app/docs)
-- [ロードマップ](https://github.com/orgs/immich-app/projects/1)
-- [デモ](#デモ)
-- [機能](#機能)
-- [紹介](https://immich.app/docs/overview/introduction)
-- [インストール](https://immich.app/docs/install/requirements)
-- [コントリビューションガイド](https://immich.app/docs/overview/support-the-project)
-- [プロジェクトのサポート](#プロジェクトのサポート)
-
-## ドキュメント
-
-インストールガイドを含む主なドキュメントは、https://immich.app/ です。
-
-## デモ
-
-web デモは https://demo.immich.app からアクセスできます
-
-モバイルアプリの場合、`Server Endpoint URL` には `https://demo.immich.app/api` を使用することができます
-
-```bash title="Demo Credential"
-The credential
-email: demo@immich.app
-password: demo
-```
-
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-# 機能
-
-| 機能                                        | モバイル | Web |
-| ------------------------------------------- | ------ | --- |
-| ビデオや写真のアップロードと表示                 | はい    | はい |
-| アプリを開いたとき自動バックアップ               | はい    | N/A |
-| バックアップ用アルバム選択                      | はい    | N/A |
-| 写真やビデオをローカルデバイスにダウンロード       | はい    | はい |
-| マルチユーザー対応                             | はい    | はい |
-| アルバムと共有アルバム                         | はい    | はい |
-| スクラブ可能/ドラッグ可能スクロールバ            | はい    | はい |
-| 生のフォーマットに対応                         | はい    | はい |
-| メタデータ表示（EXIF、地図）                   | はい    | はい |
-| メタデータ、オブジェクト、フェース、CLIPによる検索 | はい    | はい |
-| 管理機能（ユーザー管理）                       | いいえ     | はい |
-| バックグラウンドバックアップ                    | はい    | N/A |
-| 仮想スクロール                                | はい    | はい |
-| OAuth サポート                               | はい    | はい |
-| API キー                                    | N/A    | はい |
-| LivePhoto のバックアップと再生                | iOS    | はい |
-| ユーザー定義のストレージ構造                   | はい    | はい |
-| 公開シェアリング                             | いいえ     | はい |
-| アーカイブとお気に入り                        | はい    | はい |
-| グローバルマップ                             | はい    | はい |
-| パートナー共有                               | はい    | はい |
-| 思い出（x 年前）顔認識とクラスタリング           | はい    | はい |
-| 思い出（x 年前）                             | はい    | はい |
-| オフラインサポート                            | はい    | いいえ  |
-| 読み取り専用ギャラリー                        | はい    | はい |
-
-# プロジェクトのサポート
-
-私はこのプロジェクトにコミットしてきました。ドキュメントを更新し、新しい機能を追加し、バグを修正し続けるつもりですが、私ひとりではできません。だから、続けるためのモチベーションをさらに高めてくれる皆さんの助けが必要なのです。
-
-[selfhosted.show - In the episode 'The-organization-must-いいえt-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) のホストが言ったように、これはチームと私がやっていることの大規模な事業だ。そしていつの日か、フルタイムでこの仕事ができるようになりたいと思っています。
-
-もし、あなたがこのプロジェクトに賛同し、このアプリを長く使い続けたいと思われるのであれば、以下のオプションから支援をご検討ください。
-
-## 寄付
-
-- GitHub スポンサー経由の[毎月の寄付](https://github.com/sponsors/alextran1502)
-- GitHub スポンサー経由の[一回寄付](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_ko_KR.md

@@ -1,117 +0,0 @@
-<p align="center"> 
-  <br/>  
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
-</p>
-<h3 align="center">Immich - 고성능 자체 호스팅 사진 및 동영상 백업 솔루션</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## 주의 사항
-
-- ⚠️ 이 프로젝트는 **매우 활발히** 개발 중입니다.
-- ⚠️ 버그 및 잦은 변경 사항이 있을 수 있습니다.
-- ⚠️ **사진과 동영상을 저장하는 유일한 방법으로 사용하지 마세요.**
-- ⚠️ 중요한 사진과 동영상을 위해 항상 [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) 백업 계획을 따르세요!
-
-## 목차
-
-- [공식 문서](https://immich.app/docs)
-- [로드맵](https://github.com/orgs/immich-app/projects/1)
-- [데모](#demo)
-- [기능](#features)
-- [소개](https://immich.app/docs/overview/introduction)
-- [설치](https://immich.app/docs/install/requirements)
-- [기여 가이드](https://immich.app/docs/overview/support-the-project)
-- [프로젝트 지원](#support-the-project)
-
-## 문서
-
-설치 가이드를 포함한 주요 문서는 https://immich.app 에서 확인할 수 있습니다.
-
-## 데모
-
-https://demo.immich.app 에서 웹 데모를 체험할 수 있습니다.
-
-모바일 앱의 경우 `서버 엔드포인트 URL`에 `https://demo.immich.app`를 입력합니다.
-
-```bash title="Demo Credential"
-자격 증명
-email: demo@immich.app
-password: demo
-```
-
-```
-사양: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-## 기능
-
-| 기능                                  | 모바일 | 웹 |
-| ------------------------------------ | ----- | ----- |
-| 사진, 동영상 업로드 및 보기 | 예 | 예 |
-| 앱을 열 때 자동으로 백업 | 예 | N/A |
-| 백업용 앨범 선택 | 예 | N/A |
-| 로컬 기기로 사진 및 동영상 다운로드 | 예 | 예 |
-| 다른 사용자 추가 | 예 | 예 |
-| 앨범 및 공유 앨범 | 예 | 예 |
-| 스와이프/드래그 가능한 스크롤 바 | 예 | 예 |
-| RAW 포맷 지원 | 예 | 예 |
-| 메타데이터 보기 (EXIF, 위치) | 예 | 예 |
-| 메타데이터, 사물, 얼굴 및 클립으로 검색 | 예 | 예 |
-| 관리 기능 (사용자 관리) | 아니요 | 예 |
-| 백그라운드 백업 | 예 | N/A |
-| 가상 스크롤 | 예 | 예 |
-| OAuth 지원 | 예 | 예 |
-| API 키 | N/A | 예 |
-| 라이브 포토/모션 포토 백업 및 재생 | 예 | 예 |
-| 사용자 정의 스토리지 구조 | 예 | 예 |
-| 모든 사용자와 공유 | 아니요 | 예 |
-| 아카이브 및 즐겨찾기 | 예 |예|
-| 글로벌 지도 | 예 | 예 |
-| 특정 사용자와 공유 | 예 | 예 |
-| 얼굴 인식 및 클러스터링 | 예 | 예 |
-| 추억 (~년 전) | 예 | 예 |
-| 오프라인 지원 | 예 | 아니요 |
-| 읽기 전용 갤러리 | 예 | 예 |
-| 사진 스택 | 예 | 예 |
-
-## 프로젝트 지원
-
-저는 이 프로젝트에 전념해왔고, 앞으로도 멈추지 않을 것입니다. 문서를 업데이트하고, 새로운 기능을 추가하고, 버그를 수정하려 합니다. 하지만 혼자서는 할 수 없습니다. 계속해서 나아갈 수 있는 추가적인 동기부여를 위해 당신의 도움이 필요합니다.
-
-[selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) 진행자가 말했듯이, 우리가 하고 있는 것은 대규모 프로젝트입니다. 언젠가는 이 일을 풀타임으로 하는 것을 희망하며, 이를 실현하기 위해 당신의 도움이 필요합니다.
-
-만약 이에 동의하거나 이 앱을 장기간 사용하고자 한다면, 아래의 수단을 통해 이 프로젝트를 지원해 주세요.
-
-### 후원
-
-- GitHub 스폰서를 통한 [정기 후원](https://github.com/sponsors/alextran1502)
-- GitHub 스폰서를 통한 [일시 후원](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_nl_NL.md

@@ -1,116 +0,0 @@
-<p align="center"> 
-  <br/>  
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login met aangepaste URL">
-</p>
-<h3 align="center">Immich - Hoogwaardige, self-hosted back-up oplossing voor foto's en video's</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Main Screenshot">
-</a>
-<br/>
-<p align="center">
-  <a href="README.md">English</a>
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## Disclaimer
-
-- ⚠️ Het project wordt momenteel **zeer actief** ontwikkeld.
-- ⚠️ Verwacht bugs en ingrijpende wijzigingen.
-- ⚠️ **Gebruik de app niet als de enige manier om uw foto's en video's op te slaan.**
-- ⚠️ Volg altijd het [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) backup plan voor je kostbare foto's en video's!
-
-## Inhoud
-
-- [Officiële documentatie](https://immich.app/docs)
-- [Roadmap](https://github.com/orgs/immich-app/projects/1)
-- [Demo](#demo)
-- [Functies](#functies)
-- [Introductie](https://immich.app/docs/overview/introduction)
-- [Installatie](https://immich.app/docs/install/requirements)
-- [Richtlijnen voor bijdragen](https://immich.app/docs/overview/support-the-project)
-- [Steun het project](#steun-het-project)
-
-## Documentatie
-
-De belangrijkste documentatie, inclusief installatie handleidingen, zijn te vinden op https://immich.app/.
-
-## Demo
-
-De demo is te bekijken op https://demo.immich.app.
-
-Voor de mobiele app kunt u gebruik maken van `https://demo.immich.app/api` voor de `Server Endpoint URL`
-
-```bash title="Demo Credential"
-De inloggegevens
-email: demo@immich.app
-wachtwoord: demo
-```
-
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-# Functies
-
-| Functies                                            | Mobiel | Web |
-|-----------------------------------------------------|--------|-----|
-| Upload en bekijk video's en foto's                  | Ja     | Ja  |
-| Automatische back-up wanneer de app wordt geopend   | Ja     | NVT |
-| Selectieve album(s) voor back-up                    | Ja     | NVT |
-| Download foto's en video's naar een lokaal apparaat | Ja     | Ja  |
-| Ondersteuning voor meerdere gebruikers              | Ja     | Ja  |
-| Album en gedeelde albums                            | Ja     | Ja  |
-| Versleepbare scroll balk                            | Ja     | Ja  |
-| Ondersteuning voor het RAW formaat                  | Ja     | Ja  |
-| Metagegevensweergave (EXIF, kaart)                  | Ja     | Ja  |
-| Zoek op metagegevens, objecten, gezichten en CLIP   | Ja     | Ja  |
-| Administratieve functies (gebruikersbeheer)         | Nee    | Ja  |
-| Back-up op de achtergrond                           | Ja     | NVT |
-| Virtueel scrollen                                   | Ja     | Ja  |
-| OAuth-ondersteuning                                 | Ja     | Ja  |
-| API-sleutels                                        | NVT    | Ja  |
-| LivePhoto-back-up en weergave                       | iOS    | Ja  |
-| Door de gebruiker gedefinieerde opslagstructuur     | Ja     | Ja  |
-| Openbaar delen                                      | Nee    | Ja  |
-| Archief en Favorieten                               | Ja     | Ja  |
-| Wereldkaart                                         | Ja     | Ja  |
-| Delen met partner                                   | Ja     | Ja  |
-| Gezichtsherkenning en groepering                    | Ja     | Ja  |
-| Herinneringen (x jaar geleden)                      | Ja     | Ja  |
-| Offline-ondersteuning                               | Ja     | Nee |
-| Alleen-lezen galerij                                | Ja     | Ja  |
-
-# Steun het project
-
-Ik ben trouw aan dit project en ik zal niet stoppen. Ik zal de documenten blijven bijwerken, nieuwe functies toevoegen en bugs oplossen. Maar ik kan het niet alleen. Ik heb dus jouw hulp nodig om mij extra motivatie te geven om door te gaan.
-
-Als onze gastheren in de [selfhosted.show - In de aflevering 'The-organization-must-Neet-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) zeiden, dit is een enorme onderneming van wat het team en ik doen. En ik zou dit graag fulltime willen doen, ik vraag jouw hulp om dat mogelijk te maken.
-
-Als je denkt dat dit het juiste doel is en de app iets is dat je jezelf al heel lang ziet gebruiken, overweeg dan om het project te steunen met de onderstaande optie.
-
-## 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
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_tr_TR.md

@@ -19,15 +19,9 @@
 <br/>
 <p align="center">
   <a href="README.md">English</a>
+  <a href="README_zh_CN.md">中文</a>
   <a href="README_ca_ES.md">Català</a>
   <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_zh_CN.md">中文</a>
 </p>
 
 ## Feragatname
@@ -110,4 +104,3 @@ Eğer bu size doğru bir amaç gibi geliyorsa ve uygulamanın uzun bir süre boy
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_zh_CN.md

@@ -23,17 +23,12 @@
 
 <p align="center">
   <a href="README.md">English</a>
+  <a href="README_tr_TR.md">Türkçe</a>
   <a href="README_ca_ES.md">Català</a>
   <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
 </p>
 
+
 ## 免责声明
 
 - ⚠️ 本项目正在 **非常活跃** 地开发中。

cli/.eslintrc.js

@@ -18,7 +18,6 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/no-floating-promises': 'error',
     'prettier/prettier': 0,
   },
 };

cli/.gitignore

@@ -10,6 +10,4 @@ oclif.manifest.json
 
 .vscode
 .idea
-/coverage/
-.reverse-geocoding-dump/
-upload/
+/coverage/

cli/.npmignore

@@ -1,12 +0,0 @@
-**/*.spec.js
-test/**
-upload/**
-.editorconfig
-.eslintignore
-.eslintrc.js
-.prettierignore
-.prettierrc
-package-lock.json
-testSetup.js
-tsconfig.json
-tsconfig.build.json

cli/Dockerfile

@@ -1,19 +0,0 @@
-FROM ghcr.io/immich-app/base-server-dev:20231109 as test
-
-WORKDIR /usr/src/app/server
-COPY server/package.json server/package-lock.json ./
-RUN npm ci
-COPY ./server/ .
-
-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:20231109
-
-VOLUME /usr/src/app/upload
-
-EXPOSE 3001
-
-ENTRYPOINT ["tini", "--", "/bin/sh"]

cli/README.md

@@ -1,19 +1,46 @@
-A command-line interface for interfacing with the self-hosted photo manager [Immich](https://immich.app/).
+A command-line interface for interfacing with Immich
 
-Please see the [Immich CLI documentation](https://immich.app/docs/features/command-line-interface).
+# Getting started
 
-# For developers
+    $ ts-node cli/src
 
-To run the Immich CLI from source, run the following in the cli folder:
+To start using the CLI, you need to login with an API key first:
 
-    $ npm run build
-    $ ts-node .
+    $ ts-node cli/src login-key https://your-immich-instance/api your-api-key
 
-You'll need ts-node, the easiest way to install it is to use npm:
+NOTE: This will store your api key under ~/.config/immich/auth.yml
 
-    $ npm i -g ts-node
+Next, you can run commands:
 
-You can also build and install the CLI using
+    $ ts-node cli/src server-info
 
-    $ npm run build
-    $ npm install -g .
+When you're done, log out to remove the credentials from your filesystem
+
+    $ ts-node cli/src logout
+
+# Usage
+
+```
+Usage: immich [options] [command]
+
+Immich command line interface
+
+Options:
+  -h, --help                        display help for command
+
+Commands:
+  upload [options] [paths...]       Upload assets
+  import [options] [paths...]       Import existing assets
+  server-info                       Display server information
+  login-key [instanceUrl] [apiKey]  Login using an API key
+  help [command]                    display help for command
+```
+
+# Todo
+
+- Sidecar should check both .jpg.xmp and .xmp
+- Sidecar check could be case-insensitive
+
+# Known issues
+
+- Upload can't use sdk due to multiple issues

cli/package.json

@@ -1,28 +1,17 @@
 {
-  "name": "@immich/cli",
-  "version": "2.0.5",
-  "description": "Command Line Interface (CLI) for Immich",
-  "main": "dist/index.js",
-  "bin": {
-    "immich": "./dist/src/index.js"
-  },
-  "license": "MIT",
-  "keywords": [
-    "immich",
-    "cli"
-  ],
+  "name": "immich-cli",
   "dependencies": {
-    "axios": "^1.6.2",
+    "axios": "^1.4.0",
     "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",
+    "picomatch": "^2.3.1",
+    "systeminformation": "^5.18.4",
     "yaml": "^2.3.1"
   },
   "devDependencies": {
-    "@testcontainers/postgresql": "^10.4.0",
     "@types/byte-size": "^8.1.0",
     "@types/chai": "^4.3.5",
     "@types/cli-progress": "^3.11.0",
@@ -31,15 +20,14 @@
     "@types/mime-types": "^2.1.1",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^20.3.1",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.48.1",
     "chai": "^4.3.7",
     "eslint": "^8.43.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-jest": "^27.2.2",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-unicorn": "^49.0.0",
-    "immich": "file:../server",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-unicorn": "^47.0.0",
     "jest": "^29.5.0",
     "jest-extended": "^4.0.0",
     "jest-message-util": "^29.5.0",
@@ -49,19 +37,15 @@
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
-    "typescript": "^5.0.0"
+    "typescript": "^4.9.4"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
-    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
-    "lint:fix": "npm run lint -- --fix",
-    "prepack": "npm run build",
+    "lint": "eslint \"src/**/*.ts\" --max-warnings 0",
+    "prepack": "yarn build ",
     "test": "jest",
     "test:cov": "jest --coverage",
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "check": "tsc --noEmit",
-    "test:e2e": "NODE_OPTIONS='--experimental-vm-modules' jest --config test/e2e/jest-e2e.json --runInBand"
+    "format": "prettier --check ."
   },
   "jest": {
     "clearMocks": true,
@@ -76,22 +60,9 @@
       "^.+\\.ts$": "ts-jest"
     },
     "collectCoverageFrom": [
-      "<rootDir>/src/**/*.(t|j)s",
-      "!**/open-api/**"
+      "<rootDir>/src/**/*.(t|j)s"
     ],
-    "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"
-  },
-  "repository": {
-    "type": "git",
-    "url": "github:immich-app/immich",
-    "directory": "cli"
   }
 }

cli/src/__mocks__/axios.ts

@@ -0,0 +1,3 @@
+// ./__mocks__/axios.js
+import mockAxios from 'jest-mock-axios';
+export default mockAxios;

cli/src/api/client.ts

@@ -11,7 +11,6 @@ import {
   UserApi,
 } from './open-api';
 import { ApiConfiguration } from '../cores/api-configuration';
-import FormData from 'form-data';
 
 export class ImmichApi {
   public userApi: UserApi;
@@ -36,7 +35,6 @@ export class ImmichApi {
           'x-api-key': apiKey,
         },
       },
-      formDataCtor: FormData,
     });
 
     this.userApi = new UserApi(this.config);

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

@@ -4,7 +4,7 @@
  * Immich
  * Immich API
  *
- * The version of the OpenAPI document: 1.91.4
+ * The version of the OpenAPI document: 1.73.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Immich
  * Immich API
  *
- * The version of the OpenAPI document: 1.91.4
+ * The version of the OpenAPI document: 1.73.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Immich
  * Immich API
  *
- * The version of the OpenAPI document: 1.91.4
+ * The version of the OpenAPI document: 1.73.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Immich
  * Immich API
  *
- * The version of the OpenAPI document: 1.91.4
+ * The version of the OpenAPI document: 1.73.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

cli/src/cli/base-command.ts

@@ -1,21 +1,26 @@
 import { ImmichApi } from '../api/client';
+import path from 'node:path';
 import { SessionService } from '../services/session.service';
 import { LoginError } from '../cores/errors/login-error';
 import { exit } from 'node:process';
-import { ServerVersionResponseDto, UserResponseDto } from 'src/api/open-api';
-import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
+import os from 'os';
+import { ServerVersionReponseDto, UserResponseDto } from 'src/api/open-api';
 
 export abstract class BaseCommand {
   protected sessionService!: SessionService;
   protected immichApi!: ImmichApi;
+  protected deviceId!: string;
   protected user!: UserResponseDto;
-  protected serverVersion!: ServerVersionResponseDto;
+  protected serverVersion!: ServerVersionReponseDto;
 
-  constructor(options: BaseOptionsDto) {
-    if (!options.config) {
-      throw new Error('Config directory is required');
-    }
-    this.sessionService = new SessionService(options.config);
+  protected configDir;
+  protected authPath;
+
+  constructor() {
+    const userHomeDir = os.homedir();
+    this.configDir = path.join(userHomeDir, '.config/immich/');
+    this.sessionService = new SessionService(this.configDir);
+    this.authPath = path.join(this.configDir, 'auth.yml');
   }
 
   public async connect(): Promise<void> {

cli/src/commands/server-info.ts

@@ -1,19 +1,15 @@
 import { BaseCommand } from '../cli/base-command';
 
 export default class ServerInfo extends BaseCommand {
+  static description = 'Display server information';
+  static enableJsonFlag = true;
+
   public async run() {
+    console.log('Getting server information');
+
     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}`);
+    console.log(versionInfo);
   }
 }

cli/src/commands/upload.ts

@@ -1,48 +1,43 @@
-import { Asset } from '../cores/models/asset';
-import { CrawlService } from '../services';
+import { BaseCommand } from '../cli/base-command';
+import { CrawledAsset } from '../cores/models/crawled-asset';
+import { CrawlService, UploadService } from '../services';
+import * as si from 'systeminformation';
+import FormData from 'form-data';
 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 } from 'axios';
-import FormData from 'form-data';
 
 export default class Upload extends BaseCommand {
+  private crawlService = new CrawlService();
+  private uploadService!: UploadService;
+  deviceId!: string;
   uploadLength!: number;
+  dryRun = false;
 
   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 uuid = await si.uuid();
+    this.deviceId = uuid.os || 'CLI';
+    this.uploadService = new UploadService(this.immichApi.apiConfiguration);
+
+    this.dryRun = options.dryRun;
 
     const crawlOptions = new CrawlOptionsDto();
     crawlOptions.pathsToCrawl = paths;
     crawlOptions.recursive = options.recursive;
-    crawlOptions.exclusionPatterns = options.exclusionPatterns;
+    crawlOptions.excludePatterns = options.excludePatterns;
 
-    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);
+    const crawledFiles: string[] = await this.crawlService.crawl(crawlOptions);
 
     if (crawledFiles.length === 0) {
       console.log('No assets found, exiting');
       return;
     }
 
-    const assetsToUpload = crawledFiles.map((path) => new Asset(path));
+    const assetsToUpload = crawledFiles.map((path) => new CrawledAsset(path));
 
     const uploadProgress = new cliProgress.SingleBar(
       {
@@ -63,108 +58,118 @@ export default class Upload extends BaseCommand {
       totalSize += asset.fileSize;
     }
 
-    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,
-        });
+    for (const asset of assetsToUpload) {
+      uploadProgress.update({
+        filename: asset.path,
+      });
 
-        let skipUpload = false;
-        if (!options.skipHash) {
-          const assetBulkUploadCheckDto = { assets: [{ id: asset.path, checksum: await asset.hash() }] };
+      try {
+        if (options.import) {
+          const importData = {
+            assetPath: asset.path,
+            sidecarPath: asset.sidecarPath,
+            deviceAssetId: asset.deviceAssetId,
+            deviceId: this.deviceId,
+            fileCreatedAt: asset.fileCreatedAt,
+            fileModifiedAt: asset.fileModifiedAt,
+            isFavorite: false,
+            isReadOnly: options.readOnly,
+          };
 
-          const checkResponse = await this.immichApi.assetApi.checkBulkUpload({
-            assetBulkUploadCheckDto,
-          });
-
-          skipUpload = checkResponse.data.results[0].action === 'reject';
-        }
-
-        if (!skipUpload) {
-          if (!options.dryRun) {
-            const formData = asset.getUploadFormData();
-            const res = await this.uploadAsset(formData);
-
-            if (options.album && asset.albumName) {
-              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);
-              }
-
-              await this.immichApi.albumApi.addAssetsToAlbum({ id: album.id, bulkIdsDto: { ids: [res.data.id] } });
-            }
+          if (!this.dryRun) {
+            await this.uploadService.import(importData);
           }
-
-          totalSizeUploaded += asset.fileSize;
-          uploadCounter++;
+        } else {
+          await this.uploadAsset(asset, options.skipHash);
         }
-
-        sizeSoFar += asset.fileSize;
-
-        uploadProgress.update(sizeSoFar, { value_formatted: byteSize(sizeSoFar) });
+      } catch (error) {
+        uploadProgress.stop();
+        throw error;
       }
-    } finally {
-      uploadProgress.stop();
+
+      sizeSoFar += asset.fileSize;
+      if (!asset.skipped) {
+        totalSizeUploaded += asset.fileSize;
+        uploadCounter++;
+      }
+
+      uploadProgress.update(sizeSoFar, { value_formatted: byteSize(sizeSoFar) });
     }
 
+    uploadProgress.stop();
+
     let messageStart;
-    if (options.dryRun) {
-      messageStart = 'Would have';
+    if (this.dryRun) {
+      messageStart = 'Would have ';
     } else {
-      messageStart = 'Successfully';
+      messageStart = 'Successfully ';
     }
 
-    if (uploadCounter === 0) {
-      console.log('All assets were already uploaded, nothing to do.');
+    if (options.import) {
+      console.log(`${messageStart} imported ${uploadCounter} assets (${byteSize(totalSizeUploaded)})`);
     } 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`);
+      if (uploadCounter === 0) {
+        console.log('All assets were already uploaded, nothing to do.');
       } else {
-        console.log('Deleting assets that have been uploaded...');
-        const deletionProgress = new cliProgress.SingleBar(cliProgress.Presets.shades_classic);
-        deletionProgress.start(crawledFiles.length, 0);
+        console.log(`${messageStart} uploaded ${uploadCounter} assets (${byteSize(totalSizeUploaded)})`);
+      }
+      if (options.delete) {
+        if (this.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();
+          for (const asset of assetsToUpload) {
+            if (!this.dryRun) {
+              await asset.delete();
+            }
+            deletionProgress.increment();
           }
-          deletionProgress.increment();
+          deletionProgress.stop();
+          console.log('Deletion complete');
         }
-        deletionProgress.stop();
-        console.log('Deletion complete');
       }
     }
   }
 
-  private async uploadAsset(data: FormData): Promise<axios.AxiosResponse> {
-    const url = this.immichApi.apiConfiguration.instanceUrl + '/asset/upload';
+  private async uploadAsset(asset: CrawledAsset, skipHash = false) {
+    await asset.readData();
 
-    const config: AxiosRequestConfig = {
-      method: 'post',
-      maxRedirects: 0,
-      url,
-      headers: {
-        'x-api-key': this.immichApi.apiConfiguration.apiKey,
-        ...data.getHeaders(),
-      },
-      maxContentLength: Infinity,
-      maxBodyLength: Infinity,
-      data,
-    };
+    let skipUpload = false;
+    if (!skipHash) {
+      const checksum = await asset.hash();
 
-    const res = await axios(config);
-    return res;
+      const checkResponse = await this.uploadService.checkIfAssetAlreadyExists(asset.path, checksum);
+      skipUpload = checkResponse.data.results[0].action === 'reject';
+    }
+
+    if (skipUpload) {
+      asset.skipped = true;
+    } else {
+      const uploadFormData = new FormData();
+
+      uploadFormData.append('deviceAssetId', asset.deviceAssetId);
+      uploadFormData.append('deviceId', this.deviceId);
+      uploadFormData.append('fileCreatedAt', asset.fileCreatedAt);
+      uploadFormData.append('fileModifiedAt', asset.fileModifiedAt);
+      uploadFormData.append('isFavorite', String(false));
+      uploadFormData.append('assetData', asset.assetData, { filename: asset.path });
+
+      if (asset.sidecarData) {
+        uploadFormData.append('sidecarData', asset.sidecarData, {
+          filename: asset.sidecarPath,
+          contentType: 'application/xml',
+        });
+      }
+
+      if (!this.dryRun) {
+        await this.uploadService.upload(uploadFormData);
+      }
+    }
   }
 }

cli/src/constants.ts

@@ -1,37 +0,0 @@
-import pkg from '../package.json';
-
-export interface ICLIVersion {
-  major: number;
-  minor: number;
-  patch: number;
-}
-
-export class CLIVersion implements ICLIVersion {
-  constructor(
-    public readonly major: number,
-    public readonly minor: number,
-    public readonly patch: number,
-  ) {}
-
-  toString() {
-    return `${this.major}.${this.minor}.${this.patch}`;
-  }
-
-  toJSON() {
-    const { major, minor, patch } = this;
-    return { major, minor, patch };
-  }
-
-  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);
-    } else {
-      throw new Error(`Invalid version format: ${version}`);
-    }
-  }
-}
-
-export const cliVersion = CLIVersion.fromString(pkg.version);

cli/src/cores/constants.ts

@@ -0,0 +1,58 @@
+// Check asset-upload.config.spec.ts for complete list
+// TODO: we should get this list from the server via API in the future
+
+// Videos
+const videos = ['mp4', 'webm', 'mov', '3gp', 'avi', 'm2ts', 'mts', 'mpg', 'flv', 'mkv', 'wmv'];
+
+// Images
+const heic = ['heic', 'heif'];
+const jpeg = ['jpg', 'jpeg'];
+const png = ['png'];
+const gif = ['gif'];
+const tiff = ['tif', 'tiff'];
+const webp = ['webp'];
+const dng = ['dng'];
+const other = [
+  '3fr',
+  'ari',
+  'arw',
+  'avif',
+  'cap',
+  'cin',
+  'cr2',
+  'cr3',
+  'crw',
+  'dcr',
+  'nef',
+  'erf',
+  'fff',
+  'iiq',
+  'jxl',
+  'k25',
+  'kdc',
+  'mrw',
+  'orf',
+  'ori',
+  'pef',
+  'raf',
+  'raw',
+  'rwl',
+  'sr2',
+  'srf',
+  'srw',
+  'orf',
+  'ori',
+  'x3f',
+];
+
+export const ACCEPTED_FILE_EXTENSIONS = [
+  ...videos,
+  ...jpeg,
+  ...png,
+  ...heic,
+  ...gif,
+  ...tiff,
+  ...webp,
+  ...dng,
+  ...other,
+];

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 +1,6 @@
 export class CrawlOptionsDto {
   pathsToCrawl!: string[];
-  recursive? = false;
-  includeHidden? = false;
-  exclusionPatterns?: string[];
+  recursive = false;
+  includeHidden = false;
+  excludePatterns!: string[];
 }

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

@@ -1,8 +1,9 @@
 export class UploadOptionsDto {
-  recursive? = false;
-  exclusionPatterns?: string[] = [];
-  dryRun? = false;
-  skipHash? = false;
-  delete? = false;
-  album? = false;
+  recursive = false;
+  excludePatterns!: string[];
+  dryRun = false;
+  skipHash = false;
+  delete = false;
+  import = false;
+  readOnly = true;
 }

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

@@ -2,8 +2,10 @@ export class LoginError extends Error {
   constructor(message: string) {
     super(message);
 
+    // assign the error class name in your custom error (as a shortcut)
     this.name = this.constructor.name;
 
+    // capturing the stack trace keeps the reference to your error class
     Error.captureStackTrace(this, this.constructor);
   }
 }

cli/src/cores/index.ts

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

cli/src/cores/models/asset.ts

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

cli/src/cores/models/crawled-asset.ts

@@ -0,0 +1,58 @@
+import * as fs from 'fs';
+import { basename } from 'node:path';
+import crypto from 'crypto';
+
+export class CrawledAsset {
+  public path: string;
+
+  public assetData?: fs.ReadStream;
+  public deviceAssetId?: string;
+  public fileCreatedAt?: string;
+  public fileModifiedAt?: string;
+  public sidecarData?: Buffer;
+  public sidecarPath?: string;
+  public fileSize!: number;
+  public skipped = false;
+
+  constructor(path: string) {
+    this.path = path;
+  }
+
+  async readData() {
+    this.assetData = fs.createReadStream(this.path);
+  }
+
+  async process() {
+    const stats = await fs.promises.stat(this.path);
+    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
+    this.fileCreatedAt = stats.ctime.toISOString();
+    this.fileModifiedAt = stats.mtime.toISOString();
+    this.fileSize = stats.size;
+
+    // TODO: doesn't xmp replace the file extension? Will need investigation
+    const sideCarPath = `${this.path}.xmp`;
+    try {
+      fs.accessSync(sideCarPath, fs.constants.R_OK);
+      this.sidecarData = await fs.promises.readFile(sideCarPath);
+      this.sidecarPath = sideCarPath;
+    } catch (error) {}
+  }
+
+  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);
+  }
+}

cli/src/cores/models/index.ts

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

cli/src/index.ts

@@ -1,23 +1,9 @@
-#! /usr/bin/env node
-
-import { Option, Command } from 'commander';
+import { program, Option } 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 path from 'node:path';
-import os from 'os';
-
-const userHomeDir = os.homedir();
-const configDir = path.join(userHomeDir, '.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));
+program.name('immich').description('Immich command line interface');
 
 program
   .command('upload')
@@ -26,11 +12,6 @@ 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('-a, --album', 'Automatically create albums based on folder name')
-      .env('IMMICH_AUTO_CREATE_ALBUM')
-      .default(false),
-  )
   .addOption(
     new Option('-n, --dry-run', "Don't perform any actions, just show what will be done")
       .env('IMMICH_DRY_RUN')
@@ -38,16 +19,36 @@ program
   )
   .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);
+  .action((paths, options) => {
+    options.excludePatterns = options.ignore;
+    new Upload().run(paths, options);
+  });
+
+program
+  .command('import')
+  .description('Import existing assets')
+  .usage('[options] [paths...]')
+  .addOption(new Option('-r, --recursive', 'Recursive').env('IMMICH_RECURSIVE').default(false))
+  .addOption(
+    new Option('-n, --dry-run', "Don't perform any actions, just show what will be done")
+      .env('IMMICH_DRY_RUN')
+      .default(false),
+  )
+  .addOption(new Option('-i, --ignore [paths...]', 'Paths to ignore').env('IMMICH_IGNORE_PATHS').default(false))
+  .addOption(new Option('--no-read-only', 'Import files without read-only protection, allowing Immich to manage them'))
+  .argument('[paths...]', 'One or more paths to assets to be imported')
+  .action((paths, options) => {
+    options.import = true;
+    options.excludePatterns = options.ignore;
+    new Upload().run(paths, options);
   });
 
 program
   .command('server-info')
   .description('Display server information')
-  .action(async () => {
-    await new ServerInfo(program.opts()).run();
+
+  .action(() => {
+    new ServerInfo().run();
   });
 
 program
@@ -55,15 +56,8 @@ program
   .description('Login using an API key')
   .argument('[instanceUrl]')
   .argument('[apiKey]')
-  .action(async (paths, options) => {
-    await new LoginKey(program.opts()).run(paths, options);
-  });
-
-program
-  .command('logout')
-  .description('Remove stored credentials')
-  .action(async () => {
-    await new Logout(program.opts()).run();
+  .action((paths, options) => {
+    new LoginKey().run(paths, options);
   });
 
 program.parse(process.argv);

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

@@ -1,206 +1,235 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { CrawlService } from './crawl.service';
 import mockfs from 'mock-fs';
-import { CrawlOptionsDto } from 'src/cores/dto/crawl-options-dto';
-import { CrawlService } from '.';
+import { toIncludeSameMembers } from 'jest-extended';
+import { CrawlOptionsDto } from '../cores/dto/crawl-options-dto';
 
-interface Test {
-  test: string;
-  options: CrawlOptionsDto;
-  files: Record<string, boolean>;
-}
+const matchers = require('jest-extended');
+expect.extend(matchers);
 
-const cwd = process.cwd();
+const crawlService = new CrawlService();
 
-const tests: Test[] = [
-  {
-    test: 'should return empty when crawling an empty path list',
-    options: {
-      pathsToCrawl: [],
-    },
-    files: {},
-  },
-  {
-    test: 'should crawl a single path',
-    options: {
-      pathsToCrawl: ['/photos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-    },
-  },
-  {
-    test: 'should exclude by file extension',
-    options: {
-      pathsToCrawl: ['/photos/'],
-      exclusionPatterns: ['**/*.tif'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/image.tif': false,
-    },
-  },
-  {
-    test: 'should exclude by file extension without case sensitivity',
-    options: {
-      pathsToCrawl: ['/photos/'],
-      exclusionPatterns: ['**/*.TIF'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/image.tif': false,
-    },
-  },
-  {
-    test: 'should exclude by folder',
-    options: {
-      pathsToCrawl: ['/photos/'],
-      exclusionPatterns: ['**/raw/**'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/raw/image.jpg': false,
-      '/photos/raw2/image.jpg': true,
-      '/photos/folder/raw/image.jpg': false,
-      '/photos/crawl/image.jpg': true,
-    },
-  },
-  {
-    test: 'should crawl multiple paths',
-    options: {
-      pathsToCrawl: ['/photos/', '/images/', '/albums/'],
-    },
-    files: {
-      '/photos/image1.jpg': true,
-      '/images/image2.jpg': true,
-      '/albums/image3.jpg': true,
-    },
-  },
-  {
-    test: 'should support globbing paths',
-    options: {
-      pathsToCrawl: ['/photos*'],
-    },
-    files: {
-      '/photos1/image1.jpg': true,
-      '/photos2/image2.jpg': true,
-      '/images/image3.jpg': false,
-    },
-  },
-  {
-    test: 'should crawl a single path without trailing slash',
-    options: {
-      pathsToCrawl: ['/photos'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-    },
-  },
-  {
-    test: 'should crawl a single path',
-    options: {
-      pathsToCrawl: ['/photos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/subfolder/image1.jpg': true,
-      '/photos/subfolder/image2.jpg': true,
-      '/image1.jpg': false,
-    },
-  },
-  {
-    test: 'should filter file extensions',
-    options: {
-      pathsToCrawl: ['/photos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/image.txt': false,
-      '/photos/1': false,
-    },
-  },
-  {
-    test: 'should include photo and video extensions',
-    options: {
-      pathsToCrawl: ['/photos/', '/videos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/image.jpeg': true,
-      '/photos/image.heic': true,
-      '/photos/image.heif': true,
-      '/photos/image.png': true,
-      '/photos/image.gif': true,
-      '/photos/image.tif': true,
-      '/photos/image.tiff': true,
-      '/photos/image.webp': true,
-      '/photos/image.dng': true,
-      '/photos/image.nef': true,
-      '/videos/video.mp4': true,
-      '/videos/video.mov': true,
-      '/videos/video.webm': true,
-    },
-  },
-  {
-    test: 'should check file extensions without case sensitivity',
-    options: {
-      pathsToCrawl: ['/photos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/photos/image.Jpg': true,
-      '/photos/image.jpG': true,
-      '/photos/image.JPG': true,
-      '/photos/image.jpEg': true,
-      '/photos/image.TIFF': true,
-      '/photos/image.tif': true,
-      '/photos/image.dng': true,
-      '/photos/image.NEF': true,
-    },
-  },
-  {
-    test: 'should normalize the path',
-    options: {
-      pathsToCrawl: ['/photos/1/../2'],
-    },
-    files: {
-      '/photos/1/image.jpg': false,
-      '/photos/2/image.jpg': true,
-    },
-  },
-  {
-    test: 'should return absolute paths',
-    options: {
-      pathsToCrawl: ['photos'],
-    },
-    files: {
-      [`${cwd}/photos/1.jpg`]: true,
-      [`${cwd}/photos/2.jpg`]: true,
-      [`/photos/3.jpg`]: false,
-    },
-  },
-];
+describe('CrawlService', () => {
+  beforeAll(() => {
+    // Write a dummy output before mock-fs to prevent some annoying errors
+    console.log();
+  });
 
-describe(CrawlService.name, () => {
-  const sut = new CrawlService(
-    ['.jpg', '.jpeg', '.png', '.heif', '.heic', '.tif', '.nef', '.webp', '.tiff', '.dng', '.gif'],
-    ['.mov', '.mp4', '.webm'],
-  );
+  it('should crawl a single directory', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should crawl a single file', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/image.jpg'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should crawl a file and a directory', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/images/photo.jpg': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/image.jpg', '/images/'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg', '/images/photo.jpg']);
+  });
+
+  it('should exclude by file extension', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/image.tif': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    options.excludePatterns = ['**/*.tif'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should exclude by file extension without case sensitivity', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/image.tif': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    options.excludePatterns = ['**/*.TIF'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should exclude by folder', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/raw/image.jpg': '',
+      '/photos/raw2/image.jpg': '',
+      '/photos/folder/raw/image.jpg': '',
+      '/photos/crawl/image.jpg': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    options.excludePatterns = ['**/raw/**'];
+    options.recursive = true;
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg', '/photos/raw2/image.jpg', '/photos/crawl/image.jpg']);
+  });
+
+  it('should crawl multiple paths', async () => {
+    mockfs({
+      '/photos/image1.jpg': '',
+      '/images/image2.jpg': '',
+      '/albums/image3.jpg': '',
+    });
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/', '/images/', '/albums/'];
+    options.recursive = false;
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image1.jpg', '/images/image2.jpg', '/albums/image3.jpg']);
+  });
+
+  it('should crawl a single path without trailing slash', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+    });
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should crawl a single path without recursion', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/subfolder/image1.jpg': '',
+      '/photos/subfolder/image2.jpg': '',
+      '/image1.jpg': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should crawl a single path with recursion', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/subfolder/image1.jpg': '',
+      '/photos/subfolder/image2.jpg': '',
+      '/image1.jpg': '',
+    });
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    options.recursive = true;
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers([
+      '/photos/image.jpg',
+      '/photos/subfolder/image1.jpg',
+      '/photos/subfolder/image2.jpg',
+    ]);
+  });
+
+  it('should filter file extensions', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/image.txt': '',
+      '/photos/1': '',
+    });
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers(['/photos/image.jpg']);
+  });
+
+  it('should include photo and video extensions', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/image.jpeg': '',
+      '/photos/image.heic': '',
+      '/photos/image.heif': '',
+      '/photos/image.png': '',
+      '/photos/image.gif': '',
+      '/photos/image.tif': '',
+      '/photos/image.tiff': '',
+      '/photos/image.webp': '',
+      '/photos/image.dng': '',
+      '/photos/image.nef': '',
+      '/videos/video.mp4': '',
+      '/videos/video.mov': '',
+      '/videos/video.webm': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/', '/videos/'];
+    const paths: string[] = await crawlService.crawl(options);
+
+    expect(paths).toIncludeSameMembers([
+      '/photos/image.jpg',
+      '/photos/image.jpeg',
+      '/photos/image.heic',
+      '/photos/image.heif',
+      '/photos/image.png',
+      '/photos/image.gif',
+      '/photos/image.tif',
+      '/photos/image.tiff',
+      '/photos/image.webp',
+      '/photos/image.dng',
+      '/photos/image.nef',
+      '/videos/video.mp4',
+      '/videos/video.mov',
+      '/videos/video.webm',
+    ]);
+  });
+
+  it('should check file extensions without case sensitivity', async () => {
+    mockfs({
+      '/photos/image.jpg': '',
+      '/photos/image.Jpg': '',
+      '/photos/image.jpG': '',
+      '/photos/image.JPG': '',
+      '/photos/image.jpEg': '',
+      '/photos/image.TIFF': '',
+      '/photos/image.tif': '',
+      '/photos/image.dng': '',
+      '/photos/image.NEF': '',
+    });
+
+    const options = new CrawlOptionsDto();
+    options.pathsToCrawl = ['/photos/'];
+    const paths: string[] = await crawlService.crawl(options);
+    expect(paths).toIncludeSameMembers([
+      '/photos/image.jpg',
+      '/photos/image.Jpg',
+      '/photos/image.jpG',
+      '/photos/image.JPG',
+      '/photos/image.jpEg',
+      '/photos/image.TIFF',
+      '/photos/image.tif',
+      '/photos/image.dng',
+      '/photos/image.NEF',
+    ]);
+  });
 
   afterEach(() => {
     mockfs.restore();
   });
-
-  describe('crawl', () => {
-    for (const { test, options, files } of tests) {
-      it(test, async () => {
-        mockfs(Object.fromEntries(Object.keys(files).map((file) => [file, ''])));
-
-        const actual = await sut.crawl(options);
-        const expected = Object.entries(files)
-          .filter((entry) => entry[1])
-          .map(([file]) => file);
-
-        expect(actual.sort()).toEqual(expected.sort());
-      });
-    }
-  });
 });

cli/src/services/crawl.service.ts

@@ -1,28 +1,47 @@
 import { CrawlOptionsDto } from 'src/cores/dto/crawl-options-dto';
+import { ACCEPTED_FILE_EXTENSIONS } from '../cores';
 import { glob } from 'glob';
+import * as fs from 'fs';
 
 export class CrawlService {
-  private readonly extensions!: string[];
+  public async crawl(crawlOptions: CrawlOptionsDto): Promise<string[]> {
+    const pathsToCrawl: string[] = crawlOptions.pathsToCrawl;
 
-  constructor(image: string[], video: string[]) {
-    this.extensions = image.concat(video).map((extension) => extension.replace('.', ''));
-  }
+    const directories: string[] = [];
+    const crawledFiles: string[] = [];
 
-  crawl(crawlOptions: CrawlOptionsDto): Promise<string[]> {
-    const { pathsToCrawl, exclusionPatterns, includeHidden } = crawlOptions;
-    if (!pathsToCrawl) {
-      return Promise.resolve([]);
+    for await (const currentPath of pathsToCrawl) {
+      const stats = await fs.promises.stat(currentPath);
+      if (stats.isFile() || stats.isSymbolicLink()) {
+        crawledFiles.push(currentPath);
+      } else {
+        directories.push(currentPath);
+      }
     }
 
-    const base = pathsToCrawl.length === 1 ? pathsToCrawl[0] : `{${pathsToCrawl.join(',')}}`;
-    const extensions = `*{${this.extensions}}`;
+    let searchPattern: string;
+    if (directories.length === 1) {
+      searchPattern = directories[0];
+    } else if (directories.length === 0) {
+      return crawledFiles;
+    } else {
+      searchPattern = '{' + directories.join(',') + '}';
+    }
 
-    return glob(`${base}/**/${extensions}`, {
-      absolute: true,
+    if (crawlOptions.recursive) {
+      searchPattern = searchPattern + '/**/';
+    }
+
+    searchPattern = `${searchPattern}/*.{${ACCEPTED_FILE_EXTENSIONS.join(',')}}`;
+
+    const globbedFiles = await glob(searchPattern, {
       nocase: true,
       nodir: true,
-      dot: includeHidden,
-      ignore: exclusionPatterns,
+      ignore: crawlOptions.excludePatterns,
     });
+
+    const returnedFiles = crawledFiles.concat(globbedFiles);
+    returnedFiles.sort();
+    return returnedFiles;
   }
 }

cli/src/services/index.ts

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

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

@@ -1,17 +1,8 @@
 import { SessionService } from './session.service';
+import mockfs from 'mock-fs';
 import fs from 'node:fs';
 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';
 
 const mockPingServer = jest.fn(() => Promise.resolve({ data: { res: 'pong' } }));
 const mockUserInfo = jest.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
@@ -31,85 +22,74 @@ jest.mock('../api/open-api', () => {
 
 describe('SessionService', () => {
   let sessionService: SessionService;
-  let consoleSpy: jest.SpyInstance;
-
   beforeAll(() => {
-    consoleSpy = spyOnConsole();
+    // Write a dummy output before mock-fs to prevent some annoying errors
+    console.log();
   });
 
   beforeEach(() => {
-    deleteAuthFile();
-    sessionService = new SessionService(TEST_CONFIG_DIR);
-  });
-
-  afterEach(() => {
-    deleteAuthFile();
+    const configDir = '/config';
+    sessionService = new SessionService(configDir);
   });
 
   it('should connect to immich', async () => {
-    await createTestAuthFile(
-      JSON.stringify({
-        apiKey: TEST_IMMICH_API_KEY,
-        instanceUrl: TEST_IMMICH_INSTANCE_URL,
-      }),
-    );
-
+    mockfs({
+      '/config/auth.yml': 'apiKey: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\ninstanceUrl: https://test/api',
+    });
     await sessionService.connect();
     expect(mockPingServer).toHaveBeenCalledTimes(1);
   });
 
   it('should error if no auth file exists', async () => {
+    mockfs();
     await sessionService.connect().catch((error) => {
       expect(error.message).toEqual('No auth file exist. Please login first');
     });
   });
 
   it('should error if auth file is missing instance URl', async () => {
-    await createTestAuthFile(
-      JSON.stringify({
-        apiKey: TEST_IMMICH_API_KEY,
-      }),
-    );
+    mockfs({
+      '/config/auth.yml': 'foo: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\napiKey: https://test/api',
+    });
     await sessionService.connect().catch((error) => {
       expect(error).toBeInstanceOf(LoginError);
-      expect(error.message).toEqual(`Instance URL missing in auth config file ${TEST_AUTH_FILE}`);
+      expect(error.message).toEqual('Instance URL missing in auth config file /config/auth.yml');
     });
   });
 
   it('should error if auth file is missing api key', async () => {
-    await createTestAuthFile(
-      JSON.stringify({
-        instanceUrl: TEST_IMMICH_INSTANCE_URL,
-      }),
-    );
-
-    await expect(sessionService.connect()).rejects.toThrow(
-      new LoginError(`API key missing in auth config file ${TEST_AUTH_FILE}`),
-    );
+    mockfs({
+      '/config/auth.yml': 'instanceUrl: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\nbar: https://test/api',
+    });
+    await sessionService.connect().catch((error) => {
+      expect(error).toBeInstanceOf(LoginError);
+      expect(error.message).toEqual('API key missing in auth config file /config/auth.yml');
+    });
   });
 
   it('should create auth file when logged in', async () => {
-    await sessionService.keyLogin(TEST_IMMICH_INSTANCE_URL, TEST_IMMICH_API_KEY);
+    mockfs();
 
-    const data: string = await readTestAuthFile();
+    await sessionService.keyLogin('https://test/api', 'pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg');
+
+    const data: string = await fs.promises.readFile('/config/auth.yml', 'utf8');
     const authConfig = yaml.parse(data);
-    expect(authConfig.instanceUrl).toBe(TEST_IMMICH_INSTANCE_URL);
-    expect(authConfig.apiKey).toBe(TEST_IMMICH_API_KEY);
+    expect(authConfig.instanceUrl).toBe('https://test/api');
+    expect(authConfig.apiKey).toBe('pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg');
   });
 
   it('should delete auth file when logging out', async () => {
-    await createTestAuthFile(
-      JSON.stringify({
-        apiKey: TEST_IMMICH_API_KEY,
-        instanceUrl: TEST_IMMICH_INSTANCE_URL,
-      }),
-    );
+    mockfs({
+      '/config/auth.yml': 'apiKey: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\ninstanceUrl: https://test/api',
+    });
     await sessionService.logout();
 
-    await fs.promises.access(TEST_AUTH_FILE, fs.constants.F_OK).catch((error) => {
+    await fs.promises.access('/auth.yml', fs.constants.F_OK).catch((error) => {
       expect(error.message).toContain('ENOENT');
     });
+  });
 
-    expect(consoleSpy.mock.calls).toEqual([[`Removed auth file ${TEST_AUTH_FILE}`]]);
+  afterEach(() => {
+    mockfs.restore();
   });
 });

cli/src/services/session.service.ts

@@ -5,39 +5,33 @@ import { ImmichApi } from '../api/client';
 import { LoginError } from '../cores/errors/login-error';
 
 export class SessionService {
-  readonly configDir!: string;
+  readonly configDir: string;
   readonly authPath!: string;
   private api!: ImmichApi;
 
   constructor(configDir: string) {
     this.configDir = configDir;
-    this.authPath = path.join(configDir, '/auth.yml');
+    this.authPath = path.join(this.configDir, 'auth.yml');
   }
 
   public 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) => {
-        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 parsedConfig = yaml.parse(data);
-
-      instanceUrl = parsedConfig.instanceUrl;
-      apiKey = parsedConfig.apiKey;
-
-      if (!instanceUrl) {
-        throw new LoginError(`Instance URL missing in auth config file ${this.authPath}`);
+    await fs.promises.access(this.authPath, fs.constants.F_OK).catch((error) => {
+      if (error.code === 'ENOENT') {
+        throw new LoginError('No auth file exist. Please login first');
       }
+    });
 
-      if (!apiKey) {
-        throw new LoginError(`API key missing in auth config file ${this.authPath}`);
-      }
+    const data: string = await fs.promises.readFile(this.authPath, 'utf8');
+    const parsedConfig = yaml.parse(data);
+    const instanceUrl: string = parsedConfig.instanceUrl;
+    const apiKey: string = parsedConfig.apiKey;
+
+    if (!instanceUrl) {
+      throw new LoginError('Instance URL missing in auth config file ' + this.authPath);
+    }
+
+    if (!apiKey) {
+      throw new LoginError('API key missing in auth config file ' + this.authPath);
     }
 
     this.api = new ImmichApi(instanceUrl, apiKey);
@@ -52,17 +46,14 @@ export class SessionService {
 
     // Check if server and api key are valid
     const { data: userInfo } = await this.api.userApi.getMyUserInfo().catch((error) => {
-      throw new LoginError(`Failed to connect to server ${instanceUrl}: ${error.message}`);
+      throw new LoginError(`Failed to connect to the server: ${error.message}`);
     });
 
     console.log(`Logged in as ${userInfo.email}`);
 
     if (!fs.existsSync(this.configDir)) {
       // Create config folder if it doesn't exist
-      const created = await fs.promises.mkdir(this.configDir, { recursive: true });
-      if (!created) {
-        throw new Error(`Failed to create config folder ${this.configDir}`);
-      }
+      fs.mkdirSync(this.configDir, { recursive: true });
     }
 
     fs.writeFileSync(this.authPath, yaml.stringify({ instanceUrl, apiKey }));
@@ -80,11 +71,11 @@ export class SessionService {
 
   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}`);
+      throw new Error(`Failed to connect to the server: ${error.message}`);
     });
 
     if (pingResponse.res !== 'pong') {
-      throw new Error(`Could not parse response. Is Immich listening on ${this.api.apiConfiguration.instanceUrl}?`);
+      throw new Error('Unexpected ping reply');
     }
   }
 }

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

@@ -0,0 +1,35 @@
+import { UploadService } from './upload.service';
+import mockfs from 'mock-fs';
+import axios from 'axios';
+import mockAxios from 'jest-mock-axios';
+import FormData from 'form-data';
+import { ApiConfiguration } from '../cores/api-configuration';
+
+describe('UploadService', () => {
+  let uploadService: UploadService;
+
+  beforeAll(() => {
+    // Write a dummy output before mock-fs to prevent some annoying errors
+    console.log();
+  });
+
+  beforeEach(() => {
+    const apiConfiguration = new ApiConfiguration('https://example.com/api', 'key');
+
+    uploadService = new UploadService(apiConfiguration);
+  });
+
+  it('should upload a single file', async () => {
+    const data = new FormData();
+
+    uploadService.upload(data);
+
+    mockAxios.mockResponse();
+    expect(axios).toHaveBeenCalled();
+  });
+
+  afterEach(() => {
+    mockfs.restore();
+    mockAxios.reset();
+  });
+});

cli/src/services/upload.service.ts

@@ -0,0 +1,65 @@
+import axios, { AxiosRequestConfig } from 'axios';
+import FormData from 'form-data';
+import { ApiConfiguration } from '../cores/api-configuration';
+
+export class UploadService {
+  private readonly uploadConfig: AxiosRequestConfig<any>;
+  private readonly checkAssetExistenceConfig: AxiosRequestConfig<any>;
+  private readonly importConfig: AxiosRequestConfig<any>;
+
+  constructor(apiConfiguration: ApiConfiguration) {
+    this.uploadConfig = {
+      method: 'post',
+      maxRedirects: 0,
+      url: `${apiConfiguration.instanceUrl}/asset/upload`,
+      headers: {
+        'x-api-key': apiConfiguration.apiKey,
+      },
+      maxContentLength: Number.POSITIVE_INFINITY,
+      maxBodyLength: Number.POSITIVE_INFINITY,
+    };
+
+    this.importConfig = {
+      method: 'post',
+      maxRedirects: 0,
+      url: `${apiConfiguration.instanceUrl}/asset/import`,
+      headers: {
+        'x-api-key': apiConfiguration.apiKey,
+        'Content-Type': 'application/json',
+      },
+      maxContentLength: Number.POSITIVE_INFINITY,
+      maxBodyLength: Number.POSITIVE_INFINITY,
+    };
+
+    this.checkAssetExistenceConfig = {
+      method: 'post',
+      maxRedirects: 0,
+      url: `${apiConfiguration.instanceUrl}/asset/bulk-upload-check`,
+      headers: {
+        'x-api-key': apiConfiguration.apiKey,
+        'Content-Type': 'application/json',
+      },
+    };
+  }
+
+  public checkIfAssetAlreadyExists(path: string, checksum: string): Promise<any> {
+    this.checkAssetExistenceConfig.data = JSON.stringify({ assets: [{ id: path, checksum: checksum }] });
+
+    // TODO: retry on 500 errors?
+    return axios(this.checkAssetExistenceConfig);
+  }
+
+  public upload(data: FormData): Promise<any> {
+    this.uploadConfig.data = data;
+
+    // TODO: retry on 500 errors?
+    return axios(this.uploadConfig);
+  }
+
+  public import(data: any): Promise<any> {
+    this.importConfig.data = data;
+
+    // TODO: retry on 500 errors?
+    return axios(this.importConfig);
+  }
+}

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": {
-    "^.+\\.(t|j)s$": "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 { api } from '@test/api';
-import { restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import LoginKey from 'src/commands/login/key';
-import { LoginError } from 'src/cores/errors/login-error';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
-
-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 { api } from '@test/api';
-import { restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import ServerInfo from 'src/commands/server-info';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
-
-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,43 +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_TEST_ENV = 'true';
-  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/test/e2e/immich-e2e-config.json`);
-  process.env.TZ = 'Z';
-};

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

@@ -1,49 +0,0 @@
-import { api } from '@test/api';
-import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from 'immich/test/test-utils';
-import { LoginResponseDto } from 'src/api/open-api';
-import Upload from 'src/commands/upload';
-import { APIKeyCreateResponseDto } from '@app/domain';
-import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
-
-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 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');
-  });
-});

cli/test/global-setup.js

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

cli/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "module": "Node16",
+    "module": "commonjs",
     "strict": true,
     "declaration": true,
     "removeComments": true,
@@ -8,24 +8,17 @@
     "experimentalDecorators": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
-    "target": "es2021",
+    "target": "es2017",
     "moduleResolution": "node16",
     "sourceMap": true,
     "outDir": "./dist",
     "incremental": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
-    "rootDirs": ["src", "../server/src"],
     "baseUrl": "./",
     "paths": {
-      "@test": ["../server/test"],
-      "@test/*": ["../server/test/*"],
-      "@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/*"]
+      "@test": ["test"],
+      "@test/*": ["test/*"]
     }
   },
   "exclude": ["dist", "node_modules", "upload"]

docker/.env.test

@@ -0,0 +1,16 @@
+# Database
+DB_HOSTNAME=immich-database-test
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+DB_DATABASE_NAME=e2e_test
+
+# Redis
+REDIS_HOSTNAME=immich-redis-test
+
+# Upload File Config
+UPLOAD_LOCATION=./upload
+
+# WEB
+VITE_SERVER_ENDPOINT=http://localhost:2283/api
+
+TYPESENSE_ENABLED=false

docker/README.md

@@ -1,5 +0,0 @@
-> [!CAUTION]
-> Make sure to use the docker-compose.yml of the current release:
-> https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
-> 
-> The compose file on main may not be compatible with the latest release.

docker/docker-compose.dev.yml

@@ -1,78 +1,29 @@
-# See:
-# - https://immich.app/docs/developer/setup
-# - https://immich.app/docs/developer/troubleshooting
-
 version: "3.8"
 
-name: immich-dev
-
-x-server-build: &server-common
-  image: immich-server-dev:latest
-  build:
-    context: ../
-    dockerfile: server/Dockerfile
-    target: dev
-  volumes:
-    - ../server:/usr/src/app
-    - ${UPLOAD_LOCATION}/photos:/usr/src/app/upload
-    - /usr/src/app/node_modules
-    - /etc/localtime:/etc/localtime:ro
-  env_file:
-    - .env
-  environment:
-    - NODE_ENV=development
-  ulimits:
-    nofile:
-      soft: 1048576
-      hard: 1048576
-
 services:
   immich-server:
     container_name: immich_server
-    command: [ "/usr/src/app/bin/immich-dev", "immich" ]
-    <<: *server-common
+    image: immich-server-dev:latest
+    build:
+      context: ../server
+      dockerfile: Dockerfile
+      target: builder
+    command: npm run start:debug immich
+    volumes:
+      - ../server:/usr/src/app
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+      - /usr/src/app/node_modules
     ports:
       - 3001:3001
       - 9230:9230
+    env_file:
+      - .env
+    environment:
+      - NODE_ENV=development
     depends_on:
       - redis
       - database
-
-  immich-microservices:
-    container_name: immich_microservices
-    command: [ "/usr/src/app/bin/immich-dev", "microservices" ]
-    <<: *server-common
-    # extends:
-    #   file: hwaccel.yml
-    #   service: hwaccel
-    ports:
-      - 9231:9230
-    depends_on:
-      - database
-      - immich-server
-
-  immich-web:
-    container_name: immich_web
-    image: immich-web-dev:1.9.0
-    build:
-      context: ../web
-      dockerfile: Dockerfile
-    command: "node ./node_modules/.bin/vite dev --host 0.0.0.0 --port 3000"
-    env_file:
-      - .env
-    ports:
-      - 2283:3000
-      - 24678:24678
-    volumes:
-      - ../web:/usr/src/app
-      - /usr/src/app/node_modules
-    ulimits:
-      nofile:
-        soft: 1048576
-        hard: 1048576
-    restart: unless-stopped
-    depends_on:
-      - immich-server
+      - typesense
 
   immich-machine-learning:
     container_name: immich_machine_learning
@@ -83,7 +34,7 @@ services:
     ports:
       - 3003:3003
     volumes:
-      - ../machine-learning:/usr/src/app
+      - ../machine-learning/app:/usr/src/app
       - model-cache:/cache
     env_file:
       - .env
@@ -93,13 +44,74 @@ services:
       - database
     restart: unless-stopped
 
+  immich-microservices:
+    container_name: immich_microservices
+    image: immich-microservices:latest
+    # extends:
+    #   file: hwaccel.yml
+    #   service: hwaccel
+    build:
+      context: ../server
+      dockerfile: Dockerfile
+      target: builder
+    command: npm run start:debug microservices
+    volumes:
+      - ../server:/usr/src/app
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+      - /usr/src/app/node_modules
+    env_file:
+      - .env
+    ports:
+      - 9231:9230
+    environment:
+      - NODE_ENV=development
+    depends_on:
+      - database
+      - immich-server
+      - typesense
+
+  immich-web:
+    container_name: immich_web
+    image: immich-web-dev:1.9.0
+    build:
+      context: ../web
+      dockerfile: Dockerfile
+      target: dev
+    command: npm run dev --host
+    env_file:
+      - .env
+    environment:
+      # Rename these values for svelte public interface
+      - PUBLIC_IMMICH_SERVER_URL=${IMMICH_SERVER_URL}
+      - PUBLIC_IMMICH_API_URL_EXTERNAL=${IMMICH_API_URL_EXTERNAL}
+    ports:
+      - 3000:3000
+      - 24678:24678
+    volumes:
+      - ../web:/usr/src/app
+      - /usr/src/app/node_modules
+    restart: unless-stopped
+    depends_on:
+      - immich-server
+
+  typesense:
+    container_name: immich_typesense
+    image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
+    environment:
+      - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
+      - TYPESENSE_DATA_DIR=/data
+    logging:
+      driver: none
+    volumes:
+      - tsdata:/data
+
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env
     environment:
@@ -107,9 +119,28 @@ services:
       POSTGRES_USER: ${DB_USERNAME}
       POSTGRES_DB: ${DB_DATABASE_NAME}
     volumes:
-      - ${UPLOAD_LOCATION}/postgres:/var/lib/postgresql/data
+      - pgdata:/var/lib/postgresql/data
     ports:
       - 5432:5432
 
+  immich-proxy:
+    container_name: immich_proxy
+    image: immich-proxy-dev:latest
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
+    build:
+      context: ../nginx
+      dockerfile: Dockerfile
+    ports:
+      - 2283:8080
+    depends_on:
+      - immich-server
+      - immich-web
+    restart: unless-stopped
+
 volumes:
+  pgdata:
   model-cache:
+  tsdata:

docker/docker-compose.prod.yml

@@ -1,41 +1,21 @@
 version: "3.8"
 
-name: immich-prod
-
-x-server-build: &server-common
-  image: immich-server:latest
-  build:
-    context: ../
-    dockerfile: server/Dockerfile
-  volumes:
-    - ${UPLOAD_LOCATION}/photos:/usr/src/app/upload
-    - /etc/localtime:/etc/localtime:ro
-  env_file:
-    - .env
-  restart: always
-
 services:
   immich-server:
     container_name: immich_server
-    command: [ "./start-server.sh" ]
-    <<: *server-common
-    ports:
-      - 2283:3001
+    image: immich-server:latest
+    build:
+      context: ../server
+      dockerfile: Dockerfile
+    command: ["./start-server.sh"]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+    env_file:
+      - .env
     depends_on:
       - redis
       - database
-
-  immich-microservices:
-    container_name: immich_microservices
-    command: [ "./start-microservices.sh" ]
-    <<: *server-common
-    # extends:
-    #   file: hwaccel.yml
-    #   service: hwaccel
-    depends_on:
-      - redis
-      - database
-      - immich-server
+      - typesense
 
   immich-machine-learning:
     container_name: immich_machine_learning
@@ -44,19 +24,64 @@ services:
       context: ../machine-learning
       dockerfile: Dockerfile
     volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - model-cache:/cache
     env_file:
       - .env
     restart: always
+  
+  immich-microservices:
+    container_name: immich_microservices
+    image: immich-microservices:latest
+    # extends:
+    #   file: hwaccel.yml
+    #   service: hwaccel
+    build:
+      context: ../server
+      dockerfile: Dockerfile
+    command: ["./start-microservices.sh"]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+    env_file:
+      - .env
+    depends_on:
+      - database
+      - immich-server
+      - typesense
+    restart: always
+
+  immich-web:
+    container_name: immich_web
+    image: immich-web:latest
+    build:
+      context: ../web
+      dockerfile: Dockerfile
+    env_file:
+      - .env
+    restart: always
+    depends_on:
+      - immich-server
+
+  typesense:
+    container_name: immich_typesense
+    image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
+    environment:
+      - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
+      - TYPESENSE_DATA_DIR=/data
+    logging:
+      driver: none
+    volumes:
+      - tsdata:/data
+    restart: always
 
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
     restart: always
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env
     environment:
@@ -64,8 +89,28 @@ services:
       POSTGRES_USER: ${DB_USERNAME}
       POSTGRES_DB: ${DB_DATABASE_NAME}
     volumes:
-      - ${UPLOAD_LOCATION}/postgres:/var/lib/postgresql/data
+      - pgdata:/var/lib/postgresql/data
+    restart: always
+
+  immich-proxy:
+    container_name: immich_proxy
+    image: immich-proxy:latest
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
+    build:
+      context: ../nginx
+      dockerfile: Dockerfile
+    ports:
+      - 2283:8080
+    logging:
+      driver: none
+    depends_on:
+      - immich-server
     restart: always
 
 volumes:
+  pgdata:
   model-cache:
+  tsdata:

docker/docker-compose.test.yml

@@ -0,0 +1,46 @@
+version: "3.8"
+
+services:
+  immich-server-test:
+    image: immich-server-test
+    build:
+      context: ../server
+      dockerfile: Dockerfile
+      target: builder
+    command: npm run test:e2e
+    expose:
+      - "3000"
+    volumes:
+      - ../server:/usr/src/app
+      - /usr/src/app/node_modules
+    env_file:
+      - .env.test
+    environment:
+      - NODE_ENV=development
+      - TYPESENSE_ENABLED=false
+    depends_on:
+      - immich-redis-test
+      - immich-database-test
+    networks:
+      - immich-test-network
+  immich-redis-test:
+    container_name: immich-redis-test
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
+    networks:
+      - immich-test-network
+  immich-database-test:
+    container_name: immich-database-test
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
+    env_file:
+      - .env.test
+    environment:
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_USER: ${DB_USERNAME}
+      POSTGRES_DB: ${DB_DATABASE_NAME}
+    volumes:
+      - /var/lib/postgresql/data
+    networks:
+      - immich-test-network
+
+networks:
+  immich-test-network:

docker/docker-compose.yml

@@ -1,15 +1,5 @@
 version: "3.8"
 
-#
-# WARNING: Make sure to use the docker-compose.yml of the current release:
-#
-# https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
-#
-# The compose file on main may not be compatible with the latest release.
-#
-
-name: immich
-
 services:
   immich-server:
     container_name: immich_server
@@ -17,14 +7,12 @@ services:
     command: [ "start.sh", "immich" ]
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
-      - /etc/localtime:/etc/localtime:ro
     env_file:
       - .env
-    ports:
-      - 2283:3001
     depends_on:
       - redis
       - database
+      - typesense
     restart: always
 
   immich-microservices:
@@ -36,12 +24,12 @@ services:
     command: [ "start.sh", "microservices" ]
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
-      - /etc/localtime:/etc/localtime:ro
     env_file:
       - .env
     depends_on:
       - redis
       - database
+      - typesense
     restart: always
 
   immich-machine-learning:
@@ -53,14 +41,31 @@ services:
       - .env
     restart: always
 
+  immich-web:
+    container_name: immich_web
+    image: ghcr.io/immich-app/immich-web:${IMMICH_VERSION:-release}
+    env_file:
+      - .env
+    restart: always
+
+  typesense:
+    container_name: immich_typesense
+    image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
+    environment:
+      - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
+      - TYPESENSE_DATA_DIR=/data
+    volumes:
+      - tsdata:/data
+    restart: always
+
   redis:
     container_name: immich_redis
-    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
     restart: always
 
   database:
     container_name: immich_postgres
-    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env
     environment:
@@ -71,6 +76,21 @@ services:
       - pgdata:/var/lib/postgresql/data
     restart: always
 
+  immich-proxy:
+    container_name: immich_proxy
+    image: ghcr.io/immich-app/immich-proxy:${IMMICH_VERSION:-release}
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
+    ports:
+      - 2283:8080
+    depends_on:
+      - immich-server
+      - immich-web
+    restart: always
+
 volumes:
   pgdata:
   model-cache:
+  tsdata:

docker/example.env

@@ -6,7 +6,8 @@ UPLOAD_LOCATION=./library
 # The Immich version to use. You can pin this to a specific version like "v1.71.0"
 IMMICH_VERSION=release
 
-# Connection secret for postgres. You should change it to a random password
+# Connection secrets for postgres and typesense. You should change these to random passwords
+TYPESENSE_API_KEY=some-random-text
 DB_PASSWORD=postgres
 
 # The values below this line do not need to be changed

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

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

@@ -33,6 +33,8 @@ To be concise, Immich can now read in the gallery files, register the path into
 - Only new files that are added to the gallery will be detected.
 - Deleted and moved files will not be detected.
 
+You can find more information on how to use the feature by reading the documentation [here](/docs/features/read-only-gallery).
+
 ## Memory feature
 
 This is considered a fun feature that the team and I wanted to build for so long, but we had to put it off because of the refactoring of the code base. The code base is now in a good enough form to circle back and add more exciting features.

docs/blog/2023/2023-recap.mdx

@@ -1,70 +0,0 @@
----
-title: Immich Recap 2023
-authors: [alextran]
-tags: [update, recap-2023]
----
-
-Hi everyone,
-
-Alex from Immich here.
-
-We are entering the last few weeks of 2023, and it has been quite a year for Immich. The project has grown so much in terms of users, developers, features, maturity, and the community around it. When I started working on Immich, it was simply a challenge for myself and an opportunity to learn new technologies, crafting something fun and useful for my wife during my free time to satisfy my urge to build and create things. I never thought it would become so popular and help so many people. At the end of the day, all we have is memory. I am proud that the team and I have created something to make storing and viewing those precious memories easier without restrictions and without sacrificing our privacy. As the year closes, here’s a recap of everything the project accomplished in 2023.
-
-# Milestones
-
-- Public shared links
-- Favorites page
-- Immich turned 1
-- Material Design 3 on the mobile app
-- Auto-link LivePhotos server-side
-- iOS background backup
-- Explore page
-- CLIP search
-- Search by metadata
-- Responsive web app
-- Archive page
-- Asset descriptions
-- 10,000 stars on GitHub
-- Manage auth devices
-- Map view
-- Facial recognition, clustering, searching, renaming, and person management
-- Partner sharing and unifying timeline between partners' users
-- Custom storage label
-- XMP sidecar reading
-- RAW file formats
-- Justified layout on the web
-- Memories
-- Multi-select via SHIFT
-- Android Motion Photos
-- 360° Photos
-- Album description
-- Album performance improvements (time buckets)
-- Video hardware transcoding
-- Slideshow mode on the web
-- Configuration file
-- External libraries
-- Trash page
-- Custom theme
-- Asset Stacking
-- 20,000 stars on GitHub
-- Shared album activity and comments
-- CLI v2
-- Down to 5 containers (from 8)
-
-# Fun Statistics
-
-- We have gone from the release version `1.41.0` to `1.90.0` at the time of writing. On average, we see a release every 7 days.
-- According to GitHub's metrics, the `immich-server` container image has been pulled almost _4 million_ times.
-- According to mobile app store metrics, we have 22,000 installations on Android and 6700 installation units on iOS (opt-in only).
-- Immich is making around $1200/month on average from donations. (Thank you all so much!)
-- We were guests on two podcasts:
-  - [Self-hosted](https://selfhosted.show/110)
-  - [The Vergecast](https://www.theverge.com/23938533/self-hosting-local-first-software-vergecast)
-- There are over 4,500 members on the Discord server.
-- We have over 22,000 stars on the main GitHub repository, gaining 15,000 stars since January 2023.
-
-Diving into the next year, the team will continue to build on the foundation we have laid out over the past year, implementing more advanced features for searching, organizing, and sharing between users. Bugs will continue to be squashed and conquered. “Shit Alex wrote'' code will continue to be replaced by beautiful, clean code from Jason, Zack, Boet, Daniel, Osorin, Mert, Fynn, Marty, Martin, and Jonathan. The team has my eternal gratitude for creating a welcoming environment for new contributors, helping, teaching, and learning from each other. I’ve realized that hardly a day has gone by where the team hasn’t been in communication about Immich related topics over the past year.
-
-My long-term goal is to help hone Immich into a diamond in the FOSS space, where the UI, UX, development experiences, documentation, and quality are at a high standard while remaining free for everybody to use.
-
-I hope you enjoy Immich and have a happy and peaceful holiday.

docs/docs/FAQ.md

@@ -12,41 +12,42 @@ sidebar_position: 7
 | ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up                                                                                  |
 | ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device                      |
 
-### Can I add my existing photo library?
+### How can I sync an existing directory with Immich's server?
 
-Yes, with an [external library](/docs/features/libraries.md).
+Immich doesn't have two-way synchronization ([yet](https://github.com/immich-app/immich/discussions/1006)), but the [command line tool](/docs/features/bulk-upload.md) can bulk upload items from a directory to Immich.
+
+### Why doesn't Immich watch an existing photo gallery directory?
+
+The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well.
+
+### Why does my uploaded photo show up with the wrong date or time in Immich?
+
+When a photo is initially uploaded Immich uses the create date of the file to determine where it belongs in the timeline. After that, background jobs will run that extract [exif metadata](https://en.wikipedia.org/wiki/Exif), including the CreateDate, to provide a more accurate date for the photo. If that is not available it will fallback to the modified date. If you want to ensure your photo has the right date, check the exif metadata before uploading.
+
+If the timezone is incorrect in an uploaded photo, check the `DateTimeOriginal` exif field of the uploaded file. Immich uses the very competent library [exiftool-vendored.js](https://github.com/photostructure/exiftool-vendored.js#dates) to handle timezone parsing, but in some cases (like photos taken with DSLR cameras) it has to fallback on the local timezone. If you are using docker, this fallback will be UTC. (Note that even the photo backup app that can't be named [has the same bug!](https://photo.stackexchange.com/a/126978)) In Immich, it is possible to change this assumed fallback timezone system-wide by setting the timezone in the microservices docker container. You might need to run the "Extract Metadata" job after to effect the change.
+
+As an example, the following modification of `docker-compose.yml` will set the timezone of the microservices container to be `Europe/Stockholm`
+
+```
+    environment:
+      - TZ=Europe/Stockholm # <---- Add this line in the microservices config
+```
 
 ### Why are only photos and not videos being uploaded to Immich?
 
-This often happens when using a reverse proxy or cloudflare tunnel in front of Immich. Make sure to set your reverse proxy to allow large POST requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Cloudflare tunnels are limited to 100 mb file sizes. Also check the disk space of your reverse proxy, in some cases proxies caches requests to disk before passing them on, and if disk space runs out the request fails.
+This often happens when using a reverse proxy or cloudflare tunnel in front of Immich. Make sure to set your reverse proxy to allow large POST requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Cloudflare tunnels are limited to 100 mb file sizes.
 
 ### Why is Immich slow on low-memory systems like the Raspberry Pi?
 
-Immich optionally uses machine learning for several features. However, it can be too heavy to run on a Raspberry Pi. You can [mitigate](/docs/FAQ#how-can-i-lower-immichs-cpu-usage) this or [disable](/docs/FAQ.md#how-can-i-disable-machine-learning) machine learning entirely.
+Immich uses optional machine-learning features to enhance search results. This feature, however, can be too heavy to run on a Raspberry Pi. To disable machine learning, comment out the `immich-machine-learning` section of your docker-compose.yml and set `IMMICH_MACHINE_LEARNING_URL=false` in your .env file.
 
-### How can I lower Immich's CPU usage?
+### How to disable machine-learning and TypeSense?
 
-The initial backup is the most intensive due to the number of jobs running. The most CPU-intensive ones are transcoding and machine learning jobs (Tag Images, Smart Search, Recognize Faces), and to a lesser extent thumbnail generation. Here are some ways to lower their CPU usage:
-
-- Lower the job concurrency for these jobs to 1.
-- Under Settings > Transcoding Settings > Threads, set the number of threads to a low number like 1 or 2.
-- Under Settings > Machine Learning Settings > Facial Recognition > Model Name, you can change the facial recognition model to `buffalo_s` instead of `buffalo_l`. The former is a smaller and faster model, albeit not as good.
-  - You _must_ re-run the Recognize Faces job for all images after this for facial recognition on new images to work properly.
-- If these changes are not enough, see [below](/docs/FAQ.md#how-can-i-disable-machine-learning) for how you can disable machine learning.
-
-### How can I disable machine learning?
-
-:::info
-Disabling machine learning will result in a poor experience for searching and the 'Explore' page, as these are reliant on it to work as intended.
+:::warning
+Disabling both will result in poor search experience and typesense utilizes CLIP embeddings which are generated by machine-learning.
 :::
 
-Machine learning can be disabled under Settings > Machine Learning Settings, either entirely or by model type. For instance, you can choose to disable smart search with CLIP, but keep facial recognition enabled. This means that the machine learning service will only process the enabled jobs.
-
-However, disabling all jobs will not disable the machine learning service itself. To prevent it from starting up at all in this case, you can comment out the `immich-machine-learning` section of the docker-compose.yml.
-
-### I'm getting errors about models being corrupt or failing to download. What do I do?
-
-You can delete the model cache volume, which is where models are downloaded. This will give the service a clean environment to download the model again.
+These features can be disabled by commenting out `immich-typesense` and `immich-machine-learning` sections of the docker-compose.yml and setting `IMMICH_MACHINE_LEARNING_URL=false` & `TYPESENSE_ENABLED=false` in your .env file.
 
 ### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
 
@@ -58,11 +59,7 @@ This is fixed by running the storage migration job.
 
 ### Why is object detection not very good?
 
-The default image tagging model is relatively small. You can change this for a larger model like `google/vit-base-patch16-224` by setting the model name under Settings > Machine Learning Settings > Image Tagging. You can then re-run the Image Tagging job to get improved tags.
-
-### Why are there so many thumbnail generation jobs?
-
-Immich generates three thumbnails for each asset (blurred, small, and large), as well as a thumbnail for each recognized face.
+The model we used for machine learning is a prebuilt model, so the accuracy is not very good. It will hopefully be replaced with a better solution in the future.
 
 ### How can I see Immich logs?
 
@@ -99,6 +96,10 @@ docker-compose down -v
 
 After removing the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting an unwanted files or folders.
 
+### Why iOS app shows duplicate photos on the timeline while the web doesn't?
+
+If you are using `My Photo Stream`, the Photos app temporarily creates duplicates of photos taken in the last 30 days. These photos are included in the `Recents` album and thus shown up twice. To fix this, you can disable `My Photo Stream` in the native Photos app or choose a different album in the backup screen in Immich.
+
 ### How can I move all data (photos, persons, albums) from one user to another?
 
 This requires some database queries. You can do this on the command line (in the PostgreSQL container using the psql command), or you can add for example an [Adminer](https://www.adminer.org/) container to the `docker-compose.yml` file, so that you can use a web-interface.

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

@@ -17,13 +17,13 @@ docker exec -t immich_postgres pg_dumpall -c -U postgres | gzip > "/path/to/back
 ```
 
 ```bash 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-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
 gunzip < "/path/to/backup/dump.sql.gz" | docker exec -i immich_postgres psql -U postgres -d immich    # Restore Backup
-docker compose up -d    # Start remainder of Immich apps
+docker-compose up -d    # Start remainder of Immich apps
 ```
 
 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.).
@@ -44,6 +44,7 @@ services:
       POSTGRES_USER: ${DB_USERNAME}
       POSTGRES_PASSWORD: ${DB_PASSWORD}
       SCHEDULE: "@daily"
+      BACKUP_NUM_KEEP: 7
       BACKUP_DIR: /db_dumps
     volumes:
       - ./db_dumps:/db_dumps

docs/docs/administration/reverse-proxy.md

@@ -1,10 +1,25 @@
 # Reverse Proxy
 
-Users can deploy a custom reverse proxy that forwards requests to Immich. This way, the reverse proxy can handle TLS termination, load balancing, or other advanced features. All reverse proxies between Immich and the user must forward all headers and set the `Host`, `X-Forwarded-Host`, `X-Forwarded-Proto` and `X-Forwarded-For` headers to their appropriate values. Additionally, your reverse proxy should allow for big enough uploads. By following these practices, you ensure that all custom reverse proxies are fully compatible with Immich.
+When deploying Immich it is important to understand that a reverse proxy is required in front of the server and web container. The reverse proxy acts as an intermediary between the user and container, forwarding requests to the correct container based on the URL path.
+
+## Default Reverse Proxy
+
+Immich provides a default nginx reverse proxy preconfigured to perform the correct routing and set the necessary headers for the server and web container to use. These headers are crucial to redirect to the correct URL and determine the client's IP address.
+
+## Using a Different Reverse Proxy
+
+While the reverse proxy provided by Immich works well for basic deployments, some users may want to use a different reverse proxy. Fortunately, Immich is flexible enough to accommodate different reverse proxies. Users can either:
+
+1. Add another reverse proxy on top of Immich's reverse proxy
+2. Completely replace the default reverse proxy
+
+## Adding a Custom Reverse Proxy
+
+Users can deploy a custom reverse proxy that forwards requests to Immich's reverse proxy. This way, the new reverse proxy can handle TLS termination, load balancing, or other advanced features, while still delegating routing decisions to Immich's reverse proxy. All reverse proxies between Immich and the user must forward all headers and set the `Host`, `X-Forwarded-Host`, `X-Forwarded-Proto` and `X-Forwarded-For` headers to their appropriate values. Additionally, your reverse proxy should allow for big enough uploads. By following these practices, you ensure that all custom reverse proxies are fully compatible with Immich.
 
 ### Nginx example config
 
-Below is an example config for nginx. Make sure to include `client_max_body_size 50000M;` also in a `http` block in `/etc/nginx/nginx.conf`.
+Below is an example config for nginx:
 
 ```nginx
 server {
@@ -29,12 +44,6 @@ server {
 }
 ```
 
-### Caddy example config
+## Replacing the Default Reverse Proxy
 
-As an alternative to nginx, you can also use [Caddy](https://caddyserver.com/) as a reverse proxy (with automatic HTTPS configuration). Below is an example config.
-
-```
-immich.example.org {
-    reverse_proxy http://<snip>:2283
-}
-```
+Replacing Immich's default reverse proxy is an advanced deployment and support may be limited. When replacing Immich's default proxy it is important to ensure that requests to `/api/*` are routed to the server container and all other requests to the web container. Additionally, the previously mentioned headers should be configured accordingly. You may find our [nginx configuration file](https://github.com/immich-app/immich/blob/main/nginx/templates/default.conf.template) a helpful reference.

docs/docs/administration/server-commands.md

@@ -16,52 +16,20 @@ To run a command, [connect](/docs/guides/docker-help.md#attach-to-a-container) t
 
 ## Examples
 
+Note that the commands below should begin with `immich-admin`.
+
 Reset Admin Password
 
-```
-immich-admin reset-admin-password
-Found Admin:
-- ID=e65e6f88-2a30-4dbe-8dd9-1885f4889b53
-- OAuth ID=
-- Email=admin@example.com
-- Name=Immich Admin
-? Please choose a new password (optional) immich-is-cool
-The admin password has been updated.
-```
+![Reset Admin Password](./img/reset-admin-password.png)
 
 Disable Password Login
 
-```
-immich-admin disable-password-login
-Password login has been disabled.
-```
+![Disable Password Login](./img/disable-password-login.png)
 
 Enabled Password Login
 
-```
-immich-admin enable-password-login
-Password login has been enabled.
-```
+![Enable Password Login](./img/enable-password-login.png)
 
 List Users
 
-```
-immich-admin list-users
-[
-  {
-    id: 'e65e6f88-2a30-4dbe-8dd9-1885f4889b53',
-    email: 'immich@example.com.com',
-    name: 'Immich Admin',
-    storageLabel: 'admin',
-    externalPath: null,
-    profileImagePath: 'upload/profile/e65e6f88-2a30-4dbe-8dd9-1885f4889b53/e65e6f88-2a30-4dbe-8dd9-1885f4889b53.jpg',
-    shouldChangePassword: true,
-    isAdmin: true,
-    createdAt: 2023-07-11T20:12:20.602Z,
-    deletedAt: null,
-    updatedAt: 2023-09-21T15:42:28.129Z,
-    oauthId: '',
-    memoriesEnabled: true
-  }
-]
-```
+![List Users](./img/list-users.png)

docs/docs/developer/architecture.md

@@ -2,17 +2,15 @@
 sidebar_position: 1
 ---
 
-import AppArchitecture from './img/app-architecture.png';
-
 # Architecture
 
-Immich uses a traditional client-server design, with a dedicated database for data persistence. The frontend clients communicate with backend services over HTTP using REST APIs. Below is a high level diagram of the architecture.
+Immich uses a traditional client-server design, with a dedicated database for data persistence. The frontend clients communicate with backend services over HTTP using REST APIs.
 
 ## High Level Diagram
 
-<img alt="Immich Architecture" src={AppArchitecture} className="p-4 dark:bg-immich-dark-primary my-4" />
+![Immich Architecture](./img/app-architecture.png)
 
-The diagram shows clients communicating with the server's API via REST. The server communicates with downstream systems (i.e. Redis, Postgres, Machine Learning, file system) through repository interfaces. Not shown in the diagram, is that the server is split into two separate containers `immich-server` and `immich-microservices`. The microservices container does not handle API requests or schedule cron jobs, but primarily handles incoming job requests from Redis.
+The diagram shows clients communicating with the server via REST, as well as the flow of database between backend services.
 
 ## Clients
 
@@ -36,7 +34,7 @@ The web app is a [TypeScript](https://www.typescriptlang.org/) project that uses
 
 ### CLI
 
-The Immich CLI is an [npm](https://www.npmjs.com/) package that lets users control their Immich instance from the command line. It uses the API to perform various tasks, especially uploading assets. See the [CLI documentation](/docs/features/command-line-interface.md) for more information.
+The CLI is a [TypeScript](https://www.typescriptlang.org/) project that parses command line arguments to programmatically upload/import assets to an Immich server. See [Bulk Upload](/docs/features/bulk-upload.md) for more information about its usage.
 
 ## Server
 
@@ -47,6 +45,7 @@ The Immich backend is divided into several services, which are run as individual
 1. `immich-machine-learning` - Execute machine learning models
 1. `postgres` - Persistent data storage
 1. `redis`- Queue management for `immich-microservices`
+1. `typesense`- Specialized database for search, specifically with vector comparison features
 
 ### Immich Server
 
@@ -76,6 +75,7 @@ The Immich Microservices image uses the same `Dockerfile` as the Immich Server,
 - Object Tagging
 - Facial Recognition
 - Storage Template Migration
+- Search (Typesense synchronization)
 - Sidecar (see [XMP Sidecars](/docs/features/xmp-sidecars.md))
 - Background jobs (file deletion, user deletion)
 
@@ -89,12 +89,6 @@ The machine learning service is written in [Python](https://www.python.org/) and
 
 All machine learning related operations have been externalized to this service, `immich-machine-learning`. Python is a natural choice for AI and machine learning. It also has some pretty specific hardware requirements. Running it as a separate container makes it possible to run the container on a separate machine, or easily disable it entirely.
 
-Each request to the machine learning service contains the relevant metadata for the model task, model name, and so on. These settings are stored in Postgres along with other system configs. For each request, the microservices container fetches these settings in order to attach them to the request.
-
-Internally, the machine learning service downloads, loads and configures the specified model for a given request before processing the text or image payload with it. Models that have been loaded are cached and reused across requests. A thread pool is used to process each request in a different thread so as not to block the async event loop.
-
-All models are in ONNX format. This format has wide industry support, meaning that most other model formats can be exported to it and many hardware APIs support it. It's also quite fast.
-
 Machine learning models are also quite _large_, requiring _quite a bit_ of memory. We are always looking for ways to improve and optimize this aspect of this container specifically.
 
 ### Postgres
@@ -108,3 +102,9 @@ See [Database Migrations](./database-migrations.md) for more information about h
 ### Redis
 
 Immich uses [Redis](https://redis.com/) via [BullMQ](https://docs.bullmq.io/) to manage job queues. Some jobs trigger subsequent jobs. For example, object detection relies on thumbnail generation and automatically run after one is generated.
+
+### Typesense
+
+Immich synchronizes some of the Postgres data into Typesense, so it can execute vector related queries in order to implement certain features including, facial recognition and CLIP search.
+
+<!-- - [NGINX](https://www.nginx.com/) for internal communication between containers and load balancing when scaling. -->

docs/docs/developer/database-migrations.md

@@ -9,6 +9,6 @@ npm run typeorm:migrations:generate ./src/infra/<migration-name>
 ```
 
 2. Check if the migration file makes sense.
-3. Move the migration file to folder `./server/src/infra/migrations` in your code editor.
+3. Move the migration file to folder `./src/infra/database/migrations` in your code editor.
 
 The server will automatically detect `*.ts` file changes and restart. Part of the server start-up process includes running any new migrations, so it will be applied immediately.

docs/docs/developer/directories.md

@@ -17,5 +17,6 @@ Our [GitHub Repository](https://github.com/immich-app/immich) is a [monorepo](ht
 | `machine-learning/` | Source code for the `immich-machine-learning` docker image           |
 | `misc/release/`     | Scripts for version pumps and draft releases                         |
 | `mobile/`           | Source code for the mobile app, both Android and iOS                 |
+| `nginx/`            | Source code for the `immich-proxy` docker image                      |
 | `server/`           | Source code for the `immich-server` docker image                     |
-| `web/`              | Source code for the `web`                                            |
+| `web/`              | Source code for the `immich-web` docker image                        |

docs/docs/developer/img/app-architecture.drawio.xml

@@ -1,132 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<mxfile host="app.diagrams.net" modified="2023-12-12T20:57:14.605Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36" etag="df4JlXsRZhazQ-YEVHpD" version="22.1.7" type="google">
-  <diagram name="Page-1" id="B4lqvvtjK-gtNbJBlj3M">
-    <mxGraphModel dx="1434" dy="798" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
-      <root>
-        <mxCell id="0" />
-        <mxCell id="1" parent="0" />
-        <mxCell id="skFinV3TG75uy4JOHTMt-8" value="" style="verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.polygon;polyCoords=[[0.25,0],[0.75,0],[1,0.25],[1,0.75],[0.75,1],[0.25,1],[0,0.75],[0,0.25]];polyline=0;fillColor=#d0cee2;strokeColor=#56517e;strokeWidth=16;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="187" y="28" width="480" height="480" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-57" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.167;entryDx=0;entryDy=0;strokeWidth=3;endArrow=block;endFill=1;entryPerimeter=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-11" target="skFinV3TG75uy4JOHTMt-30">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-11" value="Web App&lt;br&gt;(SvelteKit)" style="whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="24" y="88" width="120" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-58" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=3;endArrow=block;endFill=1;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-12" target="skFinV3TG75uy4JOHTMt-30">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-12" value="Mobile App&lt;br&gt;(Flutter)" style="whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="24" y="230" width="120" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-59" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.013;entryY=0.863;entryDx=0;entryDy=0;strokeWidth=3;endArrow=block;endFill=1;entryPerimeter=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-13" target="skFinV3TG75uy4JOHTMt-30">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-13" value="Immich CLI&lt;br&gt;(TypeScript)" style="whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="24" y="368" width="120" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-23" value="" style="verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.polygon;polyCoords=[[0.25,0],[0.75,0],[1,0.25],[1,0.75],[0.75,1],[0.25,1],[0,0.75],[0,0.25]];polyline=0;fillColor=#b1ddf0;strokeColor=#10739e;strokeWidth=2;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="335" y="183" width="170" height="170" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-28" value="&lt;h1&gt;Server&lt;/h1&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="377" y="28" width="100" height="70" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-116" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;endArrow=block;endFill=1;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-30" target="skFinV3TG75uy4JOHTMt-23">
-          <mxGeometry relative="1" as="geometry">
-            <Array as="points">
-              <mxPoint x="325" y="268" />
-              <mxPoint x="325" y="268" />
-            </Array>
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-30" value="API &lt;br&gt;Controllers" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#b0e3e6;strokeColor=#0e8088;arcSize=0;strokeWidth=1;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;" vertex="1" parent="1">
-          <mxGeometry x="215" y="170" width="95" height="200" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-43" value="&lt;h2&gt;&lt;span style=&quot;background-color: initial; font-size: 12px; font-weight: normal;&quot;&gt;Repositories&lt;/span&gt;&lt;/h2&gt;&lt;b&gt;&quot;Infra&quot;&lt;br&gt;&lt;/b&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#b0e3e6;strokeColor=#0e8088;arcSize=0;strokeWidth=1;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;" vertex="1" parent="1">
-          <mxGeometry x="543" y="169" width="100" height="198" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-45" value="Cron" style="rhombus;whiteSpace=wrap;html=1;fillColor=#b0e3e6;strokeColor=#0e8088;strokeWidth=1;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="270" y="388" width="80" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-46" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.625;exitY=0.15;exitDx=0;exitDy=0;strokeWidth=3;endArrow=block;endFill=1;entryX=0.106;entryY=0.847;entryDx=0;entryDy=0;entryPerimeter=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;exitPerimeter=0;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-45" target="skFinV3TG75uy4JOHTMt-23">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-52" value="Postgres" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#dae8fc;strokeColor=#6c8ebf;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="745" y="270" width="60" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-128" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0;exitDx=0;exitDy=52.5;exitPerimeter=0;strokeColor=#000000;strokeWidth=3;endArrow=block;endFill=1;fillColor=#fad9d5;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-60" target="skFinV3TG75uy4JOHTMt-131">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="620" y="350" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-60" value="Redis" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#f8cecc;strokeColor=#b85450;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="745" y="380" width="60" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-67" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;edgeStyle=orthogonalEdgeStyle;strokeWidth=1;dashed=1;endArrow=none;endFill=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;fillColor=#ffff88;strokeColor=#000000;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-74" target="skFinV3TG75uy4JOHTMt-84">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="166" y="18.99000000000001" as="sourcePoint" />
-            <mxPoint x="165" y="508" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-69" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;endArrow=block;endFill=1;startArrow=none;startFill=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-43" target="skFinV3TG75uy4JOHTMt-52">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="645" y="168" as="sourcePoint" />
-            <mxPoint x="755" y="168" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-74" value="&lt;i style=&quot;font-size: 10px;&quot;&gt;HTTP (OpenAPI)&lt;/i&gt;" style="whiteSpace=wrap;html=1;fillColor=#eeeeee;strokeColor=#36393d;fontSize=10;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="110" y="48" width="105" height="20" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-78" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;startArrow=block;startFill=1;endArrow=none;endFill=0;strokeWidth=3;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-43" target="skFinV3TG75uy4JOHTMt-23">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-84" value="&lt;i style=&quot;font-size: 10px;&quot;&gt;HTTP (OpenAPI)&lt;/i&gt;" style="whiteSpace=wrap;html=1;fillColor=#eeeeee;strokeColor=#36393d;fontSize=10;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="110" y="468" width="105" height="20" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-85" value="&lt;h2&gt;Core&lt;br&gt;Services&lt;/h2&gt;&lt;div&gt;&lt;b&gt;&quot;Domain&quot;&lt;/b&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="370" y="208" width="100" height="100" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-87" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;endArrow=block;endFill=1;startArrow=none;startFill=0;entryX=0.25;entryY=1;entryDx=0;entryDy=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;exitX=1;exitY=0.5;exitDx=0;exitDy=0;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-43" target="skFinV3TG75uy4JOHTMt-94">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="635" y="268" as="sourcePoint" />
-            <mxPoint x="735" y="398" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-94" value="Machine Learning&lt;br&gt;(Python)" style="whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="705" y="48" width="120" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-97" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;endArrow=block;endFill=1;startArrow=none;startFill=0;entryX=0;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-43" target="skFinV3TG75uy4JOHTMt-101">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="655" y="318" as="sourcePoint" />
-            <mxPoint x="785" y="298" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-101" value="File&lt;br&gt;System" style="rhombus;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="735" y="163" width="80" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-117" value="&lt;i style=&quot;font-size: 10px;&quot;&gt;HTTP&lt;/i&gt;" style="whiteSpace=wrap;html=1;fillColor=#eeeeee;strokeColor=#36393d;fontSize=10;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="682" y="163" width="48" height="20" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-129" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;endArrow=block;endFill=1;strokeWidth=3;strokeColor=#000000;fillColor=#fad9d5;entryX=0.888;entryY=0.865;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-131" target="skFinV3TG75uy4JOHTMt-23">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="565" y="278" as="sourcePoint" />
-            <mxPoint x="479" y="340" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-131" value="Jobs" style="whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#b0e3e6;strokeColor=#0e8088;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="563" y="340" width="60" height="20" as="geometry" />
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-134" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;entryX=0;entryY=0;entryDx=0;entryDy=27.5;entryPerimeter=0;endArrow=block;endFill=1;startArrow=none;startFill=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;fillColor=#fad9d5;strokeColor=#000000;" edge="1" parent="1" source="skFinV3TG75uy4JOHTMt-43" target="skFinV3TG75uy4JOHTMt-60">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="634" y="318" as="sourcePoint" />
-            <mxPoint x="755" y="289" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="skFinV3TG75uy4JOHTMt-140" value="&lt;i style=&quot;font-size: 10px;&quot;&gt;Queue&lt;/i&gt;" style="whiteSpace=wrap;html=1;fillColor=#eeeeee;strokeColor=#36393d;fontSize=10;fontFamily=Overpass;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DOverpass;rounded=0;" vertex="1" parent="1">
-          <mxGeometry x="679" y="394" width="48" height="20" as="geometry" />
-        </mxCell>
-      </root>
-    </mxGraphModel>
-  </diagram>
-</mxfile>

docs/docs/developer/open-api.md

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

docs/docs/developer/setup.md

@@ -52,7 +52,7 @@ If you only want to do web development connected to an existing, remote backend,
 3. Start the web development server
 
 ```
-IMMICH_SERVER_URL=https://demo.immich.app/api npm run dev
+PUBLIC_IMMICH_SERVER_URL=https://demo.immich.app/api npm run dev
 ```
 
 ## IDE setup
@@ -61,15 +61,9 @@ IMMICH_SERVER_URL=https://demo.immich.app/api npm run dev
 
 Setting these in the IDE give a better developer experience, auto-formatting code on save, and providing instant feedback on lint issues.
 
-### Dart Code Metris
-
-The mobile app uses DCM (Dart Code Metrics) for linting and metrics calculation. Please refer to the [Getting Started](https://dcm.dev/docs/getting-started/#installation) page for more information on setting up DCM
-
-Note: Activating the license is not required.
-
 ### VSCode
 
-Install `Flutter`, `DCM`, `Prettier`, `ESLint` and `Svelte` extensions.
+Install `Flutter`, `Prettier`, `ESLint` and `Svelte` extensions.
 
 in User `settings.json` (`cmd + shift + p` and search for `Open User Settings JSON`) add the following:
 

docs/docs/developer/testing.md

@@ -1,17 +0,0 @@
-# Testing
-
-## Server
-
-### Unit tests
-
-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.
-
-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.
-
-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.
-
-If you manually install the dependencies (see the DOCKERFILE) on your development machine, you can also run the full e2e tests manually by setting the `IMMICH_RUN_ALL_TESTS` environment value to true, i.e. `IMMICH_RUN_ALL_TESTS=true npm run test:e2e`.

docs/docs/developer/troubleshooting.md

@@ -1,15 +0,0 @@
-# Troubleshooting
-
-:::tip
-A great option to get assistance with troubleshooting is to join our [Discord](https://discord.gg/D8JsnBEuKb) server, where we have a dedicated channel for `#contributing`.
-:::
-
-## Known Issues
-
-### Running on Windows
-
-Running Immich on Windows can be frustrating and there are lots of ways it can go wrong. Where possible we recommend using Docker on Linux. However, several people have had success running Immich on Windows using Docker via WSL2.
-
-### NTFS Mounted Volumes
-
-The docker-compose.dev.yml and docker-compose.prod.yml use volume mounts for the postgres database. On start-up, postgres will try to `chown` the data directory, but fail. See [this post](https://forums.docker.com/t/data-directory-var-lib-postgresql-data-pgdata-has-wrong-ownership/17963/24) for more information about this issue and possible solutions.

docs/docs/features/bulk-upload.md

@@ -0,0 +1,179 @@
+# Bulk Upload (Using the CLI)
+
+You can use the CLI to upload an existing gallery to the Immich server
+
+[Immich CLI Repository](https://github.com/immich-app/CLI)
+
+## Requirements
+
+- Node.js 16 or above
+- Npm
+
+## Installation
+
+```bash
+npm i -g immich
+```
+
+Pre-installed on the `immich-server` container and can be easily accessed through
+
+```
+immich
+```
+
+### Options
+
+| Parameter        | Description                                                         |
+| ---------------- | ------------------------------------------------------------------- |
+| --yes / -y       | Assume yes on all interactive prompts                               |
+| --recursive / -r | Include subfolders                                                  |
+| --delete / -da   | Delete local assets after upload                                    |
+| --key / -k       | User's API key                                                      |
+| --server / -s    | Immich's server address                                             |
+| --threads / -t   | Number of threads to use (Default 5)                                |
+| --album/ -al     | Create albums for assets based on the parent folder or a given name |
+| --import/ -i     | Import gallery (assets are not uploaded)                            |
+
+## Quick Start
+
+Specify user's credential, Immich's server address and port and the directory you would like to upload videos/photos from.
+
+```
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api file1.jpg file2.jpg
+```
+
+By default, subfolders are not included. To upload a directory including subfolder, use the --recursive option:
+
+```
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive directory/
+```
+
+### Obtain the API Key
+
+The API key can be obtained in the user setting panel on the web interface.
+
+![Obtain Api Key](./img/obtain-api-key.png)
+
+---
+
+## Uploading existing libraries
+
+### Run via Docker
+
+You can run the CLI inside of a docker container to avoid needing to install anything.
+
+:::caution Running inside Docker
+Be aware that as this runs inside a container, you need to mount the folder from which you want to import into the container.
+:::
+
+```bash title="Upload current directory"
+cd /DIRECTORY/WITH/IMAGES
+docker run -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+```bash title="Upload target directory"
+docker run -it --rm -v "/DIRECTORY/WITH/IMAGES:/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+```bash title="Create an alias"
+alias immich='docker run -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest'
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+:::tip Internal networking
+If you are running the CLI container on the same machine as your Immich server, you may not be able to reach the external address. In that case, try the following steps:
+
+1. Find the internal Docker network used by Immich via `docker network ls`.
+2. Adapt the above command to pass the `--network <immich_network>` argument to `docker run`, substituting `<immich_network>` with the result from step 1.
+3. Use `--server http://immich-server:3001` for the upload command instead of the external address.
+
+```bash title="Upload to internal address"
+docker run --network immich_default -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://immich-server:3001
+```
+
+:::
+
+### Run from source
+
+```bash title="Clone Repository"
+git clone https://github.com/immich-app/CLI
+```
+
+```bash title="Install dependencies"
+npm install
+```
+
+```bash title="Build the project"
+npm run build
+```
+
+```bash title="Run the command"
+node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive your/asset/directory
+```
+
+---
+
+## Importing existing libraries
+
+If you do not wish to upload files into the server, existing files can be imported into the immich gallery through the use of the `--import` flag.
+
+```
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive directory/ --import
+```
+
+```
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api file1.jpg file2.jpg --import
+```
+
+The `immich-server` and `immich-microservices` containers must be able to access the files, or directories at the path referenced in the command. The directories referenced must be set under a user's `External Path` setting. More detailed instructions can be found [here](/docs/features/read-only-gallery).
+
+:::tip Matching volume references
+The import command is most easily run on the machine running the immich service, as the path to the files on the machine running the command and the server much match identically.
+
+If you are running immich within docker, the volume pointing to your existing library should be identical with your host machine.
+
+```diff title="docker-compose.yml"
+  immich-server:
+    container_name: immich_server
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "immich" ]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
++     - /path/to/media:/path/to/media
+    env_file:
+      - .env
+    depends_on:
+      - redis
+      - database
+      - typesense
+    restart: always
+
+  immich-microservices:
+    container_name: immich_microservices
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "microservices" ]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
++     - /path/to/media:/path/to/media
+    env_file:
+      - .env
+    depends_on:
+      - redis
+      - database
+      - typesense
+    restart: always
+```
+
+The proper command for above would be as shown below. You should have access to `/path/to/media` exactly on the environment the CLI command is being run on
+
+```
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive /path/to/media --import
+```
+
+If you are running the import using the docker command, please note that the volumes should point to the `/path/to/media` exactly on the environment the CLI command is being run on
+
+```
+docker run -it --rm -v "/path/to/media:/path/to/media" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive /path/to/media --import
+```
+
+:::

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

@@ -1,140 +0,0 @@
-# The Immich CLI
-
-Immich has a CLI that allows you to perform certain actions from the command line. This CLI replaces the [legacy CLI](https://github.com/immich-app/CLI) that was previously available. The CLI is hosted in the [cli folder of the the main Immich github repository](https://github.com/immich-app/immich/tree/main/cli).
-
-## Features
-
-- Upload photos and videos to Immich
-- Check server version
-
-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)
-:::
-
-## Requirements
-
-- Node.js 20.0 or above
-- Npm
-
-## Installation
-
-```bash
-npm i -g @immich/cli
-```
-
-NOTE: if you previously installed the legacy CLI, you will need to uninstall it first:
-
-```bash
-npm uninstall -g immich
-```
-
-## Usage
-
-```
-immich
-```
-
-```
-Usage: immich [options] [command]
-
-Immich command line interface
-
-Options:
-  -V, --version                     output the version number
-  -h, --help                        display help for command
-
-Commands:
-  upload [options] [paths...]       Upload assets
-  server-info                       Display server information
-  login-key [instanceUrl] [apiKey]  Login using an API key
-  logout                            Remove stored credentials
-  help [command]                    display help for command
-```
-
-## Commands
-
-The upload command supports the following options:
-
-```
-Usage: immich upload [options] [paths...]
-
-Upload assets
-
-Arguments:
-  paths                    One or more paths to assets to be uploaded
-
-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)
-  -a, --album              Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM)
-  -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
-```
-
-Note that the above options can read from environment variables as well.
-
-## Quick Start
-
-You begin by authenticating to your Immich server.
-
-```bash
-immich login-key [instanceUrl] [apiKey]
-```
-
-For instance,
-
-```bash
-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.
-
-Once you are authenticated, you can upload assets to your Immich server.
-
-```bash
-immich upload file1.jpg file2.jpg
-```
-
-By default, subfolders are not included. To upload a directory including subfolder, use the --recursive option:
-
-```bash
-immich upload --recursive directory/
-```
-
-If you are unsure what will happen, you can use the `--dry-run` option to see what would happen without actually performing any actions.
-
-```bash
-immich upload --dry-run --recursive directory/
-```
-
-By default, the upload command will hash the files before uploading them. This is to avoid uploading the same file multiple times. If you are sure that the files are unique, you can skip this step by passing the `--skip-hash` option. Note that Immich always performs its own deduplication through hashing, so this is merely a performance consideration. If you have good bandwidth it might be faster to skip hashing.
-
-```bash
-immich upload --skip-hash --recursive directory/
-```
-
-You can automatically create albums based on the folder name by passing the `--album` option. This will automatically create albums for each uploaded asset based on the name of the folder they are in.
-
-```bash
-immich upload --album --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
-immich upload --ignore **/Raw/** --recursive directory/
-```
-
-```bash
-immich upload --ignore **/Raw/** **/*.tif --recursive directory/
-```
-
-### Obtain the API Key
-
-The API key can be obtained in the user setting panel on the web interface.
-
-![Obtain Api Key](./img/obtain-api-key.png)

docs/docs/features/facial-recognition.md

@@ -1,7 +1,5 @@
 # Facial Recognition
 
-## Overview
-
 Immich recognizes faces in your photos and videos and groups them together. You can then assign names to the faces and search for them.
 
 The list of people is shown in the Explore page.
@@ -15,16 +13,3 @@ Upon clicking on a person, a list of assets that contain their face will be show
 The asset detail view will also show the faces that are recognized in the asset.
 
 <img src={require('./img/facial-recognition-3.png').default} title='Facial Recognition 3' />
-
-## Actions
-
-Additional actions you can do with a detected person are:
-
-- Change the feature face photo of the person
-- Set date of birth
-- Merge two or more detected faces into one person
-- Hide face
-
-It can be found from the app bar when you access the detial view of a person
-
-<img src={require('./img/facial-recognition-4.png').default} title='Facial Recognition 4' width="70%"/>