Version v1.107.0

SHIFT + K: Select keep all
SHIFT + T: Select trash all
SHIFT + C: Confirm selection

.dockerignore

@@ -1,28 +1,31 @@
 .vscode/
+.github/
+.git/
 
 design/
 docker/
+!docker/scripts
 docs/
+e2e/
 fastlane/
 machine-learning/
 misc/
 mobile/
 
-server/node_modules/
+cli/coverage/
+cli/dist/
+cli/node_modules/
+
+open-api/typescript-sdk/build/
+open-api/typescript-sdk/node_modules/
+
 server/coverage/
-server/.reverse-geocoding-dump/
+server/node_modules/
 server/upload/
 server/dist/
+server/www/
 
 web/node_modules/
 web/coverage/
 web/.svelte-kit
 web/build/
-
-cli/node_modules/
-cli/.reverse-geocoding-dump/
-cli/upload/
-cli/dist/
-
-open-api/typescript-sdk/node_modules/
-open-api/typescript-sdk/build/

.editorconfig

@@ -16,4 +16,4 @@ max_line_length = off
 trim_trailing_whitespace = false
 
 [*.{yml,yaml}]
-quote_type = double
+quote_type = single

.gitattributes

@@ -2,15 +2,11 @@ mobile/openapi/**/*.md -diff -merge
 mobile/openapi/**/*.md linguist-generated=true
 mobile/openapi/**/*.dart -diff -merge
 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
 
-open-api/typescript-sdk/client/**/*.md -diff -merge
-open-api/typescript-sdk/client/**/*.md linguist-generated=true
-open-api/typescript-sdk/client/**/*.ts -diff -merge
-open-api/typescript-sdk/client/**/*.ts linguist-generated=true
+open-api/typescript-sdk/fetch-client.ts -diff -merge
+open-api/typescript-sdk/fetch-client.ts linguist-generated=true
 
 *.sh text eol=lf

.github/DISCUSSION_TEMPLATE/feature-request.yaml

@@ -6,6 +6,14 @@ body:
     attributes:
       value: |
         Please use this form to request new feature for Immich
+
+  - type: checkboxes
+    attributes:
+      label: I have searched the existing feature requests to make sure this is not a duplicate request.
+      options:
+        - label: "Yes"
+          required: true
+
   - type: textarea
     id: feature
     attributes:

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -87,6 +87,16 @@ body:
     validations:
       required: true
 
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant logs below. (code formatting is
+        enabled, no need for backticks)
+      render: shell
+    validations:
+      required: false
+      
   - type: textarea
     attributes:
       label: Additional information

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: I have a question or need support
-    url: https://discord.gg/D8JsnBEuKb
+    url: https://discord.immich.app
     about: We use GitHub for tracking bugs, please check out our Discord channel for freaky fast support.
   - name: Feature Request
     url: https://github.com/immich-app/immich/discussions/new?category=feature-request
     about: Please use our GitHub Discussion for making feature requests.
   - name: I'm unsure where to go
-    url: https://discord.gg/D8JsnBEuKb
+    url: https://discord.immich.app
     about: If you are unsure where to go, then joining our Discord is recommended; Just ask!

.github/labeler.yml

@@ -0,0 +1,35 @@
+cli:
+  - changed-files:
+      - any-glob-to-any-file:
+          - cli/src/**
+
+documentation:
+  - changed-files:
+      - any-glob-to-any-file:
+          - docs/blob/**
+          - docs/docs/**
+          - docs/src/**
+          - docs/static/**
+
+🖥️web:
+  - changed-files:
+      - any-glob-to-any-file:
+          - web/src/**
+          - web/static/**
+
+📱mobile:
+  - changed-files:
+      - any-glob-to-any-file:
+          - mobile/lib/**
+          - mobile/test/**
+
+🗄️server:
+  - changed-files:
+      - any-glob-to-any-file:
+          - server/src/**
+          - server/test/**
+
+🧠machine-learning:
+  - changed-files:
+      - any-glob-to-any-file:
+          - machine-learning/app/**

.github/release.yml

@@ -28,14 +28,13 @@ changelog:
       labels:
         - documentation
 
-    - title: 🔨 Build
+    - title: 🔨 Maintenance
       labels:
         - deployment
-
-    - title: 🤖 Dependencies
-      labels:
         - dependencies
         - renovate
+        - maintenance
+        - tech-debt
 
     - title: Other changes
       labels:

.github/workflows/build-mobile.yml

@@ -37,15 +37,15 @@ jobs:
 
       - uses: actions/setup-java@v4
         with:
-          distribution: "zulu"
-          java-version: "11.0.21+9"
-          cache: "gradle"
+          distribution: 'zulu'
+          java-version: '17'
+          cache: 'gradle'
 
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
-          channel: "stable"
-          flutter-version: "3.16.9"
+          channel: 'stable'
+          flutter-version-file: ./mobile/pubspec.yaml
           cache: true
 
       - name: Create the Keystore

.github/workflows/cli-release.yml

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

.github/workflows/cli.yml

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

.github/workflows/dispatch_sdk_update.yml

@@ -1,26 +0,0 @@
-name: Update Immich SDK
-
-on:
-  workflow_dispatch:
-  push:
-    branches: ["main"]
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  update-sdk-repos:
-    runs-on: ubuntu-latest
-    if: ${{ !github.event.pull_request.head.repo.fork }}
-    steps:
-      - uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GH_TOKEN }}
-          script: |
-            await github.rest.actions.createWorkflowDispatch({
-              owner: 'immich-app',
-              repo: 'immich-sdk-typescript-axios',
-              workflow_id: 'build.yml',
-              ref: 'main'
-            })

.github/workflows/docker-cleanup.yml

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

.github/workflows/docker.yml

@@ -44,7 +44,7 @@ jobs:
             platforms: linux/amd64
             device: openvino
             suffix: -openvino
-          
+
           - image: immich-machine-learning
             context: machine-learning
             file: machine-learning/Dockerfile
@@ -57,6 +57,7 @@ jobs:
             file: server/Dockerfile
             platforms: linux/amd64,linux/arm64
             device: cpu
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -65,13 +66,7 @@ jobs:
         uses: docker/setup-qemu-action@v3.0.0
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
-        # 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
+        uses: docker/setup-buildx-action@v3.3.0
 
       - name: Login to Docker Hub
         # Only push to Docker Hub when making a release
@@ -120,7 +115,7 @@ jobs:
           fi
 
       - name: Build and push image
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.2.0
         with:
           context: ${{ matrix.context }}
           file: ${{ matrix.file }}
@@ -129,7 +124,11 @@ jobs:
           push: ${{ !github.event.pull_request.head.repo.fork }}
           cache-from: type=registry,ref=ghcr.io/${{ github.repository_owner }}/immich-build-cache:${{matrix.image}}
           cache-to: ${{ steps.cache-target.outputs.cache-to }}
-          build-args: |
-            DEVICE=${{ matrix.device }}
           tags: ${{ steps.metadata.outputs.tags }}
           labels: ${{ steps.metadata.outputs.labels }}
+          build-args: |
+            DEVICE=${{ matrix.device }}
+            BUILD_ID=${{ github.run_id }}
+            BUILD_IMAGE=${{ github.event_name == 'release' && github.ref_name || steps.metadata.outputs.tags }}
+            BUILD_SOURCE_REF=${{ github.ref_name }}
+            BUILD_SOURCE_COMMIT=${{ github.sha }}

.github/workflows/docs-build.yml

@@ -0,0 +1,48 @@
+name: Docs build
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "docs/**"
+  release:
+    types: [published]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './docs/.nvmrc'
+
+      - name: Run npm install
+        run: npm ci
+
+      - name: Check formatting
+        run: npm run format
+
+      - name: Run build
+        run: npm run build
+
+      - name: Upload build output
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-build-output
+          path: docs/build/
+          retention-days: 1

.github/workflows/docs-deploy.yml

@@ -0,0 +1,189 @@
+name: Docs deploy
+on:
+  workflow_run:
+    workflows: ["Docs build"]
+    types:
+      - completed
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    outputs:
+      parameters: ${{ steps.parameters.outputs.result }}
+    steps:
+      - if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+        run: echo 'The triggering workflow failed' && exit 1
+
+      - name: Determine deploy parameters
+        id: parameters
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const eventType = context.payload.workflow_run.event;
+            const isFork = context.payload.workflow_run.repository.fork;
+
+            let parameters;
+
+            console.log({eventType, isFork});
+
+            if (eventType == "push") {
+              const branch = context.payload.workflow_run.head_branch;
+              console.log({branch});
+              const shouldDeploy = !isFork && branch == "main";
+              parameters = {
+                event: "branch",
+                name: "main",
+                shouldDeploy
+              };
+            } else if (eventType == "pull_request") {
+              let pull_number = context.payload.workflow_run.pull_requests[0]?.number;
+              if(!pull_number) {
+                const response = await github.rest.search.issuesAndPullRequests({q: 'repo:${{ github.repository }} is:pr sha:${{ github.event.workflow_run.head_sha }}',per_page: 1,})
+                const items = response.data.items
+                if (items.length < 1) {
+                  throw new Error("No pull request found for the commit")
+                }
+                const pullRequestNumber = items[0].number
+                console.info("Pull request number is", pullRequestNumber)
+                pull_number = pullRequestNumber
+              }
+              const {data: pr} = await github.rest.pulls.get({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number
+              });
+
+              console.log({pull_number});
+
+              parameters = {
+                event: "pr",
+                name: `pr-${pull_number}`,
+                pr_number: pull_number,
+                shouldDeploy: true
+              };
+            } else if (eventType == "release") {
+              parameters = {
+                event: "release",
+                name: context.payload.workflow_run.head_branch,
+                shouldDeploy: !isFork
+              };
+            }
+
+            console.log(parameters);
+            return parameters;
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: checks
+    if: ${{ fromJson(needs.checks.outputs.parameters).shouldDeploy }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Load parameters
+        id: parameters
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const json = `${{ needs.checks.outputs.parameters }}`;
+            const parameters = JSON.parse(json);
+            core.setOutput("event", parameters.event);
+            core.setOutput("name", parameters.name);
+            core.setOutput("shouldDeploy", parameters.shouldDeploy);
+
+      - run: |
+          echo "Starting docs deployment for ${{ steps.parameters.outputs.event }} ${{ steps.parameters.outputs.name }}"
+
+      - name: Download artifact
+        uses: actions/github-script@v7
+        with:
+          script: |
+            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: context.payload.workflow_run.id,
+            });
+            let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "docs-build-output"
+            })[0];
+            let download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            let fs = require('fs');
+            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/docs-build-output.zip`, Buffer.from(download.data));
+
+      - name: Unzip artifact
+        run: unzip "${{ github.workspace }}/docs-build-output.zip" -d "${{ github.workspace }}/docs/build"
+
+      - name: Deploy Docs Subdomain
+        env:
+          TF_VAR_prefix_name: ${{ steps.parameters.outputs.name}}
+          TF_VAR_prefix_event_type: ${{ steps.parameters.outputs.event }}
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          TF_STATE_POSTGRES_CONN_STR: ${{ secrets.TF_STATE_POSTGRES_CONN_STR }}
+        uses: gruntwork-io/terragrunt-action@v2
+        with:
+          tg_version: "0.58.12"
+          tofu_version: "1.7.1"
+          tg_dir: "deployment/modules/cloudflare/docs"
+          tg_command: "apply"
+
+      - name: Deploy Docs Subdomain Output
+        id: docs-output
+        env:
+          TF_VAR_prefix_name: ${{ steps.parameters.outputs.name}}
+          TF_VAR_prefix_event_type: ${{ steps.parameters.outputs.event }}
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          TF_STATE_POSTGRES_CONN_STR: ${{ secrets.TF_STATE_POSTGRES_CONN_STR }}
+        uses: gruntwork-io/terragrunt-action@v2
+        with:
+          tg_version: "0.58.12"
+          tofu_version: "1.7.1"
+          tg_dir: "deployment/modules/cloudflare/docs"
+          tg_command: "output -json"
+
+      - name: Output Cleaning
+        id: clean
+        run: |
+          TG_OUT=$(echo '${{ steps.docs-output.outputs.tg_action_output }}' | sed 's|%0A|\n|g ; s|%3C|<|g' | jq -c .)
+          echo "output=$TG_OUT" >> $GITHUB_OUTPUT
+
+      - name: Publish to Cloudflare Pages
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN_PAGES_UPLOAD }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ fromJson(steps.clean.outputs.output).pages_project_name.value }}
+          workingDirectory: "docs"
+          directory: "build"
+          branch: ${{ steps.parameters.outputs.name }}
+          wranglerVersion: '3'
+
+      - name: Deploy Docs Release Domain
+        if: ${{ steps.parameters.outputs.event == 'release' }}
+        env:
+          TF_VAR_prefix_name: ${{ steps.parameters.outputs.name}}
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          TF_STATE_POSTGRES_CONN_STR: ${{ secrets.TF_STATE_POSTGRES_CONN_STR }}
+        uses: gruntwork-io/terragrunt-action@v2
+        with:
+          tg_version: '0.58.12'
+          tofu_version: '1.7.1'
+          tg_dir: 'deployment/modules/cloudflare/docs-release'
+          tg_command: 'apply'
+
+      - name: Comment
+        uses: actions-cool/maintain-one-comment@v3
+        if: ${{ steps.parameters.outputs.event == 'pr' }}
+        with:
+          number: ${{ fromJson(needs.checks.outputs.parameters).pr_number }}
+          body: |
+            📖 Documentation deployed to [${{ fromJson(steps.clean.outputs.output).immich_app_branch_subdomain.value }}](https://${{ fromJson(steps.clean.outputs.output).immich_app_branch_subdomain.value }})
+          emojis: 'rocket'
+          body-include: '<!-- Docs PR URL -->'

.github/workflows/docs-destroy.yml

@@ -0,0 +1,32 @@
+name: Docs destroy
+on:
+  pull_request_target:
+    types: [closed]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Destroy Docs Subdomain
+        env:
+          TF_VAR_prefix_name: "pr-${{ github.event.number }}"
+          TF_VAR_prefix_event_type: "pr"
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          TF_STATE_POSTGRES_CONN_STR: ${{ secrets.TF_STATE_POSTGRES_CONN_STR }}
+        uses: gruntwork-io/terragrunt-action@v2
+        with:
+          tg_version: "0.58.12"
+          tofu_version: "1.7.1"
+          tg_dir: "deployment/modules/cloudflare/docs"
+          tg_command: "destroy"
+
+      - name: Comment
+        uses: actions-cool/maintain-one-comment@v3
+        with:
+          number: ${{ github.event.number }}
+          delete: true
+          body-include: '<!-- Docs PR URL -->'

.github/workflows/pr-labeler.yml

@@ -0,0 +1,12 @@
+name: "Pull Request Labeler"
+on:
+- pull_request_target
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v5

.github/workflows/pr-require-conventional-commit.yml

@@ -0,0 +1,15 @@
+name: PR Conventional Commit Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Conventional Commit Validation
+        uses:  ytanikin/PRConventionalCommits@1.2.0
+        with:
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'
+          add_label: 'false'

.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

@@ -4,16 +4,16 @@ on:
   workflow_dispatch:
     inputs:
       serverBump:
-        description: "Bump server version"
+        description: 'Bump server version'
         required: true
-        default: "false"
+        default: 'false'
         type: choice
         options:
-          - "false"
+          - 'false'
           - minor
           - patch
       mobileBump:
-        description: "Bump mobile build number"
+        description: 'Bump mobile build number'
         required: false
         type: boolean
 
@@ -46,8 +46,8 @@ jobs:
         with:
           author_name: Alex The Bot
           author_email: alex.tran1502@gmail.com
-          default_author: user_info 
-          message: "Version ${{ env.IMMICH_VERSION }}"
+          default_author: user_info
+          message: 'Version ${{ env.IMMICH_VERSION }}'
           tag: ${{ env.IMMICH_VERSION }}
           push: true
 
@@ -74,7 +74,7 @@ jobs:
           name: release-apk-signed
 
       - name: Create draft release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           draft: true
           tag_name: ${{ env.IMMICH_VERSION }}
@@ -85,4 +85,5 @@ jobs:
             docker/example.env
             docker/hwaccel.ml.yml
             docker/hwaccel.transcoding.yml
+            docker/prometheus.yml
             *.apk

.github/workflows/sdk.yml

@@ -0,0 +1,31 @@
+name: Update Immich SDK
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  packages: write
+
+jobs:
+  publish:
+    name: Publish `@immich/sdk`
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./open-api/typescript-sdk
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: './open-api/typescript-sdk/.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install deps
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/static_analysis.yml

@@ -22,8 +22,8 @@ jobs:
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
-          channel: "stable"
-          flutter-version: "3.16.9"
+          channel: 'stable'
+          flutter-version-file: ./mobile/pubspec.yaml
 
       - name: Install dependencies
         run: dart pub get
@@ -32,7 +32,11 @@ jobs:
       - name: Run dart analyze
         run: dart analyze --fatal-infos
         working-directory: ./mobile
-      
+
+      - name: Run dart format
+        run: dart format lib/ --set-exit-if-changed
+        working-directory: ./mobile
+
       # Enable after riverpod generator migration is completed
       # - name: Run dart custom lint
       #   run: dart run custom_lint

.github/workflows/test.yml

@@ -10,58 +10,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  server-e2e-api:
-    name: Server (e2e-api)
-    runs-on: mich
-    defaults:
-      run:
-        working-directory: ./server
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Run npm install
-        run: npm ci
-
-      - name: Run e2e tests
-        run: npm run e2e:api
-
-  server-e2e-jobs:
-    name: Server (e2e-jobs)
-    runs-on: mich
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: "recursive"
-
-      - name: Run e2e tests
-        run: make server-e2e-jobs
-
-  doc-tests:
-    name: Docs
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./docs
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Run npm install
-        run: npm ci
-
-      - name: Run formatter
-        run: npm run format
-        if: ${{ !cancelled() }}
-
-      - name: Run build
-        run: npm run build
-        if: ${{ !cancelled() }}
-
   server-unit-tests:
     name: Server
     runs-on: ubuntu-latest
@@ -73,6 +21,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './server/.nvmrc'
+
       - name: Run npm install
         run: npm ci
 
@@ -103,17 +56,18 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Run setup typescript-sdk
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './cli/.nvmrc'
+
+      - name: Setup typescript-sdk
         run: npm ci && npm run build
         working-directory: ./open-api/typescript-sdk
 
-      - name: Run npm install (cli)
+      - name: Install deps
         run: npm ci
 
-      - name: Run npm install (server)
-        run: npm ci
-        working-directory: ./server
-
       - name: Run linter
         run: npm run lint
         if: ${{ !cancelled() }}
@@ -130,9 +84,9 @@ jobs:
         run: npm run test:cov
         if: ${{ !cancelled() }}
 
-  cli-e2e-tests:
-    name: CLI (e2e)
-    runs-on: ubuntu-latest
+  cli-unit-tests-win:
+    name: CLI (Windows)
+    runs-on: windows-latest
     defaults:
       run:
         working-directory: ./cli
@@ -140,22 +94,27 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-        with:
-          submodules: "recursive"
 
-      - name: Run setup typescript-sdk
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './cli/.nvmrc'
+
+      - name: Setup typescript-sdk
         run: npm ci && npm run build
         working-directory: ./open-api/typescript-sdk
 
-      - name: Run npm install (cli)
+      - name: Install deps
         run: npm ci
 
-      - name: Run npm install (server)
-        run: npm ci && npm run build
-        working-directory: ./server
+      # Skip linter & formatter in Windows test.
+      - name: Run tsc
+        run: npm run check
+        if: ${{ !cancelled() }}
 
-      - name: Run e2e tests
-        run: npm run test:e2e
+      - name: Run unit tests & coverage
+        run: npm run test:cov
+        if: ${{ !cancelled() }}
 
   web-unit-tests:
     name: Web
@@ -168,6 +127,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './web/.nvmrc'
+
       - name: Run setup typescript-sdk
         run: npm ci && npm run build
         working-directory: ./open-api/typescript-sdk
@@ -195,6 +159,66 @@ jobs:
         run: npm run test:cov
         if: ${{ !cancelled() }}
 
+  e2e-tests:
+    name: End-to-End Tests
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./e2e
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './e2e/.nvmrc'
+
+      - name: Run setup typescript-sdk
+        run: npm ci && npm run build
+        working-directory: ./open-api/typescript-sdk
+        if: ${{ !cancelled() }}
+
+      - name: Run setup cli
+        run: npm ci && npm run build
+        working-directory: ./cli
+        if: ${{ !cancelled() }}
+
+      - name: Install dependencies
+        run: npm ci
+        if: ${{ !cancelled() }}
+
+      - name: Run linter
+        run: npm run lint
+        if: ${{ !cancelled() }}
+
+      - name: Run formatter
+        run: npm run format
+        if: ${{ !cancelled() }}
+
+      - name: Run tsc
+        run: npm run check
+        if: ${{ !cancelled() }}
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps chromium
+        if: ${{ !cancelled() }}
+
+      - name: Docker build
+        run: docker compose build
+        if: ${{ !cancelled() }}
+
+      - name: Run e2e tests (api & cli)
+        run: npm run test
+        if: ${{ !cancelled() }}
+
+      - name: Run e2e tests (web)
+        run: npx playwright test
+        if: ${{ !cancelled() }}
+
   mobile-unit-tests:
     name: Mobile
     runs-on: ubuntu-latest
@@ -203,8 +227,8 @@ jobs:
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
-          channel: "stable"
-          flutter-version: "3.16.9"
+          channel: 'stable'
+          flutter-version-file: ./mobile/pubspec.yaml
       - name: Run tests
         working-directory: ./mobile
         run: flutter test -j 1
@@ -222,7 +246,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.11
-          cache: "poetry"
+          cache: 'poetry'
       - name: Install dependencies
         run: |
           poetry install --with dev --with cpu
@@ -237,22 +261,51 @@ jobs:
           poetry run mypy --install-types --non-interactive --strict app/
       - name: Run tests and coverage
         run: |
-          poetry run pytest --cov app
+          poetry run pytest app --cov=app --cov-report term-missing
+
+  shellcheck:
+    name: ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          ignore_paths: >-
+            **/open-api/**
+            **/openapi/**
+            **/node_modules/**
 
   generated-api-up-to-date:
     name: OpenAPI Clients
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './server/.nvmrc'
+
+      - name: Install server dependencies
+        run: npm --prefix=server ci
+
+      - name: Build the app
+        run: npm --prefix=server run build
+
       - name: Run API generation
         run: make open-api
+
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v20
         id: verify-changed-files
         with:
           files: |
             mobile/openapi
             open-api/typescript-sdk
+            open-api/immich-openapi-specs.json
+
       - name: Verify files have not changed
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |
@@ -265,7 +318,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       postgres:
-        image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
+        image: tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
         env:
           POSTGRES_PASSWORD: postgres
           POSTGRES_USER: postgres
@@ -285,6 +338,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './server/.nvmrc'
+
       - name: Install server dependencies
         run: npm ci
 
@@ -299,14 +357,14 @@ jobs:
 
       - name: Generate new migrations
         continue-on-error: true
-        run: npm run typeorm:migrations:generate ./src/infra/migrations/TestMigration
+        run: npm run typeorm:migrations:generate ./src/migrations/TestMigration
 
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v20
         id: verify-changed-files
         with:
           files: |
-            server/src/infra/migrations/
+            server/src/migrations/
       - name: Verify migration files have not changed
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |
@@ -315,16 +373,16 @@ jobs:
           exit 1
 
       - name: Run SQL generation
-        run: npm run sql:generate
+        run: npm run sync:sql
         env:
           DB_URL: postgres://postgres:postgres@localhost:5432/immich
 
       - name: Find file changes
-        uses: tj-actions/verify-changed-files@v13.1
+        uses: tj-actions/verify-changed-files@v20
         id: verify-changed-sql-files
         with:
           files: |
-            server/src/infra/sql
+            server/src/queries
 
       - name: Verify SQL files have not changed
         if: steps.verify-changed-sql-files.outputs.files_changed == 'true'

.gitignore

@@ -14,7 +14,10 @@ mobile/gradle.properties
 mobile/openapi/pubspec.lock
 mobile/*.jks
 mobile/libisar.dylib
+mobile/openapi/test
+mobile/openapi/doc
+mobile/openapi/.openapi-generator/FILES
 
 open-api/typescript-sdk/build
 mobile/android/fastlane/report.xml
-mobile/ios/fastlane/report.xml
+mobile/ios/fastlane/report.xml

.gitmodules

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

.vscode/settings.json

@@ -0,0 +1,44 @@
+{
+  "editor.formatOnSave": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.tabSize": 2,
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.tabSize": 2,
+    "editor.formatOnSave": true
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.tabSize": 2,
+    "editor.formatOnSave": true
+  },
+  "[svelte]": {
+    "editor.defaultFormatter": "svelte.svelte-vscode",
+    "editor.tabSize": 2
+  },
+  "svelte.enable-ts-plugin": true,
+  "eslint.validate": [
+    "javascript",
+    "svelte"
+  ],
+  "typescript.preferences.importModuleSpecifier": "non-relative",
+  "[dart]": {
+    "editor.formatOnSave": true,
+    "editor.selectionHighlight": false,
+    "editor.suggest.snippetsPreventQuickSuggestions": false,
+    "editor.suggestSelection": "first",
+    "editor.tabCompletion": "onlySnippets",
+    "editor.wordBasedSuggestions": "off",
+    "editor.defaultFormatter": "Dart-Code.dart-code"
+  },
+  "cSpell.words": [
+    "immich"
+  ],
+  "explorer.fileNesting.enabled": true,
+  "explorer.fileNesting.patterns": {
+    "*.ts": "${capture}.spec.ts,${capture}.mock.ts"
+  }
+}

CODEOWNERS

@@ -0,0 +1,5 @@
+/.github/ @bo0tzz
+/docker/ @bo0tzz
+/server/ @danieldietzler
+/machine-learning/ @mertalev
+/e2e/ @danieldietzler

LICENSE

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

Makefile

@@ -10,17 +10,9 @@ dev-update:
 dev-scale:
 	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
-
-pull-stage:
-	docker compose -f ./docker/docker-compose.staging.yml pull
-
-server-e2e-jobs:
-	docker compose -f ./server/e2e/docker-compose.server-e2e.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
-
-server-e2e-api:
-	npm run e2e:api --prefix server
+.PHONY: e2e
+e2e:
+	docker compose -f ./e2e/docker-compose.yml up --build -V --remove-orphans
 
 prod:
 	docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
@@ -39,7 +31,55 @@ open-api-typescript:
 	cd ./open-api && bash ./bin/generate-open-api.sh typescript
 
 sql:
-	npm --prefix server run sql:generate
+	npm --prefix server run sync:sql
 
 attach-server:
 	docker exec -it docker_immich-server_1 sh
+
+renovate:
+  LOG_LEVEL=debug npx renovate --platform=local --repository-cache=reset
+
+MODULES = e2e server web cli sdk
+
+audit-%:
+	npm --prefix $(subst sdk,open-api/typescript-sdk,$*) audit fix
+install-%:
+	npm --prefix $(subst sdk,open-api/typescript-sdk,$*) i
+build-cli: build-sdk
+build-web: build-sdk
+build-%: install-%
+	npm --prefix $(subst sdk,open-api/typescript-sdk,$*) run | grep 'build' >/dev/null \
+		&& npm --prefix $(subst sdk,open-api/typescript-sdk,$*) run build || true
+format-%:
+	npm --prefix $(subst sdk,open-api/typescript-sdk,$*) run | grep 'format:fix' >/dev/null \
+		&& npm --prefix $(subst sdk,open-api/typescript-sdk,$*) run format:fix || true
+lint-%:
+	npm --prefix $* run lint:fix
+check-%:
+	npm --prefix $* run check
+check-web:
+	npm --prefix web run check:typescript
+	npm --prefix web run check:svelte
+test-%:
+	npm --prefix $* run test
+test-e2e:
+	docker compose -f ./e2e/docker-compose.yml build
+	npm --prefix e2e run test
+	npm --prefix e2e run test:web
+
+build-all: $(foreach M,$(MODULES),build-$M) ;
+install-all: $(foreach M,$(MODULES),install-$M) ;
+check-all: $(foreach M,$(MODULES),check-$M) ;
+lint-all: $(foreach M,$(MODULES),lint-$M) ;
+format-all: $(foreach M,$(MODULES),format-$M) ;
+audit-all:  $(foreach M,$(MODULES),audit-$M) ;
+hygiene-all: lint-all format-all check-all sql audit-all;
+test-all: $(foreach M,$(MODULES),test-$M) ;
+
+clean:
+	find . -name "node_modules" -type d -prune -exec rm -rf '{}' +
+	find . -name "dist" -type d -prune -exec rm -rf '{}' +
+	find . -name "build" -type d -prune -exec rm -rf '{}' +
+	find . -name "svelte-kit" -type d -prune -exec rm -rf '{}' +
+	docker compose -f ./docker/docker-compose.dev.yml rm -v -f || true
+	docker compose -f ./e2e/docker-compose.yml rm -v -f || true

README.md

@@ -1,7 +1,7 @@
 <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">
+  <a href="https://opensource.org/license/agpl-v3"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: AGPLv3"></a>
+  <a href="https://discord.immich.app">
     <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/>  
@@ -9,26 +9,31 @@
 </p>
 
 <p align="center">
-<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
+<img src="design/immich-logo-stacked-light.svg" width="300" title="Login With Custom URL">
 </p>
-<h3 align="center">Immich - High performance self-hosted photo and video backup solution</h3>
+<h3 align="center">High performance self-hosted photo and video management solution</h3>
 <br/>
 <a href="https://immich.app">
 <img src="design/immich-screenshots.png" title="Main Screenshot">
 </a>
 <br/>
 <p align="center">
-  <a href="README_ca_ES.md">Català</a>
-  <a href="README_es_ES.md">Español</a>
-  <a href="README_fr_FR.md">Français</a>
-  <a href="README_it_IT.md">Italiano</a>
-  <a href="README_ja_JP.md">日本語</a>
-  <a href="README_ko_KR.md">한국어</a>
-  <a href="README_de_DE.md">Deutsch</a>
-  <a href="README_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_zh_CN.md">中文</a>
-  <a href="README_ru_RU.md">Русский</a>
+
+<a href="readme_i18n/README_ca_ES.md">Català</a>
+<a href="readme_i18n/README_es_ES.md">Español</a>
+<a href="readme_i18n/README_fr_FR.md">Français</a>
+<a href="readme_i18n/README_it_IT.md">Italiano</a>
+<a href="readme_i18n/README_ja_JP.md">日本語</a>
+<a href="readme_i18n/README_ko_KR.md">한국어</a>
+<a href="readme_i18n/README_de_DE.md">Deutsch</a>
+<a href="readme_i18n/README_nl_NL.md">Nederlands</a>
+<a href="readme_i18n/README_tr_TR.md">Türkçe</a>
+<a href="readme_i18n/README_zh_CN.md">中文</a>
+<a href="readme_i18n/README_ru_RU.md">Русский</a>
+<a href="readme_i18n/README_pt_BR.md">Português Brasileiro</a>
+<a href="readme_i18n/README_sv_SE.md">Svenska</a>
+<a href="readme_i18n/README_ar_JO.md">العربية</a>
+
 </p>
 
 ## Disclaimer
@@ -38,42 +43,36 @@
 - ⚠️ **Do not use the app as the only way to store your photos and videos.**
 - ⚠️ Always follow [3-2-1](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/) backup plan for your precious photos and videos!
 
-## Content
+> [!NOTE]
+> You can find the main documentation, including installation guides, at https://immich.app/.
 
-- [Official Documentation](https://immich.app/docs)
-- [Roadmap](https://github.com/orgs/immich-app/projects/1)
+## Links
+
+- [Documentation](https://immich.app/docs)
+- [About](https://immich.app/docs/overview/introduction)
+- [Installation](https://immich.app/docs/install/requirements)
+- [Roadmap](https://immich.app/roadmap)
 - [Demo](#demo)
 - [Features](#features)
-- [Introduction](https://immich.app/docs/overview/introduction)
-- [Installation](https://immich.app/docs/install/requirements)
-- [Contribution Guidelines](https://immich.app/docs/overview/support-the-project)
-- [Support The Project](#support-the-project)
-
-## Documentation
-
-You can find the main documentation, including installation guides, at https://immich.app/.
+- [Translations](https://immich.app/docs/developer/tranlations)
+- [Contributing](https://immich.app/docs/overview/support-the-project)
 
 ## Demo
 
-You can access the web demo at https://demo.immich.app
+Access the demo [here](https://demo.immich.app). The demo is running on a Free-tier Oracle VM in Amsterdam with a 2.4Ghz quad-core ARM64 CPU and 24GB RAM.
 
 For the mobile app, you can use `https://demo.immich.app/api` for the `Server Endpoint URL`
 
-```bash title="Demo Credential"
-The credential
-email: demo@immich.app
-password: demo
-```
+### Login credentials
 
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
+| Email           | Password |
+| --------------- | -------- |
+| demo@immich.app | demo     |
 
 ## Features
 
-
 | Features                                     | Mobile | Web |
-| :--------------------------------------------- | -------- | ----- |
+| :------------------------------------------- | ------ | --- |
 | Upload and view videos and photos            | Yes    | Yes |
 | Auto backup when the app is opened           | Yes    | N/A |
 | Prevent duplication of assets                | Yes    | Yes |
@@ -103,22 +102,27 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | Read-only gallery                            | Yes    | Yes |
 | Stacked Photos                               | Yes    | Yes |
 
-## Support the project
+## Translations
 
-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.
+Read more about translations [here](https://immich.app/docs/developer/translations).
 
-As our hosts in the [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) said, this is a massive undertaking of what the team and I are doing. And I would love to someday be able to do this full-time, and I am asking for your help to make that happen.
+<a href="https://hosted.weblate.org/engage/immich/">
+<img src="https://hosted.weblate.org/widget/immich/immich/multi-auto.svg" alt="Translation status" />
+</a>
 
-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.
+## Repository activity
 
-### Donation
+![Activities](https://repobeats.axiom.co/api/embed/9e86d9dc3ddd137161f2f6d2e758d7863b1789cb.svg "Repobeats analytics image")
 
-- [Monthly donation](https://github.com/sponsors/immich-app) via GitHub Sponsors
-- [One-time donation](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
-- [Liberapay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
+## Star history
+
+<a href="https://star-history.com/#immich-app/immich&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=immich-app/immich&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=immich-app/immich&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=immich-app/immich&type=Date" width="100%" />
+ </picture>
+</a>
 
 ## Contributors
 

README_ca_ES.md

@@ -1,114 +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=Llicència&logoColor=000000&labelColor=ececec" alt="Llicència: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>  
-  <br/>   
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Iniciar sessió amb URL personalitzada">
-</p>
-<h3 align="center">Immich - Solució de còpia de seguretat d'alta rendiment per a fotos i vídeos auto-allotjada</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Captura de pantalla principal">
-</a>
-<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>
-</p>
-
-## Avís legal
-
-- ⚠️ El projecte està en desenvolupament **molt actiu**.
-- ⚠️ Espereu errors i canvis que poden trencar coses.
-- ⚠️ **No utilitzeu l'aplicació com a única manera de guardar les vostres fotos i vídeos!**
-
-## Contingut
-
-- [Documentació oficial](https://immich.app/docs)
-- [Mapa de ruta](https://github.com/orgs/immich-app/projects/1)
-- [Demo](#demo)
-- [Funcionalitats](#funcionalitats)
-- [Introducció](https://immich.app/docs/overview/introduction)
-- [Instal·lació](https://immich.app/docs/install/requirements)
-- [Directrius de contribució](https://immich.app/docs/overview/support-the-project)
-- [Donar suport al projecte](#suportar-el-projecte)
-
-## Documentació
-
-Podeu trobar la documentació principal, incloent les guies d'instal·lació, a https://immich.app/.
-
-## Demo
-
-Podeu accedir a la demostració web a https://demo.immich.app
-
-Per a l'aplicació mòbil, podeu utilitzar `https://demo.immich.app/api` com a "URL de punt final del servidor".
-
-```bash title="Credencials de la demo"
-Les credencials
-email: demo@immich.app
-contrasenya: demo
-```
-```
-Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-# Funcionalitats
-
-| Característiques                              | Mòbil  | Web |
-| -------------------------------------------- | ------ | --- |
-| Pujar i veure vídeos i fotos                  | Sí     | Sí  |
-| Còpia de seguretat automàtica en obrir l'aplicació | Sí | N/A |
-| Selecció d'àlbums per a la còpia de seguretat | Sí     | N/A |
-| Descarregar fotos i vídeos a l'aparell local  | Sí     | Sí  |
-| Suport per a múltiples usuaris                | Sí     | Sí  |
-| Àlbums i àlbums compartits                    | Sí     | Sí  |
-| Barra de desplaçament amb funció de rasclet/arrossegament | Sí | Sí |
-| Suport per a formats raw                      | Sí     | Sí  |
-| Visualització de metadades (EXIF, mapa)       | Sí     | Sí  |
-| Cerca per metadades, objectes, cares i CLIP   | Sí     | Sí  |
-| Funcions administratives (gestió d'usuaris)   | No     | Sí  |
-| Còpia de seguretat en segon pla               | Sí     | N/A |
-| Desplaçament virtual                          | Sí     | Sí  |
-| Suport per a OAuth                            | Sí     | Sí  |
-| Claus d'API                                   | N/A    | Sí  |
-| Còpia de seguretat i reproducció de LivePhoto  | iOS    | Sí  |
-| Estructura d'emmagatzematge definida per l'usuari | Sí  | Sí  |
-| Compartició pública                           | No     | Sí  |
-| Arxiu i preferits                             | Sí     | Sí  |
-| Mapa global                                   | No     | Sí  |
-| Compartició amb associats                      | Sí     | Sí  |
-| Reconeixement facial i agrupament              | Sí     | Sí  |
-| Records (fa x anys)                           | Sí     | Sí  |
-| Suport fora de línia                          | Sí     | No  |
-| Galeria de només lectura                      | Sí     | Sí  |
-
-# Donar suport al projecte
-
-M'he compromès amb aquest projecte i no em detindré. Continuaré actualitzant la documentació, afegint noves funcionalitats i solucionant errors. Però no ho puc fer sol. Per això, necessito la vostra ajuda per donar-me motivació addicional per seguir endavant.
-
-Com van dir els nostres amfitrions a l'episodi [selfhosted.show - 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418), això és una tasca enorme del que l'equip i jo estem fent. I m'encantaria poder dedicar-m'hi a temps complet, per la qual cosa us demano la vostra ajuda per fer-ho possible.
-
-Si creieu que aquesta és una causa justa i l'aplicació és alguna cosa que us veieu utilitzant durant molt de temps, considereu donar suport al projecte amb alguna de les opcions següents.
-
-## Donació
-
-- [Donació mensual](https://github.com/sponsors/immich-app) a través de GitHub Sponsors
-- [Donació única](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- 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

@@ -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="Licencia: MIT"></a>
-  <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
-  </a>
-  <br/>
-  <br/>
-</p>
-
-<p align="center">
-<img src="design/immich-logo.svg" width="150" title="Iniciar sesión con URL personalizada">
-</p>
-<h3 align="center">Immich: Una solución Self-Hosted de copia de seguridad de fotos y videos de alto rendimiento</h3>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="Captura de pantalla principal">
-</a>
-<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>
-</p>
-
-## Descargo de responsabilidad
-
-- ⚠️ El proyecto está en **desarrollo muy activo**.
-- ⚠️ Es probable que haya errores y cambios disruptivos.
-- ⚠️ **¡No utilices la aplicación como única forma de almacenar tus fotos y videos!**
-
-## Contenido
-
-- [Documentación oficial](https://immich.app/docs)
-- [Hoja de ruta](https://github.com/orgs/immich-app/projects/1)
-- [Demostración](#demo)
-- [Funciones](#features)
-- [Introducción](https://immich.app/docs/overview/introduction)
-- [Instalación](https://immich.app/docs/install/requirements)
-- [Directrices para contribuir](https://immich.app/docs/overview/support-the-project)
-- [Apoya el proyecto](#support-the-project)
-
-## Documentación
-
-Puedes encontrar la documentación principal, incluidas las guías de instalación, en <https://immich.app/>.
-
-## Demostración
-
-Puedes acceder a la demostración web en <https://demo.immich.app>
-
-Para la aplicación móvil, puedes usar `https://demo.immich.app/api` como `URL de la terminal del servidor`.
-
-```bash title="Credenciales de la demostración"
-Las credenciales son
-correo electrónico: demo@immich.app
-contraseña: demo
-```
-
-```bash
-Especificaciones: VM de nivel gratuito de Oracle - Ámsterdam - CPU ARM64 de cuatro núcleos a 2.4 GHz, 24 GB de RAM
-```
-
-## Funcionalidades
-
-| Funcionalidades                                       | Móvil | Web |
-| ----------------------------------------------------- | ------ | --- |
-| Cargar y ver videos y fotos                          | Sí     | Sí  |
-| Copia de seguridad automática al abrir la aplicación | Sí     | N/D |
-| Álbum(es) selectivo(s) para copia de seguridad       | Sí     | N/D |
-| Descargar fotos y videos al dispositivo local        | Sí     | Sí  |
-| Soporte multiusuario                                 | Sí     | Sí  |
-| Álbum y álbumes compartidos                          | Sí     | Sí  |
-| Barra de desplazamiento con función de búsqueda      | Sí     | Sí  |
-| Soporte para formatos RAW                            | Sí     | Sí  |
-| Visualización de metadatos (EXIF, map)              | Sí     | Sí  |
-| Búsqueda por metadatos, objetos, rostros y CLIP      | Sí     | Sí  |
-| Funciones administrativas (gestión de usuarios)      | No     | Sí  |
-| Copia de seguridad en segundo plano                  | Sí     | N/D |
-| Desplazamiento virtual                               | Sí     | Sí  |
-| Soporte de OAuth                                     | Sí     | Sí  |
-| Claves de API                                        | N/D    | Sí  |
-| Copia de seguridad y reproducción de LivePhoto       | iOS    | Sí  |
-| Estructura de almacenamiento definida por el usuario | Sí     | Sí  |
-| Compartir públicamente                               | No     | Sí  |
-| Archivar y marcar como favorito                      | Sí     | Sí  |
-| Mapa global                                          | No     | Sí  |
-| Compartir con colaboradores                          | Sí     | Sí  |
-| Reconocimiento facial y agrupación                   | Sí     | Sí  |
-| Recuerdos (hace x años)                              | Sí     | Sí  |
-| Soporte sin conexión                                 | Sí     | No  |
-| Galería de solo lectura                              | Sí     | Sí  |
-
-## Apoya el proyecto
-
-Me he comprometido con este proyecto, y no me detendré. Continuaré actualizando la documentación, agregando nuevas funcionalidades y corrigiendo errores. Pero no puedo hacerlo solo. Por eso, necesito tu ayuda para darme una motivación adicional para seguir adelante.
-
-Como dijeron nuestros anfitriones en [selfhosted.show - En el episodio 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418), esto es una gran tarea de lo que el equipo y yo estamos haciendo. Y me encantaría poder dedicarme a esto a tiempo completo algún día, así que te pido tu ayuda para que eso sea posible.
-
-Si consideras que esta es una causa justa y la aplicación es algo que te gustaría usar durante mucho tiempo, por favor, considera apoyar el proyecto con las siguientes opciones.
-
-## Donación
-
-- [Donación mensual](https://github.com/sponsors/immich-app) a través de GitHub Sponsors
-- [Donación única](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) a través de GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- 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/immich-app) via GitHub Sponsors
-- [Donation occasionnelle](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- 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/immich-app) tramite GitHub Sponsors
-- [Donazione una tantum](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) tramite GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- 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-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) のホストが言ったように、これはチームと私がやっていることの大規模な事業だ。そしていつの日か、フルタイムでこの仕事ができるようになりたいと思っています。
-
-もし、あなたがこのプロジェクトに賛同し、このアプリを長く使い続けたいと思われるのであれば、以下のオプションから支援をご検討ください。
-
-## 寄付
-
-- GitHub スポンサー経由の[毎月の寄付](https://github.com/sponsors/immich-app)
-- GitHub スポンサー経由の[一回寄付](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX

README_ko_KR.md

@@ -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/immich-app)
-- GitHub 스폰서를 통한 [일시 후원](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- 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/immich-app) via GitHub Sponsors
-- [Eenmalige donatie](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_ru_RU.md

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

README_tr_TR.md

@@ -1,113 +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 - Yüksek performanslı, kendine ait barındırılan fotoğraf ve video yedekleme çözümü</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_nl_NL.md">Nederlands</a>
-  <a href="README_zh_CN.md">中文</a>
-</p>
-
-## Feragatname
-
-- ⚠️ Proje **çok aktif** bir şekilde geliştirilmektedir.
-- ⚠️ Hatalar ve uygulama yapısını bozan değişiklikler olabilir.
-- ⚠️ **Uygulamayı, fotoğraflarınızı ve videolarınızı saklamanın tek yöntemi olarak kullanmayın!**
-
-## Content
-
-- [Resmi Belgeler](https://immich.app/docs)
-- [Yol Haritası](https://github.com/orgs/immich-app/projects/1)
-- [Demo](#demo)
-- [Özellikler](#özellikler)
-- [Giriş](https://immich.app/docs/overview/introduction)
-- [Kurulum](https://immich.app/docs/install/requirements)
-- [Katkı Sağlama Rehberi](https://immich.app/docs/overview/support-the-project)
-- [Projeyi Destekle](#projeyi-destekle)
-
-## Belgeler
-
-Kurulum dahil olmak üzere resmi belgeleri https://immich.app/ adresinde bulabilirsiniz.
-
-## Demo
-
-Web demo adresi: https://demo.immich.app
-
-Mobil uygulama için `Server Endpoint URL` olarak `https://demo.immich.app/api` adresini kullanabilirsiniz.
-
-```bash title="Demo Bilgileri"
-Giriş bilgileri:
-email: demo@immich.app
-password: demo
-```
-
-```
-Server Özellikleri: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
-```
-
-# Özellikler
-
-| Özellikler                                          | Mobile | Web  |
-| ----------------------------------------------------| ------ | ---  |
-| Videoları ve fotoğrafları yükleme ve görüntüleme    | Evet   | Evet |
-| Uygulama açıldığında otomatik yedekleme             | Evet   | N/A  |
-| Yedekleme için seçilebilir albüm(ler)               | Evet   | N/A  |
-| Fotoğrafları ve videoları yerel cihaza yükleme      | Evet   | Evet |
-| Çoklu kullanıcı desteği                             | Evet   | Evet |
-| Albüm ve paylaşılan albümler                        | Evet   | Evet |
-| Silinebilir/sürüklenebilir kaydırma çubuğu          | Evet   | Evet |
-| RAW (HEIC, HEIF, DNG, Apple ProRaw) format desteği  | Evet   | Evet |
-| Metadata'ya uygun görüntüleme (EXIF, map)           | Evet   | Evet |
-| Metadata, objects, faces ve CLIP'e göre arama       | Evet   | Evet |
-| Yönetimsel işlevler (kullanıcı yönetimi)            | Hayır  | Evet |
-| Arka planda yedekleme                               | Evet   | N/A  |
-| Sanal kaydırma                                      | Evet   | Evet |
-| OAuth desteği                                       | Evet   | Evet |
-| API anahtarları                                     | N/A    | Evet |
-| LivePhoto yedekleme ve oynatma                      | iOS    | Evet |
-| Kullanıcı tanımlı depolama yapısı                   | Evet   | Evet |
-| Herkese açık paylaşım                               | Hayır  | Evet |
-| Arşiv ve Favoriler                                  | Evet   | Evet |
-| Dünya haritası                                      | Hayır  | Evet |
-| Partner paylaşımı                                   | Evet   | Evet |
-| Yüz tanıma ve kümeleme                              | Hayır  | Evet |
-| Çevrimdışı destek                                   | Evet   | Hayır|
-
-# Projeyi Destekle
-
-Bu projeye bağlı kaldım ve durmayacağım. Belgeleri güncellemeye, yeni özellikler eklemeye ve hataları düzeltmeye devam edeceğim. Ancak bunu tek başıma yapamam. Bu yüzden devam etme konusunda bana motivasyon sağlamanız için yardımınıza ihtiyacım var.
-
-[selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) bölümünde söylendiği üzere,bu projede takımımın ve benim projeye harcadağımız büyük bir çaba var. Bir gün bunu tam zamanlı olarak yapabilmeyi çok isterim. Bunu gerçekleştirebilmek için gerçekten sizlerin desteğine ihtiyacım var.
-
-Eğer bu size doğru bir amaç gibi geliyorsa ve uygulamanın uzun bir süre boyunca kullanacağınız bir şey olduğunu düşünüyorsanız, aşağıdaki bağlantılardan birini kullanarak bana destek olabilirsiniz.
-
-## Bağış
-
-- [Aylık bağış](https://github.com/sponsors/immich-app) via GitHub Sponsors
-- [Bir seferlik bağış](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz

README_zh_CN.md

@@ -1,128 +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>
-<p align="center">  
-请注意: 此 README 不是由 Immich 团队维护, 而是依靠贡献者来更新的，这意味着它可能并不会被及时更新。感谢理解。
-</p>
-<br/>
-<a href="https://immich.app">
-<img src="design/immich-screenshots.png" title="界面截图">
-</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_nl_NL.md">Nederlands</a>
-  <a href="README_tr_TR.md">Türkçe</a>
-  <a href="README_ru_RU.md">Русский</a>
-</p>
-
-## 免责声明
-
-- ⚠️ 本项目正在 **非常活跃** 地开发中。
-- ⚠️ 可能存在 bug 或者随时有重大变更。
-- ⚠️ **不要把本软件作为您存储照片或视频的唯一方式。**
-- ⚠️ 为了您宝贵的照片与视频，请始终遵守 [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/ 找到官方文档（包含安装手册）。
-
-## 示例
-
-您可以在 https://demo.immich.app  访问示例。
-
-在移动端, 您可以使用 `https://demo.immich.app/api` 获取 `服务终端链接`
-
-```bash title="示例认证信息"
-认证信息
-邮箱: demo@immich.app
-密码: demo
-```
-
-```
-规格: 甲骨文免费虚拟机套餐——阿姆斯特丹 4核 2.4Ghz ARM64 CPU, 24GB RAM。
-```
-
-# 功能特性
-
-| 功能特性                                    | 移动端 | 网页端 |
-|---------------------------------------------|--------|--------|
-| 上传并查看照片和视频                        | 是     | 是     |
-| 软件运行时自动备份                          | 是     | N/A    |
-| 选择需要备份的相册                          | 是     | N/A    |
-| 下载照片和视频到本地                        | 是     | 是     |
-| 多用户支持                                  | 是     | 是     |
-| 相册与共享相册                              | 是     | 是     |
-| 可拖动的快速导航栏                          | 是     | 是     |
-| 支持RAW格式                                 | 是     | 是     |
-| 元数据视图（EXIF、地图）                    | 是     | 是     |
-| 通过元数据、对象、人脸和标签进行搜索        | 是     | 是     |
-| 管理功能（用户管理）                        | 否     | 是     |
-| 后台备份                                    | 是     | N/A    |
-| 虚拟滚动                                    | 是     | 是     |
-| OAuth 支持                                  | 是     | 是     |
-| API Keys                                    | N/A    | 是     |
-| 实况照片备份和查看                          | 是     | 是     |
-| 用户自定义存储结构                          | 是     | 是     |
-| 公共分享                                    | 否     | 是     |
-| 归档与收藏功能                              | 是     | 是     |
-| 足迹地图                                    | 是     | 是     |
-| 好友分享                                    | 是     | 是     |
-| 人脸识别与分组                              | 是     | 是     |
-| 回忆（那年今日）                            | 是     | 是     |
-| 离线支持                                    | 是     | 否     |
-| 只读相册                                    | 是     | 是     |
-| 照片堆叠                                    | 是     | 是     |
-
-
-# 支持本项目
-
-我已经致力于本项目并且我将会持续更新文档、新增功能和修复问题。但是独木不成林，我需要您给予我坚持下去的动力。
-
-就像我在 [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) 节目里说的一样，这是我和团队的一项艰巨任务。并且我希望某一天我能够全职开发本项目，在此我请求您能够助我梦想成真。
-
-如果您使用了本项目一段时间，并且觉得上面的话有道理，那么请您考虑通过下列任一方式支持我吧。
-
-## 捐赠
-
-- 通过 GitHub Sponsors [按月捐赠](https://github.com/sponsors/immich-app)
-- 通过 Github Sponsors [单次捐赠](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502)
-- [Librepay](https://liberapay.com/alex.tran1502/)
-- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
-- 比特币: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
-
-## 贡献者
-<a href="https://github.com/alextran1502/immich/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
-</a>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report security issues to `alex.tran1502@gmail.com`
+Please report security issues to `security@immich.app`

cli/.eslintrc.cjs

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

cli/.npmignore

@@ -1,12 +1,15 @@
 **/*.spec.js
-test/**
+coverage/**
+src/**
 upload/**
 .editorconfig
 .eslintignore
-.eslintrc.js
+.eslintrc.cjs
+.gitignore
 .prettierignore
 .prettierrc
+Dockerfile
 package-lock.json
-testSetup.js
 tsconfig.json
-tsconfig.build.json
+vite.config.ts
+vitest.config.ts

cli/.nvmrc

@@ -0,0 +1 @@
+20.15

cli/.prettierrc

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

cli/Dockerfile

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

cli/LICENSE

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

cli/package.json

@@ -1,62 +1,67 @@
 {
   "name": "@immich/cli",
-  "version": "2.0.6",
+  "version": "2.2.5",
   "description": "Command Line Interface (CLI) for Immich",
   "type": "module",
   "exports": "./dist/index.js",
   "bin": {
-    "immich": "./dist/src/index.js"
+    "immich": "dist/index.js"
   },
-  "license": "MIT",
+  "license": "GNU Affero General Public License version 3",
   "keywords": [
     "immich",
     "cli"
   ],
-  "dependencies": {
-    "@immich/sdk": "file:../open-api/typescript-sdk",
-    "axios": "^1.6.7",
-    "byte-size": "^8.1.1",
-    "cli-progress": "^3.12.0",
-    "commander": "^11.0.0",
-    "form-data": "^4.0.0",
-    "glob": "^10.3.1",
-    "yaml": "^2.3.1"
-  },
   "devDependencies": {
-    "@testcontainers/postgresql": "^10.4.0",
+    "@immich/sdk": "file:../open-api/typescript-sdk",
     "@types/byte-size": "^8.1.0",
     "@types/cli-progress": "^3.11.0",
+    "@types/lodash-es": "^4.17.12",
     "@types/mock-fs": "^4.13.1",
-    "@types/node": "^20.3.1",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
     "@vitest/coverage-v8": "^1.2.2",
-    "eslint": "^8.43.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-unicorn": "^50.0.0",
-    "immich": "file:../server",
+    "byte-size": "^8.1.1",
+    "cli-progress": "^3.12.0",
+    "commander": "^12.0.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-unicorn": "^54.0.0",
     "mock-fs": "^5.2.0",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.5.3",
-    "typescript": "^5.0.0",
-    "vitest": "^1.2.1"
+    "prettier": "^3.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.12",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.2.2",
+    "yaml": "^2.3.1"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
+    "build": "vite build",
+    "lint": "eslint \"src/**/*.ts\" --max-warnings 0",
     "lint:fix": "npm run lint -- --fix",
     "prepack": "npm run build",
     "test": "vitest",
     "test:cov": "vitest --coverage",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "check": "tsc --noEmit",
-    "test:e2e": "vitest --config test/e2e/vitest.config.ts"
+    "check": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
-    "url": "github:immich-app/immich",
+    "url": "git+https://github.com/immich-app/immich.git",
     "directory": "cli"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.2",
+    "lodash-es": "^4.17.21"
+  },
+  "volta": {
+    "node": "20.15.0"
   }
 }

cli/src/commands/asset.spec.ts

@@ -0,0 +1,19 @@
+import { platform } from 'node:os';
+import { UploadOptionsDto, getAlbumName } from 'src/commands/asset';
+import { describe, expect, it } from 'vitest';
+
+describe('Unit function tests', () => {
+  it('should return a non-undefined value', () => {
+    if (platform() === 'win32') {
+      // This is meaningless for Unix systems.
+      expect(getAlbumName(String.raw`D:\test\Filename.txt`, {} as UploadOptionsDto)).toBe('test');
+    }
+    expect(getAlbumName('D:/parentfolder/test/Filename.txt', {} as UploadOptionsDto)).toBe('test');
+  });
+
+  it('has higher priority to return `albumName` in `options`', () => {
+    expect(getAlbumName('/parentfolder/test/Filename.txt', { albumName: 'example' } as UploadOptionsDto)).toBe(
+      'example',
+    );
+  });
+});

cli/src/commands/asset.ts

@@ -0,0 +1,353 @@
+import {
+  Action,
+  AssetBulkUploadCheckResult,
+  AssetMediaResponseDto,
+  AssetMediaStatus,
+  addAssetsToAlbum,
+  checkBulkUpload,
+  createAlbum,
+  defaults,
+  getAllAlbums,
+  getSupportedMediaTypes,
+} from '@immich/sdk';
+import byteSize from 'byte-size';
+import { Presets, SingleBar } from 'cli-progress';
+import { chunk } from 'lodash-es';
+import { Stats, createReadStream } from 'node:fs';
+import { stat, unlink } from 'node:fs/promises';
+import path, { basename } from 'node:path';
+import { BaseOptions, authenticate, crawl, sha1 } from 'src/utils';
+
+const s = (count: number) => (count === 1 ? '' : 's');
+
+// TODO figure out why `id` is missing
+type AssetBulkUploadCheckResults = Array<AssetBulkUploadCheckResult & { id: string }>;
+type Asset = { id: string; filepath: string };
+
+export interface UploadOptionsDto {
+  recursive?: boolean;
+  ignore?: string;
+  dryRun?: boolean;
+  skipHash?: boolean;
+  delete?: boolean;
+  album?: boolean;
+  albumName?: string;
+  includeHidden?: boolean;
+  concurrency: number;
+}
+
+class UploadFile extends File {
+  constructor(
+    private filepath: string,
+    private _size: number,
+  ) {
+    super([], basename(filepath));
+  }
+
+  get size() {
+    return this._size;
+  }
+
+  stream() {
+    return createReadStream(this.filepath) as any;
+  }
+}
+
+export const upload = async (paths: string[], baseOptions: BaseOptions, options: UploadOptionsDto) => {
+  await authenticate(baseOptions);
+
+  const scanFiles = await scan(paths, options);
+  if (scanFiles.length === 0) {
+    console.log('No files found, exiting');
+    return;
+  }
+
+  const { newFiles, duplicates } = await checkForDuplicates(scanFiles, options);
+  const newAssets = await uploadFiles(newFiles, options);
+  await updateAlbums([...newAssets, ...duplicates], options);
+  await deleteFiles(newFiles, options);
+};
+
+const scan = async (pathsToCrawl: string[], options: UploadOptionsDto) => {
+  const { image, video } = await getSupportedMediaTypes();
+
+  console.log('Crawling for assets...');
+  const files = await crawl({
+    pathsToCrawl,
+    recursive: options.recursive,
+    exclusionPattern: options.ignore,
+    includeHidden: options.includeHidden,
+    extensions: [...image, ...video],
+  });
+
+  return files;
+};
+
+const checkForDuplicates = async (files: string[], { concurrency, skipHash }: UploadOptionsDto) => {
+  if (skipHash) {
+    console.log('Skipping hash check, assuming all files are new');
+    return { newFiles: files, duplicates: [] };
+  }
+
+  const progressBar = new SingleBar(
+    { format: 'Checking files | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets' },
+    Presets.shades_classic,
+  );
+
+  progressBar.start(files.length, 0);
+
+  const newFiles: string[] = [];
+  const duplicates: Asset[] = [];
+
+  try {
+    // TODO refactor into a queue
+    for (const items of chunk(files, concurrency)) {
+      const dto = await Promise.all(items.map(async (filepath) => ({ id: filepath, checksum: await sha1(filepath) })));
+      const { results } = await checkBulkUpload({ assetBulkUploadCheckDto: { assets: dto } });
+
+      for (const { id: filepath, assetId, action } of results as AssetBulkUploadCheckResults) {
+        if (action === Action.Accept) {
+          newFiles.push(filepath);
+        } else {
+          // rejects are always duplicates
+          duplicates.push({ id: assetId as string, filepath });
+        }
+        progressBar.increment();
+      }
+    }
+  } finally {
+    progressBar.stop();
+  }
+
+  console.log(`Found ${newFiles.length} new files and ${duplicates.length} duplicate${s(duplicates.length)}`);
+
+  return { newFiles, duplicates };
+};
+
+const uploadFiles = async (files: string[], { dryRun, concurrency }: UploadOptionsDto): Promise<Asset[]> => {
+  if (files.length === 0) {
+    console.log('All assets were already uploaded, nothing to do.');
+    return [];
+  }
+
+  // Compute total size first
+  let totalSize = 0;
+  const statsMap = new Map<string, Stats>();
+  for (const filepath of files) {
+    const stats = await stat(filepath);
+    statsMap.set(filepath, stats);
+    totalSize += stats.size;
+  }
+
+  if (dryRun) {
+    console.log(`Would have uploaded ${files.length} asset${s(files.length)} (${byteSize(totalSize)})`);
+    return files.map((filepath) => ({ id: '', filepath }));
+  }
+
+  const uploadProgress = new SingleBar(
+    { format: 'Uploading assets | {bar} | {percentage}% | ETA: {eta_formatted} | {value_formatted}/{total_formatted}' },
+    Presets.shades_classic,
+  );
+  uploadProgress.start(totalSize, 0);
+  uploadProgress.update({ value_formatted: 0, total_formatted: byteSize(totalSize) });
+
+  let duplicateCount = 0;
+  let duplicateSize = 0;
+  let successCount = 0;
+  let successSize = 0;
+
+  const newAssets: Asset[] = [];
+
+  try {
+    for (const items of chunk(files, concurrency)) {
+      await Promise.all(
+        items.map(async (filepath) => {
+          const stats = statsMap.get(filepath) as Stats;
+          const response = await uploadFile(filepath, stats);
+
+          newAssets.push({ id: response.id, filepath });
+
+          if (response.status === AssetMediaStatus.Duplicate) {
+            duplicateCount++;
+            duplicateSize += stats.size ?? 0;
+          } else {
+            successCount++;
+            successSize += stats.size ?? 0;
+          }
+
+          uploadProgress.update(successSize, { value_formatted: byteSize(successSize + duplicateSize) });
+
+          return response;
+        }),
+      );
+    }
+  } finally {
+    uploadProgress.stop();
+  }
+
+  console.log(`Successfully uploaded ${successCount} new asset${s(successCount)} (${byteSize(successSize)})`);
+  if (duplicateCount > 0) {
+    console.log(`Skipped ${duplicateCount} duplicate asset${s(duplicateCount)} (${byteSize(duplicateSize)})`);
+  }
+  return newAssets;
+};
+
+const uploadFile = async (input: string, stats: Stats): Promise<AssetMediaResponseDto> => {
+  const { baseUrl, headers } = defaults;
+
+  const assetPath = path.parse(input);
+  const noExtension = path.join(assetPath.dir, assetPath.name);
+
+  const sidecarsFiles = await Promise.all(
+    // XMP sidecars can come in two filename formats. For a photo named photo.ext, the filenames are photo.ext.xmp and photo.xmp
+    [`${noExtension}.xmp`, `${input}.xmp`].map(async (sidecarPath) => {
+      try {
+        const stats = await stat(sidecarPath);
+        return new UploadFile(sidecarPath, stats.size);
+      } catch {
+        return false;
+      }
+    }),
+  );
+
+  const sidecarData = sidecarsFiles.find((file): file is UploadFile => file !== false);
+
+  const formData = new FormData();
+  formData.append('deviceAssetId', `${basename(input)}-${stats.size}`.replaceAll(/\s+/g, ''));
+  formData.append('deviceId', 'CLI');
+  formData.append('fileCreatedAt', stats.mtime.toISOString());
+  formData.append('fileModifiedAt', stats.mtime.toISOString());
+  formData.append('fileSize', String(stats.size));
+  formData.append('isFavorite', 'false');
+  formData.append('assetData', new UploadFile(input, stats.size));
+
+  if (sidecarData) {
+    formData.append('sidecarData', sidecarData);
+  }
+
+  const response = await fetch(`${baseUrl}/assets`, {
+    method: 'post',
+    redirect: 'error',
+    headers: headers as Record<string, string>,
+    body: formData,
+  });
+  if (response.status !== 200 && response.status !== 201) {
+    throw new Error(await response.text());
+  }
+
+  return response.json();
+};
+
+const deleteFiles = async (files: string[], options: UploadOptionsDto): Promise<void> => {
+  if (!options.delete) {
+    return;
+  }
+
+  if (options.dryRun) {
+    console.log(`Would have deleted ${files.length} local asset${s(files.length)}`);
+    return;
+  }
+
+  console.log('Deleting assets that have been uploaded...');
+
+  const deletionProgress = new SingleBar(
+    { format: 'Deleting local assets | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets' },
+    Presets.shades_classic,
+  );
+  deletionProgress.start(files.length, 0);
+
+  try {
+    for (const assetBatch of chunk(files, options.concurrency)) {
+      await Promise.all(assetBatch.map((input: string) => unlink(input)));
+      deletionProgress.update(assetBatch.length);
+    }
+  } finally {
+    deletionProgress.stop();
+  }
+};
+
+const updateAlbums = async (assets: Asset[], options: UploadOptionsDto) => {
+  if (!options.album && !options.albumName) {
+    return;
+  }
+  const { dryRun, concurrency } = options;
+
+  const albums = await getAllAlbums({});
+  const existingAlbums = new Map(albums.map((album) => [album.albumName, album.id]));
+  const newAlbums: Set<string> = new Set();
+  for (const { filepath } of assets) {
+    const albumName = getAlbumName(filepath, options);
+    if (albumName && !existingAlbums.has(albumName)) {
+      newAlbums.add(albumName);
+    }
+  }
+
+  if (dryRun) {
+    // TODO print asset counts for new albums
+    console.log(`Would have created ${newAlbums.size} new album${s(newAlbums.size)}`);
+    console.log(`Would have updated albums of ${assets.length} asset${s(assets.length)}`);
+    return;
+  }
+
+  const progressBar = new SingleBar(
+    { format: 'Creating albums | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} albums' },
+    Presets.shades_classic,
+  );
+  progressBar.start(newAlbums.size, 0);
+
+  try {
+    for (const albumNames of chunk([...newAlbums], concurrency)) {
+      const items = await Promise.all(
+        albumNames.map((albumName: string) => createAlbum({ createAlbumDto: { albumName } })),
+      );
+      for (const { id, albumName } of items) {
+        existingAlbums.set(albumName, id);
+      }
+      progressBar.increment(albumNames.length);
+    }
+  } finally {
+    progressBar.stop();
+  }
+
+  console.log(`Successfully created ${newAlbums.size} new album${s(newAlbums.size)}`);
+  console.log(`Successfully updated ${assets.length} asset${s(assets.length)}`);
+
+  const albumToAssets = new Map<string, string[]>();
+  for (const asset of assets) {
+    const albumName = getAlbumName(asset.filepath, options);
+    if (!albumName) {
+      continue;
+    }
+    const albumId = existingAlbums.get(albumName);
+    if (albumId) {
+      if (!albumToAssets.has(albumId)) {
+        albumToAssets.set(albumId, []);
+      }
+      albumToAssets.get(albumId)?.push(asset.id);
+    }
+  }
+
+  const albumUpdateProgress = new SingleBar(
+    { format: 'Adding assets to albums | {bar} | {percentage}% | ETA: {eta}s | {value}/{total} assets' },
+    Presets.shades_classic,
+  );
+  albumUpdateProgress.start(assets.length, 0);
+
+  try {
+    for (const [albumId, assets] of albumToAssets.entries()) {
+      for (const assetBatch of chunk(assets, Math.min(1000 * concurrency, 65_000))) {
+        await addAssetsToAlbum({ id: albumId, bulkIdsDto: { ids: assetBatch } });
+        albumUpdateProgress.increment(assetBatch.length);
+      }
+    }
+  } finally {
+    albumUpdateProgress.stop();
+  }
+};
+
+// `filepath` valid format:
+// - Windows: `D:\\test\\Filename.txt` or `D:/test/Filename.txt`
+// - Unix: `/test/Filename.txt`
+export const getAlbumName = (filepath: string, options: UploadOptionsDto) => {
+  return options.albumName ?? path.basename(path.dirname(filepath));
+};

cli/src/commands/auth.ts

@@ -0,0 +1,48 @@
+import { getMyUser } from '@immich/sdk';
+import { existsSync } from 'node:fs';
+import { mkdir, unlink } from 'node:fs/promises';
+import { BaseOptions, connect, getAuthFilePath, logError, withError, writeAuthFile } from 'src/utils';
+
+export const login = async (url: string, key: string, options: BaseOptions) => {
+  console.log(`Logging in to ${url}`);
+
+  const { configDirectory: configDir } = options;
+
+  await connect(url, key);
+
+  const [error, user] = await withError(getMyUser());
+  if (error) {
+    logError(error, 'Failed to load user info');
+    process.exit(1);
+  }
+
+  console.log(`Logged in as ${user.email}`);
+
+  if (!existsSync(configDir)) {
+    // Create config folder if it doesn't exist
+    const created = await mkdir(configDir, { recursive: true });
+    if (!created) {
+      console.log(`Failed to create config folder: ${configDir}`);
+      return;
+    }
+  }
+
+  await writeAuthFile(configDir, { url, key });
+
+  console.log(`Wrote auth info to ${getAuthFilePath(configDir)}`);
+};
+
+export const logout = async (options: BaseOptions) => {
+  console.log('Logging out...');
+
+  const { configDirectory: configDir } = options;
+
+  const authFile = getAuthFilePath(configDir);
+
+  if (existsSync(authFile)) {
+    await unlink(authFile);
+    console.log(`Removed auth file: ${authFile}`);
+  }
+
+  console.log('Successfully logged out');
+};

cli/src/commands/base-command.ts

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

cli/src/commands/login.ts

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

cli/src/commands/logout.command.ts

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

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

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

cli/src/commands/server-info.ts

@@ -0,0 +1,24 @@
+import { getAssetStatistics, getMyUser, getServerVersion, getSupportedMediaTypes } from '@immich/sdk';
+import { BaseOptions, authenticate } from 'src/utils';
+
+export const serverInfo = async (options: BaseOptions) => {
+  const { url } = await authenticate(options);
+
+  const [versionInfo, mediaTypes, stats, userInfo] = await Promise.all([
+    getServerVersion(),
+    getSupportedMediaTypes(),
+    getAssetStatistics({}),
+    getMyUser(),
+  ]);
+
+  console.log(`Server Info (via ${userInfo.email})`);
+  console.log(`  Url: ${url}`);
+  console.log(`  Version: ${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`);
+  console.log(`  Formats:`);
+  console.log(`    Images: ${mediaTypes.image.map((extension) => extension.replace('.', ''))}`);
+  console.log(`    Videos: ${mediaTypes.video.map((extension) => extension.replace('.', ''))}`);
+  console.log(`  Statistics:`);
+  console.log(`    Images: ${stats.images}`);
+  console.log(`    Videos: ${stats.videos}`);
+  console.log(`    Total: ${stats.total}`);
+};

cli/src/commands/upload.command.ts

@@ -1,287 +0,0 @@
-import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-import byteSize from 'byte-size';
-import cliProgress from 'cli-progress';
-import FormData from 'form-data';
-import fs, { ReadStream, createReadStream } from 'node:fs';
-import { CrawlService } from '../services/crawl.service';
-import { BaseCommand } from './base-command';
-import { basename } from 'node:path';
-import { access, constants, stat, unlink } from 'node:fs/promises';
-import { createHash } from 'node:crypto';
-import Os from 'os';
-
-class Asset {
-  readonly path: string;
-  readonly deviceId!: string;
-
-  deviceAssetId?: string;
-  fileCreatedAt?: string;
-  fileModifiedAt?: string;
-  sidecarPath?: string;
-  fileSize!: number;
-  albumName?: string;
-
-  constructor(path: string) {
-    this.path = path;
-  }
-
-  async prepare() {
-    const stats = await stat(this.path);
-    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
-    this.fileCreatedAt = stats.mtime.toISOString();
-    this.fileModifiedAt = stats.mtime.toISOString();
-    this.fileSize = stats.size;
-    this.albumName = this.extractAlbumName();
-  }
-
-  async getUploadFormData(): Promise<FormData> {
-    if (!this.deviceAssetId) throw new Error('Device asset id not set');
-    if (!this.fileCreatedAt) throw new Error('File created at not set');
-    if (!this.fileModifiedAt) throw new Error('File modified at not set');
-
-    // TODO: doesn't xmp replace the file extension? Will need investigation
-    const sideCarPath = `${this.path}.xmp`;
-    let sidecarData: ReadStream | undefined = undefined;
-    try {
-      await access(sideCarPath, constants.R_OK);
-      sidecarData = createReadStream(sideCarPath);
-    } catch (error) {}
-
-    const data: any = {
-      assetData: createReadStream(this.path),
-      deviceAssetId: this.deviceAssetId,
-      deviceId: 'CLI',
-      fileCreatedAt: this.fileCreatedAt,
-      fileModifiedAt: this.fileModifiedAt,
-      isFavorite: String(false),
-    };
-    const formData = new FormData();
-
-    for (const prop in data) {
-      formData.append(prop, data[prop]);
-    }
-
-    if (sidecarData) {
-      formData.append('sidecarData', sidecarData);
-    }
-
-    return formData;
-  }
-
-  async delete(): Promise<void> {
-    return unlink(this.path);
-  }
-
-  public async hash(): Promise<string> {
-    const sha1 = (filePath: string) => {
-      const hash = createHash('sha1');
-      return new Promise<string>((resolve, reject) => {
-        const rs = createReadStream(filePath);
-        rs.on('error', reject);
-        rs.on('data', (chunk) => hash.update(chunk));
-        rs.on('end', () => resolve(hash.digest('hex')));
-      });
-    };
-
-    return await sha1(this.path);
-  }
-
-  private extractAlbumName(): string {
-    if (Os.platform() === 'win32') {
-      return this.path.split('\\').slice(-2)[0];
-    } else {
-      return this.path.split('/').slice(-2)[0];
-    }
-  }
-}
-
-export class UploadOptionsDto {
-  recursive? = false;
-  exclusionPatterns?: string[] = [];
-  dryRun? = false;
-  skipHash? = false;
-  delete? = false;
-  album? = false;
-  albumName? = '';
-  includeHidden? = false;
-}
-
-export class UploadCommand extends BaseCommand {
-  uploadLength!: number;
-
-  public async run(paths: string[], options: UploadOptionsDto): Promise<void> {
-    await this.connect();
-
-    const formatResponse = await this.immichApi.serverInfoApi.getSupportedMediaTypes();
-    const crawlService = new CrawlService(formatResponse.data.image, formatResponse.data.video);
-
-    const inputFiles: string[] = [];
-    for (const pathArgument of paths) {
-      const fileStat = await fs.promises.lstat(pathArgument);
-      if (fileStat.isFile()) {
-        inputFiles.push(pathArgument);
-      }
-    }
-
-    const files: string[] = await crawlService.crawl({
-      pathsToCrawl: paths,
-      recursive: options.recursive,
-      exclusionPatterns: options.exclusionPatterns,
-      includeHidden: options.includeHidden,
-    });
-
-    files.push(...inputFiles);
-
-    if (files.length === 0) {
-      console.log('No assets found, exiting');
-      return;
-    }
-
-    const assetsToUpload = files.map((path) => new Asset(path));
-
-    const uploadProgress = new cliProgress.SingleBar(
-      {
-        format: '{bar} | {percentage}% | ETA: {eta_formatted} | {value_formatted}/{total_formatted}: {filename}',
-      },
-      cliProgress.Presets.shades_classic,
-    );
-
-    let totalSize = 0;
-    let sizeSoFar = 0;
-
-    let totalSizeUploaded = 0;
-    let uploadCounter = 0;
-
-    for (const asset of assetsToUpload) {
-      // Compute total size first
-      await asset.prepare();
-      totalSize += asset.fileSize;
-
-      if (options.albumName) {
-        asset.albumName = options.albumName;
-      }
-    }
-
-    const existingAlbums = (await this.immichApi.albumApi.getAllAlbums()).data;
-
-    uploadProgress.start(totalSize, 0);
-    uploadProgress.update({ value_formatted: 0, total_formatted: byteSize(totalSize) });
-
-    try {
-      for (const asset of assetsToUpload) {
-        uploadProgress.update({
-          filename: asset.path,
-        });
-
-        let skipUpload = false;
-
-        let skipAsset = false;
-        let existingAssetId: string | undefined = undefined;
-
-        if (!options.skipHash) {
-          const assetBulkUploadCheckDto = { assets: [{ id: asset.path, checksum: await asset.hash() }] };
-
-          const checkResponse = await this.immichApi.assetApi.checkBulkUpload({
-            assetBulkUploadCheckDto,
-          });
-
-          skipUpload = checkResponse.data.results[0].action === 'reject';
-
-          const isDuplicate = checkResponse.data.results[0].reason === 'duplicate';
-          if (isDuplicate) {
-            existingAssetId = checkResponse.data.results[0].assetId;
-          }
-
-          skipAsset = skipUpload && !isDuplicate;
-        }
-
-        if (!skipAsset) {
-          if (!options.dryRun) {
-            if (!skipUpload) {
-              const formData = await asset.getUploadFormData();
-              const res = await this.uploadAsset(formData);
-              existingAssetId = res.data.id;
-              uploadCounter++;
-              totalSizeUploaded += asset.fileSize;
-            }
-
-            if ((options.album || options.albumName) && asset.albumName !== undefined) {
-              let album = existingAlbums.find((album) => album.albumName === asset.albumName);
-              if (!album) {
-                const res = await this.immichApi.albumApi.createAlbum({
-                  createAlbumDto: { albumName: asset.albumName },
-                });
-                album = res.data;
-                existingAlbums.push(album);
-              }
-
-              if (existingAssetId) {
-                await this.immichApi.albumApi.addAssetsToAlbum({
-                  id: album.id,
-                  bulkIdsDto: { ids: [existingAssetId] },
-                });
-              }
-            }
-          }
-        }
-
-        sizeSoFar += asset.fileSize;
-
-        uploadProgress.update(sizeSoFar, { value_formatted: byteSize(sizeSoFar) });
-      }
-    } finally {
-      uploadProgress.stop();
-    }
-
-    let messageStart;
-    if (options.dryRun) {
-      messageStart = 'Would have';
-    } else {
-      messageStart = 'Successfully';
-    }
-
-    if (uploadCounter === 0) {
-      console.log('All assets were already uploaded, nothing to do.');
-    } else {
-      console.log(`${messageStart} uploaded ${uploadCounter} assets (${byteSize(totalSizeUploaded)})`);
-    }
-    if (options.delete) {
-      if (options.dryRun) {
-        console.log(`Would now have deleted assets, but skipped due to dry run`);
-      } else {
-        console.log('Deleting assets that have been uploaded...');
-        const deletionProgress = new cliProgress.SingleBar(cliProgress.Presets.shades_classic);
-        deletionProgress.start(files.length, 0);
-
-        for (const asset of assetsToUpload) {
-          if (!options.dryRun) {
-            await asset.delete();
-          }
-          deletionProgress.increment();
-        }
-        deletionProgress.stop();
-        console.log('Deletion complete');
-      }
-    }
-  }
-
-  private async uploadAsset(data: FormData): Promise<AxiosResponse> {
-    const url = this.immichApi.instanceUrl + '/asset/upload';
-
-    const config: AxiosRequestConfig = {
-      method: 'post',
-      maxRedirects: 0,
-      url,
-      headers: {
-        'x-api-key': this.immichApi.apiKey,
-        ...data.getHeaders(),
-      },
-      maxContentLength: Infinity,
-      maxBodyLength: Infinity,
-      data,
-    };
-
-    const res = await axios(config);
-    return res;
-  }
-}

cli/src/index.ts

@@ -1,30 +1,52 @@
 #! /usr/bin/env node
 import { Command, Option } from 'commander';
+import os from 'node:os';
 import path from 'node:path';
-import os from 'os';
+import { upload } from 'src/commands/asset';
+import { login, logout } from 'src/commands/auth';
+import { serverInfo } from 'src/commands/server-info';
 import { version } from '../package.json';
-import { LoginCommand } from './commands/login';
-import { LogoutCommand } from './commands/logout.command';
-import { ServerInfoCommand } from './commands/server-info.command';
-import { UploadCommand } from './commands/upload.command';
 
-const userHomeDir = os.homedir();
-const configDir = path.join(userHomeDir, '.config/immich/');
+const defaultConfigDirectory = path.join(os.homedir(), '.config/immich/');
 
 const program = new Command()
   .name('immich')
   .version(version)
   .description('Command line interface for Immich')
-  .addOption(new Option('-d, --config', 'Configuration directory').env('IMMICH_CONFIG_DIR').default(configDir));
+  .addOption(
+    new Option('-d, --config-directory <directory>', 'Configuration directory where auth.yml will be stored')
+      .env('IMMICH_CONFIG_DIR')
+      .default(defaultConfigDirectory),
+  )
+  .addOption(new Option('-u, --url [url]', 'Immich server URL').env('IMMICH_INSTANCE_URL'))
+  .addOption(new Option('-k, --key [key]', 'Immich API key').env('IMMICH_API_KEY'));
+
+program
+  .command('login')
+  .alias('login-key')
+  .description('Login using an API key')
+  .argument('url', 'Immich server URL')
+  .argument('key', 'Immich API key')
+  .action((url, key) => login(url, key, program.opts()));
+
+program
+  .command('logout')
+  .description('Remove stored credentials')
+  .action(() => logout(program.opts()));
+
+program
+  .command('server-info')
+  .description('Display server information')
+  .action(() => serverInfo(program.opts()));
 
 program
   .command('upload')
   .description('Upload assets')
-  .usage('[options] [paths...]')
+  .usage('[paths...] [options]')
   .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('-i, --ignore <pattern>', 'Pattern to ignore').env('IMMICH_IGNORE_PATHS'))
   .addOption(new Option('-h, --skip-hash', "Don't hash files before upload").env('IMMICH_SKIP_HASH').default(false))
-  .addOption(new Option('-i, --include-hidden', 'Include hidden folders').env('IMMICH_INCLUDE_HIDDEN').default(false))
+  .addOption(new Option('-H, --include-hidden', 'Include hidden folders').env('IMMICH_INCLUDE_HIDDEN').default(false))
   .addOption(
     new Option('-a, --album', 'Automatically create albums based on folder name')
       .env('IMMICH_AUTO_CREATE_ALBUM')
@@ -38,36 +60,16 @@ program
   .addOption(
     new Option('-n, --dry-run', "Don't perform any actions, just show what will be done")
       .env('IMMICH_DRY_RUN')
-      .default(false),
+      .default(false)
+      .conflicts('skipHash'),
+  )
+  .addOption(
+    new Option('-c, --concurrency <number>', 'Number of assets to upload at the same time')
+      .env('IMMICH_UPLOAD_CONCURRENCY')
+      .default(4),
   )
   .addOption(new Option('--delete', 'Delete local assets after upload').env('IMMICH_DELETE_ASSETS'))
   .argument('[paths...]', 'One or more paths to assets to be uploaded')
-  .action(async (paths, options) => {
-    options.exclusionPatterns = options.ignore;
-    await new UploadCommand(program.opts()).run(paths, options);
-  });
-
-program
-  .command('server-info')
-  .description('Display server information')
-  .action(async () => {
-    await new ServerInfoCommand(program.opts()).run();
-  });
-
-program
-  .command('login-key')
-  .description('Login using an API key')
-  .argument('[instanceUrl]')
-  .argument('[apiKey]')
-  .action(async (paths, options) => {
-    await new LoginCommand(program.opts()).run(paths, options);
-  });
-
-program
-  .command('logout')
-  .description('Remove stored credentials')
-  .action(async () => {
-    await new LogoutCommand(program.opts()).run();
-  });
+  .action((paths, options) => upload(paths, program.opts(), options));
 
 program.parse(process.argv);

cli/src/services/api.service.ts

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

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

@@ -1,278 +0,0 @@
-import mockfs from 'mock-fs';
-import { CrawlService, CrawlOptions } from './crawl.service';
-
-interface Test {
-  test: string;
-  options: CrawlOptions;
-  files: Record<string, boolean>;
-}
-
-const cwd = process.cwd();
-
-const tests: Test[] = [
-  {
-    test: 'should return empty when crawling an empty path list',
-    options: {
-      pathsToCrawl: [],
-    },
-    files: {},
-  },
-  {
-    test: 'should crawl a single folder',
-    options: {
-      pathsToCrawl: ['/photos/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-    },
-  },
-  {
-    test: 'should crawl a single file',
-    options: {
-      pathsToCrawl: ['/photos/image.jpg'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-    },
-  },
-  {
-    test: 'should crawl a single file and a folder',
-    options: {
-      pathsToCrawl: ['/photos/image.jpg', '/images/'],
-    },
-    files: {
-      '/photos/image.jpg': true,
-      '/images/image2.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/**'],
-      recursive: true,
-    },
-    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/'],
-      recursive: true,
-    },
-    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,
-    },
-  },
-  {
-    test: 'should support ignoring full filename',
-    options: {
-      pathsToCrawl: ['/photos'],
-      exclusionPatterns: ['**/image2.jpg'],
-    },
-    files: {
-      '/photos/image1.jpg': true,
-      '/photos/image2.jpg': false,
-      '/photos/image3.jpg': true,
-    },
-  },
-  {
-    test: 'should support ignoring file extensions',
-    options: {
-      pathsToCrawl: ['/photos'],
-      exclusionPatterns: ['**/*.png'],
-    },
-    files: {
-      '/photos/image1.jpg': true,
-      '/photos/image2.png': false,
-      '/photos/image3.jpg': true,
-    },
-  },
-  {
-    test: 'should support ignoring folder names',
-    options: {
-      pathsToCrawl: ['/photos'],
-      recursive: true,
-      exclusionPatterns: ['**/raw/**'],
-    },
-    files: {
-      '/photos/image1.jpg': true,
-      '/photos/image/image1.jpg': true,
-      '/photos/raw/image2.dng': false,
-      '/photos/raw/image3.dng': false,
-      '/photos/notraw/image3.jpg': true,
-    },
-  },
-  {
-    test: 'should support ignoring absolute paths',
-    options: {
-      pathsToCrawl: ['/'],
-      recursive: true,
-      exclusionPatterns: ['/images/**'],
-    },
-    files: {
-      '/photos/image1.jpg': true,
-      '/images/image2.jpg': false,
-      '/assets/image3.jpg': true,
-    },
-  },
-];
-
-describe(CrawlService.name, () => {
-  const sut = new CrawlService(
-    ['.jpg', '.jpeg', '.png', '.heif', '.heic', '.tif', '.nef', '.webp', '.tiff', '.dng', '.gif'],
-    ['.mov', '.mp4', '.webm'],
-  );
-
-  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,72 +0,0 @@
-import { glob } from 'glob';
-import * as fs from 'fs';
-
-export class CrawlOptions {
-  pathsToCrawl!: string[];
-  recursive? = false;
-  includeHidden? = false;
-  exclusionPatterns?: string[];
-}
-
-export class CrawlService {
-  private readonly extensions!: string[];
-
-  constructor(image: string[], video: string[]) {
-    this.extensions = image.concat(video).map((extension) => extension.replace('.', ''));
-  }
-
-  async crawl(options: CrawlOptions): Promise<string[]> {
-    const { recursive, pathsToCrawl, exclusionPatterns, includeHidden } = options;
-
-    if (!pathsToCrawl) {
-      return Promise.resolve([]);
-    }
-
-    const patterns: string[] = [];
-    const crawledFiles: string[] = [];
-
-    for await (const currentPath of pathsToCrawl) {
-      try {
-        const stats = await fs.promises.stat(currentPath);
-        if (stats.isFile() || stats.isSymbolicLink()) {
-          crawledFiles.push(currentPath);
-        } else {
-          patterns.push(currentPath);
-        }
-      } catch (error: any) {
-        if (error.code === 'ENOENT') {
-          patterns.push(currentPath);
-        } else {
-          throw error;
-        }
-      }
-    }
-
-    let searchPattern: string;
-    if (patterns.length === 1) {
-      searchPattern = patterns[0];
-    } else if (patterns.length === 0) {
-      return crawledFiles;
-    } else {
-      searchPattern = '{' + patterns.join(',') + '}';
-    }
-
-    if (recursive) {
-      searchPattern = searchPattern + '/**/';
-    }
-
-    searchPattern = `${searchPattern}/*.{${this.extensions.join(',')}}`;
-
-    const globbedFiles = await glob(searchPattern, {
-      absolute: true,
-      nocase: true,
-      nodir: true,
-      dot: includeHidden,
-      ignore: exclusionPatterns,
-    });
-
-    const returnedFiles = crawledFiles.concat(globbedFiles);
-    returnedFiles.sort();
-    return returnedFiles;
-  }
-}

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

@@ -1,109 +0,0 @@
-import { SessionService } from './session.service';
-import fs from 'node:fs';
-import yaml from 'yaml';
-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 = vi.fn(() => Promise.resolve({ data: { res: 'pong' } }));
-const mockUserInfo = vi.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
-
-vi.mock('@immich/sdk', async () => ({
-  ...(await vi.importActual('@immich/sdk')),
-  UserApi: vi.fn().mockImplementation(() => {
-    return { getMyUserInfo: mockUserInfo };
-  }),
-  ServerInfoApi: vi.fn().mockImplementation(() => {
-    return { pingServer: mockPingServer };
-  }),
-}));
-
-describe('SessionService', () => {
-  let sessionService: SessionService;
-
-  beforeEach(() => {
-    deleteAuthFile();
-    sessionService = new SessionService(TEST_CONFIG_DIR);
-  });
-
-  afterEach(() => {
-    deleteAuthFile();
-  });
-
-  it('should connect to immich', async () => {
-    await createTestAuthFile(
-      JSON.stringify({
-        apiKey: TEST_IMMICH_API_KEY,
-        instanceUrl: TEST_IMMICH_INSTANCE_URL,
-      }),
-    );
-
-    await sessionService.connect();
-    expect(mockPingServer).toHaveBeenCalledTimes(1);
-  });
-
-  it('should error if no auth file exists', async () => {
-    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,
-      }),
-    );
-    await sessionService.connect().catch((error) => {
-      expect(error.message).toEqual(`Instance URL missing in auth config file ${TEST_AUTH_FILE}`);
-    });
-  });
-
-  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(`API key missing in auth config file ${TEST_AUTH_FILE}`);
-  });
-
-  it('should create auth file when logged in', async () => {
-    await sessionService.login(TEST_IMMICH_INSTANCE_URL, TEST_IMMICH_API_KEY);
-
-    const data: string = await readTestAuthFile();
-    const authConfig = yaml.parse(data);
-    expect(authConfig.instanceUrl).toBe(TEST_IMMICH_INSTANCE_URL);
-    expect(authConfig.apiKey).toBe(TEST_IMMICH_API_KEY);
-  });
-
-  it('should delete auth file when logging out', async () => {
-    const consoleSpy = spyOnConsole();
-
-    await createTestAuthFile(
-      JSON.stringify({
-        apiKey: TEST_IMMICH_API_KEY,
-        instanceUrl: TEST_IMMICH_INSTANCE_URL,
-      }),
-    );
-    await sessionService.logout();
-
-    await fs.promises.access(TEST_AUTH_FILE, fs.constants.F_OK).catch((error) => {
-      expect(error.message).toContain('ENOENT');
-    });
-
-    expect(consoleSpy.mock.calls).toEqual([
-      ['Logging out...'],
-      [`Removed auth file ${TEST_AUTH_FILE}`],
-      ['Successfully logged out'],
-    ]);
-  });
-});

cli/src/services/session.service.ts

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

cli/src/utils.spec.ts

@@ -0,0 +1,298 @@
+import mockfs from 'mock-fs';
+import { readFileSync } from 'node:fs';
+import { CrawlOptions, crawl } from 'src/utils';
+
+interface Test {
+  test: string;
+  options: Omit<CrawlOptions, 'extensions'>;
+  files: Record<string, boolean>;
+}
+
+const cwd = process.cwd();
+
+const readContent = (path: string) => {
+  return readFileSync(path).toString();
+};
+
+const extensions = [
+  '.jpg',
+  '.jpeg',
+  '.png',
+  '.heif',
+  '.heic',
+  '.tif',
+  '.nef',
+  '.webp',
+  '.tiff',
+  '.dng',
+  '.gif',
+  '.mov',
+  '.mp4',
+  '.webm',
+];
+
+const tests: Test[] = [
+  {
+    test: 'should return empty when crawling an empty path list',
+    options: {
+      pathsToCrawl: [],
+    },
+    files: {},
+  },
+  {
+    test: 'should crawl a single folder',
+    options: {
+      pathsToCrawl: ['/photos/'],
+    },
+    files: {
+      '/photos/image.jpg': true,
+    },
+  },
+  {
+    test: 'should crawl a single file',
+    options: {
+      pathsToCrawl: ['/photos/image.jpg'],
+    },
+    files: {
+      '/photos/image.jpg': true,
+    },
+  },
+  {
+    test: 'should crawl a single file and a folder',
+    options: {
+      pathsToCrawl: ['/photos/image.jpg', '/images/'],
+    },
+    files: {
+      '/photos/image.jpg': true,
+      '/images/image2.jpg': true,
+    },
+  },
+  {
+    test: 'should exclude by file extension',
+    options: {
+      pathsToCrawl: ['/photos/'],
+      exclusionPattern: '**/*.tif',
+    },
+    files: {
+      '/photos/image.jpg': true,
+      '/photos/image.tif': false,
+    },
+  },
+  {
+    test: 'should exclude by file extension without case sensitivity',
+    options: {
+      pathsToCrawl: ['/photos/'],
+      exclusionPattern: '**/*.TIF',
+    },
+    files: {
+      '/photos/image.jpg': true,
+      '/photos/image.tif': false,
+    },
+  },
+  {
+    test: 'should exclude by folder',
+    options: {
+      pathsToCrawl: ['/photos/'],
+      exclusionPattern: '**/raw/**',
+      recursive: true,
+    },
+    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/'],
+      recursive: true,
+    },
+    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,
+    },
+  },
+  {
+    test: 'should support ignoring full filename',
+    options: {
+      pathsToCrawl: ['/photos'],
+      exclusionPattern: '**/image2.jpg',
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image2.jpg': false,
+      '/photos/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring file extensions',
+    options: {
+      pathsToCrawl: ['/photos'],
+      exclusionPattern: '**/*.png',
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image2.png': false,
+      '/photos/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring folder names',
+    options: {
+      pathsToCrawl: ['/photos'],
+      recursive: true,
+      exclusionPattern: '**/raw/**',
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/photos/image/image1.jpg': true,
+      '/photos/raw/image2.dng': false,
+      '/photos/raw/image3.dng': false,
+      '/photos/notraw/image3.jpg': true,
+    },
+  },
+  {
+    test: 'should support ignoring absolute paths',
+    options: {
+      // Currently, fast-glob has some caveat when dealing with `/`.
+      pathsToCrawl: ['/*s'],
+      recursive: true,
+      exclusionPattern: '/images/**',
+    },
+    files: {
+      '/photos/image1.jpg': true,
+      '/images/image2.jpg': false,
+      '/assets/image3.jpg': true,
+    },
+  },
+];
+
+describe('crawl', () => {
+  afterEach(() => {
+    mockfs.restore();
+  });
+
+  describe('crawl', () => {
+    for (const { test, options, files } of tests) {
+      it(test, async () => {
+        // The file contents is the same as the path.
+        mockfs(Object.fromEntries(Object.keys(files).map((file) => [file, file])));
+
+        const actual = await crawl({ ...options, extensions });
+        const expected = Object.entries(files)
+          .filter((entry) => entry[1])
+          .map(([file]) => file);
+
+        // Compare file's content instead of path since a file can be represent in multiple ways.
+        expect(actual.map((path) => readContent(path)).sort()).toEqual(expected.sort());
+      });
+    }
+  });
+});

cli/src/utils.ts

@@ -0,0 +1,178 @@
+import { getMyUser, init, isHttpError } from '@immich/sdk';
+import { convertPathToPattern, glob } from 'fast-glob';
+import { createHash } from 'node:crypto';
+import { createReadStream } from 'node:fs';
+import { readFile, stat, writeFile } from 'node:fs/promises';
+import { platform } from 'node:os';
+import { join, resolve } from 'node:path';
+import yaml from 'yaml';
+
+export interface BaseOptions {
+  configDirectory: string;
+  key?: string;
+  url?: string;
+}
+
+export type AuthDto = { url: string; key: string };
+type OldAuthDto = { instanceUrl: string; apiKey: string };
+
+export const authenticate = async (options: BaseOptions): Promise<AuthDto> => {
+  const { configDirectory: configDir, url, key } = options;
+
+  // provided in command
+  if (url && key) {
+    return connect(url, key);
+  }
+
+  // fallback to auth file
+  const config = await readAuthFile(configDir);
+  const auth = await connect(config.url, config.key);
+  if (auth.url !== config.url) {
+    await writeAuthFile(configDir, auth);
+  }
+
+  return auth;
+};
+
+export const connect = async (url: string, key: string) => {
+  const wellKnownUrl = new URL('.well-known/immich', url);
+  try {
+    const wellKnown = await fetch(wellKnownUrl).then((response) => response.json());
+    const endpoint = new URL(wellKnown.api.endpoint, url).toString();
+    if (endpoint !== url) {
+      console.debug(`Discovered API at ${endpoint}`);
+    }
+    url = endpoint;
+  } catch {
+    // noop
+  }
+
+  init({ baseUrl: url, apiKey: key });
+
+  const [error] = await withError(getMyUser());
+  if (isHttpError(error)) {
+    logError(error, 'Failed to connect to server');
+    process.exit(1);
+  }
+
+  return { url, key };
+};
+
+export const logError = (error: unknown, message: string) => {
+  if (isHttpError(error)) {
+    console.error(`${message}: ${error.status}`);
+    console.error(JSON.stringify(error.data, undefined, 2));
+  } else {
+    console.error(`${message} - ${error}`);
+  }
+};
+
+export const getAuthFilePath = (dir: string) => join(dir, 'auth.yml');
+
+export const readAuthFile = async (dir: string) => {
+  try {
+    const data = await readFile(getAuthFilePath(dir));
+    // TODO add class-transform/validation
+    const auth = yaml.parse(data.toString()) as AuthDto | OldAuthDto;
+    const { instanceUrl, apiKey } = auth as OldAuthDto;
+    if (instanceUrl && apiKey) {
+      return { url: instanceUrl, key: apiKey };
+    }
+    return auth as AuthDto;
+  } catch (error: Error | any) {
+    if (error.code === 'ENOENT' || error.code === 'ENOTDIR') {
+      console.log('No auth file exists. Please login first.');
+      process.exit(1);
+    }
+    throw error;
+  }
+};
+
+export const writeAuthFile = async (dir: string, auth: AuthDto) =>
+  writeFile(getAuthFilePath(dir), yaml.stringify(auth), { mode: 0o600 });
+
+export const withError = async <T>(promise: Promise<T>): Promise<[Error, undefined] | [undefined, T]> => {
+  try {
+    const result = await promise;
+    return [undefined, result];
+  } catch (error: Error | any) {
+    return [error, undefined];
+  }
+};
+
+export interface CrawlOptions {
+  pathsToCrawl: string[];
+  recursive?: boolean;
+  includeHidden?: boolean;
+  exclusionPattern?: string;
+  extensions: string[];
+}
+
+const convertPathToPatternOnWin = (path: string) => {
+  return platform() === 'win32' ? convertPathToPattern(path) : path;
+};
+
+export const crawl = async (options: CrawlOptions): Promise<string[]> => {
+  const { extensions: extensionsWithPeriod, recursive, pathsToCrawl, exclusionPattern, includeHidden } = options;
+  const extensions = extensionsWithPeriod.map((extension) => extension.replace('.', ''));
+
+  if (pathsToCrawl.length === 0) {
+    return [];
+  }
+
+  const patterns: string[] = [];
+  const crawledFiles: string[] = [];
+
+  for await (const currentPath of pathsToCrawl) {
+    try {
+      const absolutePath = resolve(currentPath);
+      const stats = await stat(absolutePath);
+      if (stats.isFile() || stats.isSymbolicLink()) {
+        crawledFiles.push(absolutePath);
+      } else {
+        patterns.push(convertPathToPatternOnWin(absolutePath));
+      }
+    } catch (error: any) {
+      if (error.code === 'ENOENT') {
+        patterns.push(convertPathToPatternOnWin(currentPath));
+      } else {
+        throw error;
+      }
+    }
+  }
+
+  let searchPattern: string;
+  if (patterns.length === 1) {
+    searchPattern = patterns[0];
+  } else if (patterns.length === 0) {
+    return crawledFiles;
+  } else {
+    searchPattern = '{' + patterns.join(',') + '}';
+  }
+
+  if (recursive) {
+    searchPattern = searchPattern + '/**/';
+  }
+
+  searchPattern = `${searchPattern}/*.{${extensions.join(',')}}`;
+
+  const globbedFiles = await glob(searchPattern, {
+    absolute: true,
+    caseSensitiveMatch: false,
+    onlyFiles: true,
+    dot: includeHidden,
+    ignore: [`**/${exclusionPattern}`],
+  });
+  globbedFiles.push(...crawledFiles);
+  return globbedFiles.sort();
+};
+
+export const sha1 = (filepath: string) => {
+  const hash = createHash('sha1');
+  return new Promise<string>((resolve, reject) => {
+    const rs = createReadStream(filepath);
+    rs.on('error', reject);
+    rs.on('data', (chunk) => hash.update(chunk));
+    rs.on('end', () => resolve(hash.digest('hex')));
+  });
+};

cli/src/version.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/test/cli-test-utils.ts

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

@@ -1,42 +0,0 @@
-import { restoreTempFolder, testApp } from '@test-utils';
-import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
-import { LoginCommand } from '../../src/commands/login';
-
-describe(`login-key (e2e)`, () => {
-  let apiKey: string;
-  let instanceUrl: string;
-
-  spyOnConsole();
-
-  beforeAll(async () => {
-    await testApp.create();
-    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();
-
-    const api = await setup();
-    apiKey = api.apiKey;
-  });
-
-  it('should error when providing an invalid API key', async () => {
-    await expect(new LoginCommand(CLI_BASE_OPTIONS).run(instanceUrl, 'invalid')).rejects.toThrow(
-      `Failed to connect to server ${instanceUrl}: Request failed with status code 401`,
-    );
-  });
-
-  it('should log in when providing the correct API key', async () => {
-    await new LoginCommand(CLI_BASE_OPTIONS).run(instanceUrl, apiKey);
-  });
-});

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

@@ -1,34 +0,0 @@
-import { restoreTempFolder, testApp } from '@test-utils';
-import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
-import { ServerInfoCommand } from '../../src/commands/server-info.command';
-
-describe(`server-info (e2e)`, () => {
-  const consoleSpy = spyOnConsole();
-
-  beforeAll(async () => {
-    await testApp.create();
-  });
-
-  afterAll(async () => {
-    await testApp.teardown();
-    await restoreTempFolder();
-  });
-
-  beforeEach(async () => {
-    await testApp.reset();
-    await restoreTempFolder();
-    const api = await setup();
-    process.env.IMMICH_API_KEY = api.apiKey;
-  });
-
-  it('should show server version', async () => {
-    await new ServerInfoCommand(CLI_BASE_OPTIONS).run();
-
-    expect(consoleSpy.mock.calls).toEqual([
-      [expect.stringMatching(new RegExp('Server Version: \\d+.\\d+.\\d+'))],
-      [expect.stringMatching('Image Types: .*')],
-      [expect.stringMatching('Video Types: .*')],
-      ['Statistics:\n  Images: 0\n  Videos: 0\n  Total: 0'],
-    ]);
-  });
-});

cli/test/e2e/setup.ts

@@ -1,42 +0,0 @@
-import path from 'path';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { access } from 'fs/promises';
-
-export default async () => {
-  let IMMICH_TEST_ASSET_PATH: string = '';
-
-  if (process.env.IMMICH_TEST_ASSET_PATH === undefined) {
-    IMMICH_TEST_ASSET_PATH = path.normalize(`${__dirname}/../../../server/test/assets/`);
-    process.env.IMMICH_TEST_ASSET_PATH = IMMICH_TEST_ASSET_PATH;
-  } else {
-    IMMICH_TEST_ASSET_PATH = process.env.IMMICH_TEST_ASSET_PATH;
-  }
-
-  const directoryExists = async (dirPath: string) =>
-    await access(dirPath)
-      .then(() => true)
-      .catch(() => false);
-
-  if (!(await directoryExists(`${IMMICH_TEST_ASSET_PATH}/albums`))) {
-    throw new Error(
-      `Test assets not found. Please checkout https://github.com/immich-app/test-assets into ${IMMICH_TEST_ASSET_PATH} before testing`,
-    );
-  }
-
-  if (process.env.DB_HOSTNAME === undefined) {
-    // DB hostname not set which likely means we're not running e2e through docker compose. Start a local postgres container.
-    const pg = await new PostgreSqlContainer('tensorchord/pgvecto-rs:pg14-v0.1.11')
-      .withExposedPorts(5432)
-      .withDatabase('immich')
-      .withUsername('postgres')
-      .withPassword('postgres')
-      .withReuse()
-      .start();
-
-    process.env.DB_URL = pg.getConnectionUri();
-  }
-
-  process.env.NODE_ENV = 'development';
-  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/e2e/jobs/immich-e2e-config.json`);
-  process.env.TZ = 'Z';
-};

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

@@ -1,79 +0,0 @@
-import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from '@test-utils';
-import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
-import { UploadCommand } from '../../src/commands/upload.command';
-import { ImmichApi } from '../../src/services/api.service';
-
-describe(`upload (e2e)`, () => {
-  let api: ImmichApi;
-
-  spyOnConsole();
-
-  beforeAll(async () => {
-    await testApp.create();
-  });
-
-  afterAll(async () => {
-    await testApp.teardown();
-    await restoreTempFolder();
-  });
-
-  beforeEach(async () => {
-    await testApp.reset();
-    await restoreTempFolder();
-    api = await setup();
-    process.env.IMMICH_API_KEY = api.apiKey;
-  });
-
-  it('should upload a folder recursively', async () => {
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
-    const { data: assets } = await api.assetApi.getAllAssets({}, { headers: { 'x-api-key': api.apiKey } });
-    expect(assets.length).toBeGreaterThan(4);
-  });
-
-  it('should not create a new album', async () => {
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
-    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
-    expect(albums.length).toEqual(0);
-  });
-
-  it('should create album from folder name', async () => {
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
-      recursive: true,
-      album: true,
-    });
-
-    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
-    expect(albums.length).toEqual(1);
-    const natureAlbum = albums[0];
-    expect(natureAlbum.albumName).toEqual('nature');
-  });
-
-  it('should add existing assets to album', async () => {
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
-      recursive: true,
-    });
-
-    // upload again, but this time add to album
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
-      recursive: true,
-      album: true,
-    });
-
-    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
-    expect(albums.length).toEqual(1);
-    const natureAlbum = albums[0];
-    expect(natureAlbum.albumName).toEqual('nature');
-  });
-
-  it('should upload to the specified album name', async () => {
-    await new UploadCommand(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
-      recursive: true,
-      albumName: 'testAlbum',
-    });
-
-    const { data: albums } = await api.albumApi.getAllAlbums({}, { headers: { 'x-api-key': api.apiKey } });
-    expect(albums.length).toEqual(1);
-    const testAlbum = albums[0];
-    expect(testAlbum.albumName).toEqual('testAlbum');
-  });
-});

cli/test/e2e/vitest.config.ts

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

cli/test/global-setup.js

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

cli/testSetup.js

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

cli/tsconfig.build.json

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

cli/tsconfig.json

@@ -9,26 +9,14 @@
     "experimentalDecorators": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
-    "target": "es2021",
+    "target": "es2022",
     "sourceMap": true,
     "outDir": "./dist",
     "incremental": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
-    "rootDirs": ["src", "../server/src"],
     "baseUrl": "./",
-    "paths": {
-      "@test": ["../server/test"],
-      "@test/*": ["../server/test/*"],
-      "@test-utils": ["../server/src/test-utils/utils"],
-      "@app/immich": ["../server/src/immich"],
-      "@app/immich/*": ["../server/src/immich/*"],
-      "@app/infra": ["../server/src/infra"],
-      "@app/infra/*": ["../server/src/infra/*"],
-      "@app/domain": ["../server/src/domain"],
-      "@app/domain/*": ["../server/src/domain/*"]
-    },
     "types": ["vitest/globals"]
   },
-  "exclude": ["dist", "node_modules", "upload"]
+  "exclude": ["dist", "node_modules"]
 }

cli/vite.config.ts

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

deployment/.gitignore

@@ -0,0 +1,38 @@
+# OpenTofu
+
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# Terragrunt
+
+# terragrunt cache directories
+**/.terragrunt-cache/*
+
+# Terragrunt debug output file (when using `--terragrunt-debug` option)
+# See: https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-debug
+terragrunt-debug.tfvars.json

deployment/modules/cloudflare/docs-release/.terraform.lock.hcl

@@ -0,0 +1,38 @@
+# This file is maintained automatically by "tofu init".
+# Manual edits may be lost in future updates.
+
+provider "registry.opentofu.org/cloudflare/cloudflare" {
+  version     = "4.36.0"
+  constraints = "4.36.0"
+  hashes = [
+    "h1:00/Y+l17VV4RquGSfwDnYsGYzyf2ZmdQwUgeIzXC7eg=",
+    "h1:489GpKItA/VRIUA5S4+F8MsnurGVciRvUFyIV81MJTU=",
+    "h1:7cnczyKGj3+gvaJ0r5JIVWLXPbQfkHYejac76MJx+I8=",
+    "h1:8rmr1PjJc14Xmor2eEvo5/WBojylt1eYdx6VbSU3Ulo=",
+    "h1:HjgphNjtgny5tkcUAQoGgBdcuQ+0IyhL8yLsiBqWAP0=",
+    "h1:LH3umxdBnJcAyeVoBLVn+PC0F0CzN6v9UN6lb6CqQPE=",
+    "h1:Xx6WUD/zB8fM9SjkFx06Fgx2K7aGJIVvsJS2pwqALEM=",
+    "h1:YizL5YN9zQ8YkSR6V/G201YrCVdnkF9EUIK4lpROWiA=",
+    "h1:aPcXVGjYcCJdqvWSzc/dEjwj05LnbWZje8IanygVjcI=",
+    "h1:eKCvfashdCqfDcFGXE2gq+XxAURD5SzuaQ9Brs3zLos=",
+    "h1:gpKcBYkBcfn/uF1A8W7MD/OysMZW7EU4QVYvPEEnxGc=",
+    "h1:kCkcxZZnkKAnMz9scUQHb19d9/l9FPOHovAyrvtA618=",
+    "h1:t8mXXnICTeKqoD29uvyLFHVWMfMzTUrJuHje8lpI0zU=",
+    "h1:zjzavjIdLDGRYsWd3v0HJz6ul12Cewj9RW/cqAQ4DxI=",
+    "zh:02665712b3893307596b3caab99cf1f2502d5caca18e22d4b37bb535e628e102",
+    "zh:1514b0d3ef62934484ac471113ee68cddec0c21e56b4f710922741fe9b6e6fdf",
+    "zh:1fab4dfcecbcea13267b42e5ff05ba0692aa2dcb247b8e633fea0daf49feb156",
+    "zh:24d8367295fe1f1b2be37802aecb96edf32f743364663ffe781d1bb92438395d",
+    "zh:34e84e7940c99dcf65663cfd25afac22bf5c8a5ff2cd21900c67180d3a072be9",
+    "zh:3d71d63204a329acf1d1de8638f2c725243cb94cf444d2d7acde54b3d1ac1696",
+    "zh:57831ba88e779a762bcfa224ba9eac8bc22ef9cd70cd541d848b351e0ba6a75c",
+    "zh:6407560f2e548afcb4852c91efc664627a9ee565c31a9c81fc9ea1806fca0567",
+    "zh:738ddbc664d75f4859aa09444a27809bc398795a8ea8f5be8531040690287712",
+    "zh:841ca2b2d78b6f8d33ec3435bc090c5e04a3a7d85c80df11227a7ea00d36f6b1",
+    "zh:890df766e9b839623b1f0437355032a3c006226a6c200cd911e15ee1a9014e9f",
+    "zh:8b3d3d63354032ab9b2403c50728e9aa4e83c7367eaad2d18794221addeafc0f",
+    "zh:9e293443fe3127e488f540229983c1b9688268185f87567bb3d18e794697acd2",
+    "zh:b3a22439156e46461213db183e2e89569cd2e8d7cbcfc4b9f90469090e105807",
+    "zh:f430feb5d51891e84028459e57039045dea4f1f5fcf671161d8ac2d8f28763f3",
+  ]
+}

deployment/modules/cloudflare/docs-release/config.tf

@@ -0,0 +1,11 @@
+terraform {
+  backend "pg" {}
+  required_version = "~> 1.7"
+
+  required_providers {
+    cloudflare = {
+      source = "cloudflare/cloudflare"
+      version = "4.36.0"
+    }
+  }
+}

deployment/modules/cloudflare/docs-release/domain.tf

@@ -0,0 +1,14 @@
+resource "cloudflare_pages_domain" "immich_app_release_domain" {
+  account_id   = var.cloudflare_account_id
+  project_name = data.terraform_remote_state.cloudflare_account.outputs.immich_app_archive_pages_project_name
+  domain       = "immich.app"
+}
+
+resource "cloudflare_record" "immich_app_release_domain" {
+  name = "immich.app"
+  proxied = true
+  ttl = 1
+  type = "CNAME"
+  value = data.terraform_remote_state.cloudflare_immich_app_docs.outputs.immich_app_branch_pages_hostname
+  zone_id = data.terraform_remote_state.cloudflare_account.outputs.immich_app_zone_id
+}

deployment/modules/cloudflare/docs-release/providers.tf

@@ -0,0 +1,3 @@
+provider "cloudflare" {
+  api_token = data.terraform_remote_state.api_keys_state.outputs.terraform_key_cloudflare_docs
+}

deployment/modules/cloudflare/docs-release/remote-state.tf

@@ -0,0 +1,27 @@
+data "terraform_remote_state" "api_keys_state" {
+  backend = "pg"
+
+  config = {
+    conn_str = var.tf_state_postgres_conn_str
+    schema_name = "prod_cloudflare_api_keys"
+  }
+}
+
+data "terraform_remote_state" "cloudflare_account" {
+  backend = "pg"
+
+  config = {
+    conn_str = var.tf_state_postgres_conn_str
+    schema_name = "prod_cloudflare_account"
+  }
+}
+
+data "terraform_remote_state" "cloudflare_immich_app_docs" {
+  backend = "pg"
+
+  config = {
+    conn_str = var.tf_state_postgres_conn_str
+    schema_name = "prod_cloudflare_immich_app_docs_${var.prefix_name}"
+  }
+}
+

deployment/modules/cloudflare/docs-release/terragrunt.hcl

@@ -0,0 +1,20 @@
+terraform {
+  source = "."
+
+  extra_arguments custom_vars {
+    commands = get_terraform_commands_that_need_vars()
+  }
+}
+
+include {
+  path = find_in_parent_folders("state.hcl")
+}
+
+remote_state {
+  backend = "pg"
+
+  config = {
+    conn_str = get_env("TF_STATE_POSTGRES_CONN_STR")
+    schema_name = "prod_cloudflare_immich_app_docs_release"
+  }
+}

deployment/modules/cloudflare/docs-release/variables.tf

@@ -0,0 +1,4 @@
+variable "cloudflare_account_id" {}
+variable "tf_state_postgres_conn_str" {}
+
+variable "prefix_name" {}

deployment/modules/cloudflare/docs/.terraform.lock.hcl

@@ -0,0 +1,38 @@
+# This file is maintained automatically by "tofu init".
+# Manual edits may be lost in future updates.
+
+provider "registry.opentofu.org/cloudflare/cloudflare" {
+  version     = "4.36.0"
+  constraints = "4.36.0"
+  hashes = [
+    "h1:00/Y+l17VV4RquGSfwDnYsGYzyf2ZmdQwUgeIzXC7eg=",
+    "h1:489GpKItA/VRIUA5S4+F8MsnurGVciRvUFyIV81MJTU=",
+    "h1:7cnczyKGj3+gvaJ0r5JIVWLXPbQfkHYejac76MJx+I8=",
+    "h1:8rmr1PjJc14Xmor2eEvo5/WBojylt1eYdx6VbSU3Ulo=",
+    "h1:HjgphNjtgny5tkcUAQoGgBdcuQ+0IyhL8yLsiBqWAP0=",
+    "h1:LH3umxdBnJcAyeVoBLVn+PC0F0CzN6v9UN6lb6CqQPE=",
+    "h1:Xx6WUD/zB8fM9SjkFx06Fgx2K7aGJIVvsJS2pwqALEM=",
+    "h1:YizL5YN9zQ8YkSR6V/G201YrCVdnkF9EUIK4lpROWiA=",
+    "h1:aPcXVGjYcCJdqvWSzc/dEjwj05LnbWZje8IanygVjcI=",
+    "h1:eKCvfashdCqfDcFGXE2gq+XxAURD5SzuaQ9Brs3zLos=",
+    "h1:gpKcBYkBcfn/uF1A8W7MD/OysMZW7EU4QVYvPEEnxGc=",
+    "h1:kCkcxZZnkKAnMz9scUQHb19d9/l9FPOHovAyrvtA618=",
+    "h1:t8mXXnICTeKqoD29uvyLFHVWMfMzTUrJuHje8lpI0zU=",
+    "h1:zjzavjIdLDGRYsWd3v0HJz6ul12Cewj9RW/cqAQ4DxI=",
+    "zh:02665712b3893307596b3caab99cf1f2502d5caca18e22d4b37bb535e628e102",
+    "zh:1514b0d3ef62934484ac471113ee68cddec0c21e56b4f710922741fe9b6e6fdf",
+    "zh:1fab4dfcecbcea13267b42e5ff05ba0692aa2dcb247b8e633fea0daf49feb156",
+    "zh:24d8367295fe1f1b2be37802aecb96edf32f743364663ffe781d1bb92438395d",
+    "zh:34e84e7940c99dcf65663cfd25afac22bf5c8a5ff2cd21900c67180d3a072be9",
+    "zh:3d71d63204a329acf1d1de8638f2c725243cb94cf444d2d7acde54b3d1ac1696",
+    "zh:57831ba88e779a762bcfa224ba9eac8bc22ef9cd70cd541d848b351e0ba6a75c",
+    "zh:6407560f2e548afcb4852c91efc664627a9ee565c31a9c81fc9ea1806fca0567",
+    "zh:738ddbc664d75f4859aa09444a27809bc398795a8ea8f5be8531040690287712",
+    "zh:841ca2b2d78b6f8d33ec3435bc090c5e04a3a7d85c80df11227a7ea00d36f6b1",
+    "zh:890df766e9b839623b1f0437355032a3c006226a6c200cd911e15ee1a9014e9f",
+    "zh:8b3d3d63354032ab9b2403c50728e9aa4e83c7367eaad2d18794221addeafc0f",
+    "zh:9e293443fe3127e488f540229983c1b9688268185f87567bb3d18e794697acd2",
+    "zh:b3a22439156e46461213db183e2e89569cd2e8d7cbcfc4b9f90469090e105807",
+    "zh:f430feb5d51891e84028459e57039045dea4f1f5fcf671161d8ac2d8f28763f3",
+  ]
+}

deployment/modules/cloudflare/docs/config.tf

@@ -0,0 +1,11 @@
+terraform {
+  backend "pg" {}
+  required_version = "~> 1.7"
+
+  required_providers {
+    cloudflare = {
+      source = "cloudflare/cloudflare"
+      version = "4.36.0"
+    }
+  }
+}

deployment/modules/cloudflare/docs/domain.tf

@@ -0,0 +1,26 @@
+resource "cloudflare_pages_domain" "immich_app_branch_domain" {
+  account_id   = var.cloudflare_account_id
+  project_name = local.is_release ? data.terraform_remote_state.cloudflare_account.outputs.immich_app_archive_pages_project_name : data.terraform_remote_state.cloudflare_account.outputs.immich_app_preview_pages_project_name
+  domain       = "${var.prefix_name}.${local.deploy_domain_prefix}.immich.app"
+}
+
+resource "cloudflare_record" "immich_app_branch_subdomain" {
+  name    = "${var.prefix_name}.${local.deploy_domain_prefix}.immich.app"
+  proxied = true
+  ttl     = 1
+  type    = "CNAME"
+  value   = "${replace(var.prefix_name, "/\\/|\\./", "-")}.${local.is_release ? data.terraform_remote_state.cloudflare_account.outputs.immich_app_archive_pages_project_subdomain : data.terraform_remote_state.cloudflare_account.outputs.immich_app_preview_pages_project_subdomain}"
+  zone_id = data.terraform_remote_state.cloudflare_account.outputs.immich_app_zone_id
+}
+
+output "immich_app_branch_subdomain" {
+  value = cloudflare_record.immich_app_branch_subdomain.hostname
+}
+
+output "immich_app_branch_pages_hostname" {
+  value = cloudflare_record.immich_app_branch_subdomain.value
+}
+
+output "pages_project_name" {
+  value = cloudflare_pages_domain.immich_app_branch_domain.project_name
+}

deployment/modules/cloudflare/docs/locals.tf

@@ -0,0 +1,7 @@
+locals {
+  domain_name = "immich.app"
+  preview_prefix = contains(["branch", "pr"], var.prefix_event_type) ? "preview" : ""
+  archive_prefix = contains(["release"], var.prefix_event_type) ? "archive" : ""
+  deploy_domain_prefix = coalesce(local.preview_prefix, local.archive_prefix)
+  is_release = contains(["release"], var.prefix_event_type)
+}

deployment/modules/cloudflare/docs/providers.tf

@@ -0,0 +1,3 @@
+provider "cloudflare" {
+  api_token = data.terraform_remote_state.api_keys_state.outputs.terraform_key_cloudflare_docs
+}

deployment/modules/cloudflare/docs/remote-state.tf

@@ -0,0 +1,17 @@
+data "terraform_remote_state" "api_keys_state" {
+  backend = "pg"
+
+  config = {
+    conn_str = var.tf_state_postgres_conn_str
+    schema_name = "prod_cloudflare_api_keys"
+  }
+}
+
+data "terraform_remote_state" "cloudflare_account" {
+  backend = "pg"
+
+  config = {
+    conn_str = var.tf_state_postgres_conn_str
+    schema_name = "prod_cloudflare_account"
+  }
+}

deployment/modules/cloudflare/docs/terragrunt.hcl

@@ -0,0 +1,24 @@
+terraform {
+  source = "."
+
+  extra_arguments custom_vars {
+    commands = get_terraform_commands_that_need_vars()
+  }
+}
+
+include {
+  path = find_in_parent_folders("state.hcl")
+}
+
+locals {
+  prefix_name = get_env("TF_VAR_prefix_name")
+}
+
+remote_state {
+  backend = "pg"
+
+  config = {
+    conn_str = get_env("TF_STATE_POSTGRES_CONN_STR")
+    schema_name = "prod_cloudflare_immich_app_docs_${local.prefix_name}"
+  }
+}

deployment/modules/cloudflare/docs/variables.tf

@@ -0,0 +1,5 @@
+variable "cloudflare_account_id" {}
+variable "tf_state_postgres_conn_str" {}
+
+variable "prefix_name" {}
+variable "prefix_event_type" {}

deployment/state.hcl

@@ -0,0 +1,20 @@
+locals {
+  cloudflare_account_id = get_env("CLOUDFLARE_ACCOUNT_ID")
+  cloudflare_api_token  = get_env("CLOUDFLARE_API_TOKEN")
+
+  tf_state_postgres_conn_str = get_env("TF_STATE_POSTGRES_CONN_STR")
+}
+
+remote_state {
+  backend = "pg"
+
+  config = {
+    conn_str = local.tf_state_postgres_conn_str
+  }
+}
+
+inputs = {
+  cloudflare_account_id      = local.cloudflare_account_id
+  cloudflare_api_token       = local.cloudflare_api_token
+  tf_state_postgres_conn_str = local.tf_state_postgres_conn_str
+}