Version v1.63.2

* fix(server): Share link with expire creation time error

* better

.github/workflows/build-mobile.yml

@@ -45,7 +45,7 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.7.3"
+          flutter-version: "3.10.0"
           cache: true
 
       - name: Create the Keystore

.github/workflows/docker-cleanup.yml

@@ -0,0 +1,79 @@
+# This workflow runs on certain conditions to check for and potentially
+# delete container images from the GHCR which no longer have an associated
+# code branch.
+# Requires a PAT with the correct scope set in the secrets.
+#
+# This workflow will not trigger runs on forked repos.
+
+name: Cleanup Old Docker Images
+
+on:
+  pull_request:
+    types:
+      - "closed"
+  push:
+    paths:
+      - ".github/workflows/docker-cleanup.yml"
+
+concurrency:
+  group: registry-tags-cleanup
+  cancel-in-progress: false
+
+jobs:
+  cleanup-images:
+    name: Cleanup Stale Images Tags for ${{ matrix.primary-name }}
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - primary-name: "immich-server"
+          - primary-name: "immich-machine-learning"
+          - primary-name: "immich-web"
+          - primary-name: "immich-proxy"
+    env:
+      # Requires a personal access token with the OAuth scope delete:packages
+      TOKEN: ${{ secrets.PACKAGE_DELETE_TOKEN }}
+    steps:
+      -
+        name: Clean temporary images
+        if: "${{ env.TOKEN != '' }}"
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.1.0
+        with:
+          token: "${{ env.TOKEN }}"
+          owner: "immich-app"
+          is_org: "true"
+          do_delete: "true"
+          package_name: "${{ matrix.primary-name }}"
+          scheme: "pull_request"
+          repo_name: "immich"
+          match_regex: '^pr-(\d+)$|^(\d+)$'
+
+  cleanup-untagged-images:
+    name: Cleanup Untagged Images Tags for ${{ matrix.primary-name }}
+    runs-on: ubuntu-22.04
+    needs:
+      - cleanup-images
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - primary-name: "immich-server"
+          - primary-name: "immich-machine-learning"
+          - primary-name: "immich-web"
+          - primary-name: "immich-proxy"
+          - primary-name: "immich-build-cache"
+    env:
+      # Requires a personal access token with the OAuth scope delete:packages
+      TOKEN: ${{ secrets.PACKAGE_DELETE_TOKEN }}
+    steps:
+      -
+        name: Clean untagged images
+        if: "${{ env.TOKEN != '' }}"
+        uses: stumpylog/image-cleaner-action/untagged@v0.1.0
+        with:
+          token: "${{ env.TOKEN }}"
+          owner: "immich-app"
+          do_delete: "true"
+          is_org: "true"
+          package_name: "${{ matrix.primary-name }}"

.github/workflows/docker.yml

@@ -42,10 +42,10 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.1.0
+        uses: docker/setup-qemu-action@v2.2.0
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2.5.0
+        uses: docker/setup-buildx-action@v2.7.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
@@ -100,7 +100,7 @@ jobs:
           fi
 
       - name: Build and push image
-        uses: docker/build-push-action@v4.0.0
+        uses: docker/build-push-action@v4.1.1
         with:
           context: ${{ matrix.context }}
           platforms: ${{ matrix.platforms }}

.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.7.3'
+          channel: "stable"
+          flutter-version: "3.10.0"
 
       - name: Install dependencies
         run: dart pub get
@@ -32,4 +32,3 @@ jobs:
       - name: Run dart analyze
         run: dart analyze --fatal-infos
         working-directory: ./mobile
-

.github/workflows/test.yml

@@ -21,6 +21,28 @@ jobs:
       - name: Run Immich Server E2E Test
         run: docker-compose -f ./docker/docker-compose.test.yml --env-file ./docker/.env.test up --abort-on-container-exit --exit-code-from immich-server-test
 
+  doc-tests:
+    name: Run documentation checks
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run npm install
+        run: npm ci
+
+      - name: Run formatter
+        run: npm run format
+        if: ${{ !cancelled() }}
+
+      - name: Run tsc
+        run: npm run check
+        if: ${{ !cancelled() }}
+
   server-unit-tests:
     name: Run server unit test suites and checks
     runs-on: ubuntu-latest
@@ -74,7 +96,11 @@ jobs:
         if: ${{ !cancelled() }}
 
       - name: Run svelte checks
-        run: npm run check
+        run: npm run check:svelte
+        if: ${{ !cancelled() }}
+
+      - name: Run tsc
+        run: npm run check:typescript
         if: ${{ !cancelled() }}
 
       - name: Run unit tests & coverage
@@ -90,10 +116,10 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.7.3"
+          flutter-version: "3.10.0"
       - name: Run tests
         working-directory: ./mobile
-        run: flutter test
+        run: flutter test -j 1
 
   generated-api-up-to-date:
     name: Check generated files are up-to-date
@@ -101,7 +127,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run API generation
-        run: cd server && npm ci && npm run api:generate
+        run: npm --prefix server run api:generate
       - name: Find file changes
         uses: tj-actions/verify-changed-files@v13.1
         id: verify-changed-files
@@ -136,24 +162,18 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Install server dependencies
-        run: |
-          cd server
-          npm ci
+        run: npm --prefix server ci
       - name: Run existing migrations
-        run: |
-          cd server
-          npm run typeorm:migrations:run
+        run: npm --prefix server run typeorm:migrations:run
       - name: Generate new migrations
         continue-on-error: true
-        run: |
-          cd server
-          npm run typeorm:migrations:generate ./libs/infra/src/migrations/TestMigration
+        run: npm --prefix server run typeorm:migrations:generate ./src/infra/migrations/TestMigration
       - name: Find file changes
         uses: tj-actions/verify-changed-files@v13.1
         id: verify-changed-files
         with:
           files: |
-            server/libs/infra/src/migrations/
+            server/src/infra/migrations/
       - name: Verify files have not changed
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |

.vscode/launch.json

@@ -9,6 +9,15 @@
       "name": "Immich Server",
       "remoteRoot": "/usr/src/app",
       "localRoot": "${workspaceFolder}/server"
+    },
+    {
+      "type": "node",
+      "request": "attach",
+      "restart": true,
+      "port": 9231,
+      "name": "Immich Microservices",
+      "remoteRoot": "/usr/src/app",
+      "localRoot": "${workspaceFolder}/server"
     }
   ]
 }

Makefile

@@ -1,17 +1,17 @@
 dev:
-	rm -rf ./server/dist && docker-compose -f ./docker/docker-compose.dev.yml up --remove-orphans
+	docker-compose -f ./docker/docker-compose.dev.yml up --remove-orphans
 
 dev-new:
-	rm -rf ./server/dist && docker compose -f ./docker/docker-compose.dev.yml up --remove-orphans
+	docker compose -f ./docker/docker-compose.dev.yml up --remove-orphans
 
 dev-new-update:
-	rm -rf ./server/dist && docker compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
+	docker compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
 
 dev-update:
-	rm -rf ./server/dist && docker-compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
+	docker-compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
 
 dev-scale:
-	rm -rf ./server/dist && docker-compose -f ./docker/docker-compose.dev.yml up --build -V  --scale immich-server=3 --remove-orphans
+	docker-compose -f ./docker/docker-compose.dev.yml up --build -V  --scale immich-server=3 --remove-orphans
 
 stage:
 	docker-compose -f ./docker/docker-compose.staging.yml up --build -V --remove-orphans

README.md

@@ -37,7 +37,6 @@
 - [Installation](https://immich.app/docs/install/requirements)
 - [Contribution Guidelines](https://immich.app/docs/overview/support-the-project)
 - [Support The Project](#support-the-project)
-- [Known Issues](#known-issues)
 
 ## Documentation
 
@@ -61,25 +60,31 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 
 # Features
 
-| Features                                    | Mobile | Web |
-| ------------------------------------------- | ------ | --- |
-| Upload and view videos and photos           | Yes    | Yes |
-| Auto backup when the app is opened          | Yes    | N/A |
-| Selective album(s) for backup               | Yes    | N/A |
-| Download photos and videos to local device  | Yes    | Yes |
-| Multi-user support                          | Yes    | Yes |
-| Album and Shared albums                     | Yes    | Yes |
-| Scrubbable/draggable scrollbar              | Yes    | Yes |
-| Support RAW (HEIC, HEIF, DNG, Apple ProRaw) | Yes    | Yes |
-| Metadata view (EXIF, map)                   | Yes    | Yes |
-| Search by metadata, objects and CLIP  | Yes    | No  |
-| Administrative functions (user management)  | N/A    | Yes |
-| Background backup                           | Yes    | N/A |
-| Virtual scroll                              | Yes    | Yes |
-| OAuth support                               | Yes    | Yes |
-| LivePhoto backup and playback               | iOS    | Yes |
-| User-defined storage structure              | Yes    | Yes |
-| Public Sharing                              | N/A    | Yes |
+| Features                                     | Mobile | Web |
+| -------------------------------------------- | ------ | --- |
+| Upload and view videos and photos            | Yes    | Yes |
+| Auto backup when the app is opened           | Yes    | N/A |
+| Selective album(s) for backup                | Yes    | N/A |
+| Download photos and videos to local device   | Yes    | Yes |
+| Multi-user support                           | Yes    | Yes |
+| Album and Shared albums                      | Yes    | Yes |
+| Scrubbable/draggable scrollbar               | Yes    | Yes |
+| Support RAW (HEIC, HEIF, DNG, Apple ProRaw)  | Yes    | Yes |
+| Metadata view (EXIF, map)                    | Yes    | Yes |
+| Search by metadata, objects, faces, and CLIP | Yes    | Yes |
+| Administrative functions (user management)   | No     | Yes |
+| Background backup                            | Yes    | N/A |
+| Virtual scroll                               | Yes    | Yes |
+| OAuth support                                | Yes    | Yes |
+| API Keys                                     | N/A    | Yes |
+| LivePhoto backup and playback                | iOS    | Yes |
+| User-defined storage structure               | Yes    | Yes |
+| Public Sharing                               | No     | Yes |
+| Archive and Favorites                        | Yes    | Yes |
+| Global Map                                   | No     | Yes |
+| Partner Sharing                              | Yes    | Yes |
+| Facial recognition and clustering            | No     | Yes |
+| Offline support                              | Yes    | No  |
 
 # Support the project
 
@@ -96,11 +101,3 @@ If you feel like this is the right cause and the app is something you are seeing
 - [Librepay](https://liberapay.com/alex.tran1502/)
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
-
-# Known Issues
-
-## immich-machine-learning fails to start
-
-Symptoms: the container logs `illegal instruction core dump` and restarts
-
-Solution: https://immich.app/docs/install/requirements#hardware

dev-setup.md

@@ -1,32 +0,0 @@
-# Development Setup
-
-## Lint / format extensions
-
-Setting these in the IDE give a better developer experience auto-formatting code on save and providing instant feedback on lint issues.
-
-### VSCode
-Install Prettier, ESLint and Svelte extensions.
-
-in User `settings.json` (`cmd + shift + p` and search for Open User Settings JSON) add the following:
-
-```json
-{
-  "editor.formatOnSave": true,
-  "[javascript][typescript][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"]
-}
-```
-
-## Running tests / checks
-
-In both server and web:
-`npm run check:all`

docker/.env.test

@@ -10,12 +10,7 @@ REDIS_HOSTNAME=immich-redis-test
 # Upload File Config
 UPLOAD_LOCATION=./upload
 
-# MAPBOX
-## ENABLE_MAPBOX is either true of false -> if true, you have to provide MAPBOX_KEY
-ENABLE_MAPBOX=false
-
 # WEB
-MAPBOX_KEY=
 VITE_SERVER_ENDPOINT=http://localhost:2283/api
 
 TYPESENSE_ENABLED=false

docker/docker-compose.dev.yml

@@ -35,8 +35,7 @@ services:
     ports:
       - 3003:3003
     volumes:
-      - ../machine-learning/src:/usr/src/app
-      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+      - ../machine-learning/app:/usr/src/app
       - model-cache:/cache
     env_file:
       - .env
@@ -53,13 +52,15 @@ services:
       context: ../server
       dockerfile: Dockerfile
       target: builder
-    command: npm run start:dev microservices
+    command: npm run start:debug microservices
     volumes:
       - ../server:/usr/src/app
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - /usr/src/app/node_modules
     env_file:
       - .env
+    ports:
+      - 9231:9230
     environment:
       - NODE_ENV=development
     depends_on:
@@ -93,7 +94,7 @@ services:
 
   typesense:
     container_name: immich_typesense
-    image: typesense/typesense:0.24.0
+    image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
     environment:
       - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
       - TYPESENSE_DATA_DIR=/data
@@ -104,11 +105,11 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
 
   database:
     container_name: immich_postgres
-    image: postgres:14
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env
     environment:
@@ -133,10 +134,9 @@ services:
       dockerfile: Dockerfile
     ports:
       - 2283:8080
-    logging:
-      driver: none
     depends_on:
       - immich-server
+      - immich-web
     restart: always
 
 volumes:

docker/docker-compose.test.yml

@@ -25,12 +25,12 @@ services:
       - immich-test-network
   immich-redis-test:
     container_name: immich-redis-test
-    image: redis:6.2
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
     networks:
       - immich-test-network
   immich-database-test:
     container_name: immich-database-test
-    image: postgres:14
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env.test
     environment:

docker/docker-compose.yml

@@ -3,8 +3,8 @@ version: "3.8"
 services:
   immich-server:
     container_name: immich_server
-    image: ghcr.io/immich-app/immich-server:release
-    entrypoint: ["/bin/sh", "./start-server.sh"]
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "immich" ]
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
     env_file:
@@ -17,8 +17,8 @@ services:
 
   immich-microservices:
     container_name: immich_microservices
-    image: ghcr.io/immich-app/immich-server:release
-    entrypoint: ["/bin/sh", "./start-microservices.sh"]
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "microservices" ]
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
     env_file:
@@ -31,9 +31,8 @@ services:
 
   immich-machine-learning:
     container_name: immich_machine_learning
-    image: ghcr.io/immich-app/immich-machine-learning:release
+    image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
     volumes:
-      - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - model-cache:/cache
     env_file:
       - .env
@@ -41,15 +40,14 @@ services:
 
   immich-web:
     container_name: immich_web
-    image: ghcr.io/immich-app/immich-web:release
-    entrypoint: ["/bin/sh", "./entrypoint.sh"]
+    image: ghcr.io/immich-app/immich-web:${IMMICH_VERSION:-release}
     env_file:
       - .env
     restart: always
 
   typesense:
     container_name: immich_typesense
-    image: typesense/typesense:0.24.0
+    image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
     environment:
       - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
       - TYPESENSE_DATA_DIR=/data
@@ -61,12 +59,12 @@ services:
 
   redis:
     container_name: immich_redis
-    image: redis:6.2
+    image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
     restart: always
 
   database:
     container_name: immich_postgres
-    image: postgres:14
+    image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
     env_file:
       - .env
     environment:
@@ -80,17 +78,16 @@ services:
 
   immich-proxy:
     container_name: immich_proxy
-    image: ghcr.io/immich-app/immich-proxy:release
+    image: ghcr.io/immich-app/immich-proxy:${IMMICH_VERSION:-release}
     environment:
       # Make sure these values get passed through from the env file
       - IMMICH_SERVER_URL
       - IMMICH_WEB_URL
     ports:
       - 2283:8080
-    logging:
-      driver: none
     depends_on:
       - immich-server
+      - immich-web
     restart: always
 
 volumes:

docker/example.env

@@ -2,6 +2,8 @@
 # Database
 ###################################################################################
 
+# NOTE: The following four database variables support Docker secrets by adding a *_FILE suffix to the variable name
+# See the docker-compose documentation on secrets for additional details: https://docs.docker.com/compose/compose-file/compose-file-v3/#secrets
 DB_HOSTNAME=immich_postgres
 DB_USERNAME=postgres
 DB_PASSWORD=postgres
@@ -50,11 +52,11 @@ TYPESENSE_API_KEY=some-random-text
 # TYPESENSE_URL uses base64 encoding for the nodes json.
 # Example JSON that was used:
 # [
-#      { 'host': 'typesense-1.example.net', 'port': '443', 'protocol': 'https' },
-#      { 'host': 'typesense-2.example.net', 'port': '443', 'protocol': 'https' },
-#      { 'host': 'typesense-3.example.net', 'port': '443', 'protocol': 'https' },
-#  ]
-# TYPESENSE_URL=ha://WwogICAgeyAnaG9zdCc6ICd0eXBlc2Vuc2UtMS5leGFtcGxlLm5ldCcsICdwb3J0JzogJzQ0MycsICdwcm90b2NvbCc6ICdodHRwcycgfSwKICAgIHsgJ2hvc3QnOiAndHlwZXNlbnNlLTIuZXhhbXBsZS5uZXQnLCAncG9ydCc6ICc0NDMnLCAncHJvdG9jb2wnOiAnaHR0cHMnIH0sCiAgICB7ICdob3N0JzogJ3R5cGVzZW5zZS0zLmV4YW1wbGUubmV0JywgJ3BvcnQnOiAnNDQzJywgJ3Byb3RvY29sJzogJ2h0dHBzJyB9LApd
+#      { "host": "typesense-1.example.net", "port": "443", "protocol": "https" },
+#      { "host": "typesense-2.example.net", "port": "443", "protocol": "https" },
+#      { "host": "typesense-3.example.net", "port": "443", "protocol": "https" },
+# ]
+# TYPESENSE_URL=ha://WwogIHsgImhvc3QiOiAidHlwZXNlbnNlLTEuZXhhbXBsZS5uZXQiLCAicG9ydCI6ICI0NDMiLCAicHJvdG9jb2wiOiAiaHR0cHMiIH0sCiAgeyAiaG9zdCI6ICJ0eXBlc2Vuc2UtMi5leGFtcGxlLm5ldCIsICJwb3J0IjogIjQ0MyIsICJwcm90b2NvbCI6ICJodHRwcyIgfSwKICB7ICJob3N0IjogInR5cGVzZW5zZS0zLmV4YW1wbGUubmV0IiwgInBvcnQiOiAiNDQzIiwgInByb3RvY29sIjogImh0dHBzIiB9Cl0=
 
 ###################################################################################
 # Reverse Geocoding
@@ -103,3 +105,12 @@ IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3003
 ####################################################################################
 
 #IMMICH_API_URL_EXTERNAL=http://localhost:3001
+
+###################################################################################
+# Immich Version - Optional
+#
+# This allows all immich docker images to be pinned to a specific version. By default,
+# the version is "release" but could be a specific version, like "v1.59.0".
+###################################################################################
+
+#IMMICH_VERSION=

docs/.prettierignore

@@ -0,0 +1,2 @@
+build/
+.docusaurus/

docs/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 120,
+  "semi": true
+}

docs/blog/release-1.36/index.mdx

@@ -33,9 +33,8 @@ The motion part will now be uploaded and can be played on the mobile app and the
   src="https://media.giphy.com/media/fTrGceZd7t1ewi8ESc/giphy.gif"
   width="100%"
   style={{
-    borderRadius: "10px",
-    boxShadow:
-      "rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px",
+    borderRadius: '10px',
+    boxShadow: 'rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px',
   }}
   title="LivePhoto playback on the web"
 />
@@ -73,9 +72,8 @@ The web will have the option to sign in with OAuth.
   width="50%"
   title="Web Sign in with OAuth"
   style={{
-    borderRadius: "10px",
-    boxShadow:
-      "rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px",
+    borderRadius: '10px',
+    boxShadow: 'rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px',
   }}
 />
 
@@ -86,9 +84,8 @@ sign-in button.
   src="https://media.giphy.com/media/3iy3SaNkVYtlkEiw06/giphy.gif"
   title="Mobile sign in with OAuth"
   style={{
-    borderRadius: "10px",
-    boxShadow:
-      "rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px",
+    borderRadius: '10px',
+    boxShadow: 'rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px',
   }}
 />
 
@@ -98,9 +95,8 @@ sign-in button.
   src="https://media.giphy.com/media/LStqgGESXW8XnuCv5y/giphy.gif"
   width="300"
   style={{
-    borderRadius: "10px",
-    boxShadow:
-      "rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px",
+    borderRadius: '10px',
+    boxShadow: 'rgba(9, 30, 66, 0.25) 0px 1px 1px, rgba(9, 30, 66, 0.13) 0px 0px 1px 1px',
   }}
   title="Support the project"
 />

docs/docs/FAQ.md

@@ -22,11 +22,11 @@ The initial approach of Immich is to become a backup tool, primarily for mobile
 
 ### Why does my uploaded photo show up with the wrong date or time in Immich?
 
-When a photo is initially uploaded Immich uses the create date of the file to determine where it belongs in the timeline. After that, background jobs will run that extract [exif metadata](https://en.wikipedia.org/wiki/Exif), including the CreateDate, to provide a more accurate date for the photo. If that is not available it will fallback to the modified date. If you want to ensure your photo has the right date, check the exif metadata before uploading. 
+When a photo is initially uploaded Immich uses the create date of the file to determine where it belongs in the timeline. After that, background jobs will run that extract [exif metadata](https://en.wikipedia.org/wiki/Exif), including the CreateDate, to provide a more accurate date for the photo. If that is not available it will fallback to the modified date. If you want to ensure your photo has the right date, check the exif metadata before uploading.
 
-If the timezone is incorrect in an uploaded photo, check the ``DateTimeOriginal`` exif field of the uploaded file. Immich uses the very competent library [exiftool-vendored.js](https://github.com/photostructure/exiftool-vendored.js#dates) to handle timezone parsing, but in some cases (like photos taken with DSLR cameras) it has to fallback on the local timezone. If you are using docker, this fallback will be UTC. (Note that even the photo backup app that can't be named [has the same bug!](https://photo.stackexchange.com/a/126978)) In Immich, it is possible to change this assumed fallback timezone system-wide by setting the timezone in the microservices docker container. You might need to run the "Extract Metadata" job after to effect the change. 
+If the timezone is incorrect in an uploaded photo, check the `DateTimeOriginal` exif field of the uploaded file. Immich uses the very competent library [exiftool-vendored.js](https://github.com/photostructure/exiftool-vendored.js#dates) to handle timezone parsing, but in some cases (like photos taken with DSLR cameras) it has to fallback on the local timezone. If you are using docker, this fallback will be UTC. (Note that even the photo backup app that can't be named [has the same bug!](https://photo.stackexchange.com/a/126978)) In Immich, it is possible to change this assumed fallback timezone system-wide by setting the timezone in the microservices docker container. You might need to run the "Extract Metadata" job after to effect the change.
 
-As an example, the following modification of ```docker-compose.yml``` will set the timezone of the microservices container to be ``Europe/Stockholm``
+As an example, the following modification of `docker-compose.yml` will set the timezone of the microservices container to be `Europe/Stockholm`
 
 ```
     environment:
@@ -34,16 +34,27 @@ As an example, the following modification of ```docker-compose.yml``` will set t
 ```
 
 ### Why are only photos and not videos being uploaded to Immich?
+
 This often happens when using a reverse proxy or cloudflare tunnel in front of Immich. Make sure to set your reverse proxy to allow large POST requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Cloudflare tunnels are limited to 100 mb file sizes.
 
 ### Why is Immich slow on low-memory systems like the Raspberry Pi?
+
 Immich uses optional machine-learning features to enhance search results. This feature, however, can be too heavy to run on a Raspberry Pi. To disable machine learning, comment out the `immich-machine-learning` section of your docker-compose.yml and set `IMMICH_MACHINE_LEARNING_URL=false` in your .env file.
 
+### How to disable machine-learning and TypeSense?
+
+:::warning
+Disabling both will result in poor search experience and typesense utilizes CLIP embeddings which are generated by machine-learning.
+:::
+
+These features can be disabled by commenting out `immich-typesense` and `immich-machine-learning` sections of the docker-compose.yml and setting `IMMICH_MACHINE_LEARNING_URL=false` & `TYPESENSE_ENABLED=false` in your .env file.
+
 ### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
 
 Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
 
 ### In the uploads folder, why are photos stored in the wrong date?
+
 This is fixed by running the storage migration job.
 
 ### Why is object detection not very good?
@@ -66,6 +77,10 @@ The non-root user/group needs read/write access to the volume mounts, including
 
 The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.
 
+### How can I backup data from Immich?
+
+See [backup and restore](/docs/administration/backup-and-restore.md).
+
 ### How can I **purge** data from Immich?
 
 Data for Immich comes in two forms:
@@ -83,4 +98,4 @@ After removing the the containers and volumes, the **Files** can be cleaned up (
 
 ### Why iOS app shows duplicate photos on the timeline while the web doesn't?
 
-If you are using `My Photo Stream`, the Photos app temporarily creates duplicates of photos taken in the last 30 days. These photos are included in the `Recents` album and thus shown up twice. To fix this, you can disable `My Photo Stream` in the native Photos app or choose a different album in the backup screen in Immich.
+If you are using `My Photo Stream`, the Photos app temporarily creates duplicates of photos taken in the last 30 days. These photos are included in the `Recents` album and thus shown up twice. To fix this, you can disable `My Photo Stream` in the native Photos app or choose a different album in the backup screen in Immich.

docs/docs/administration/_category_.json

@@ -1,5 +1,4 @@
 {
-    "label": "Administration",
-    "position": 4
-  }
-  
+  "label": "Administration",
+  "position": 4
+}

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

@@ -0,0 +1,63 @@
+# Backup and Restore
+
+## Database
+
+:::info
+Refer to the official [postgres documentation](https://www.postgresql.org/docs/current/backup.html) for details about backing up and restoring a postgres database.
+:::
+
+The recommended way to backup and restore the Immich database is to use the `pg_dumpall` command.
+
+```bash title='Backup'
+docker exec -t immich_postgres pg_dumpall -c -U postgres | gzip > "/path/to/backup/dump.sql.gz"
+```
+
+```bash title='Restore'
+docker-compose down -v  # CAUTION! Deletes all Immich data to start from scratch.
+docker-compose pull     # Update to latest version of Immich (if desired)
+docker-compose create   # Create Docker containers for Immich apps without running them.
+docker start immich_postgres    # Start Postgres server
+sleep 10    # Wait for Postgres server to start up
+gunzip < "/path/to/backup/dump.sql.gz" | docker exec -i immich_postgres psql -U postgres -d immich    # Restore Backup
+docker-compose up -d    # Start remainder of Immich apps
+```
+
+Note that for the database restore to proceed properly, it requires a completely fresh install (i.e. the Immich server has never run since creating the Docker containers). If the Immich app has run, Postgres conflicts may be encountered upon database restoration (relation already exists, violated foreign key constraints, multiple primary keys, etc.).
+
+The database dumps can also be automated (using [this image](https://github.com/prodrigestivill/docker-postgres-backup-local)) by editing the docker compose file to match the following:
+
+```yaml
+services:
+  ...
+  backup:
+    container_name: immich_db_dumper
+    image: prodrigestivill/postgres-backup-local
+    env_file:
+      - .env
+    environment:
+      POSTGRES_HOST: database
+      POSTGRES_DB: ${DB_DATABASE_NAME}
+      POSTGRES_USER: ${DB_USERNAME}
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      SCHEDULE: "@daily"
+      BACKUP_NUM_KEEP: 7
+      BACKUP_DIR: /db_dumps
+    volumes:
+      - ./db_dumps:/db_dumps
+    depends_on:
+      - database
+```
+
+Then you can restore with the same command but pointed at the latest dump.
+
+```bash title='Automated Restore'
+gunzip < db_dumps/last/immich-latest.sql.gz | docker exec -i immich_postgres psql -U postgres -d immich
+```
+
+## Filesystem
+
+Immich stores two types of content in the filesystem: (1) original, unmodified content, and (2) generated content. Only the original content needs to be backed-up, which includes the following folders:
+
+1. `UPLOAD_LOCATION/library`
+1. `UPLOAD_LOCATION/upload`
+1. `UPLOAD_LOCATION/profile`

docs/docs/developer/architecture.md

@@ -36,7 +36,6 @@ Immich is a full-stack [TypeScript](https://www.typescriptlang.org/) application
 - [Redis](https://redis.io/) for job queuing.
 - [Typesense](https://typesense.org/) for search.
 
-
 ### Web Server
 
 - [NGINX](https://www.nginx.com/) for internal communication between containers and load balancing when scaling.

docs/docs/developer/database-migrations.md

@@ -0,0 +1,14 @@
+# Database Migrations
+
+After making any changes in the `server/src/infra/database/entities`, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.
+
+1. Run the command
+
+```bash
+npm run typeorm:migrations:generate ./src/infra/<migration-name>
+```
+
+2. Check if the migration file makes sense.
+3. Move the migration file to folder `./src/infra/database/migrations` in your code editor.
+
+The server will automatically detect `*.ts` file changes and restart. Part of the server start-up process includes running any new migrations, so it will be applied immediately.

docs/docs/developer/open-api.md

@@ -1,7 +1,17 @@
----
-sidebar_position: 5
----
-
 # Open API
 
 Immich uses the [Open API](https://swagger.io/specification/) standard to generate API documentation. To view the published docs see [here](/docs/api).
+
+## Generator
+
+OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). When you add a new or modify an existing endpoint, you must run the command below to update the client SDK.
+
+```bash
+npm run api:generate # Run from the `server/` directory
+```
+
+You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
+
+:::tip
+This can also be run via `make api` from the project root directory (not in the `server` folder)
+:::

docs/docs/developer/pr-checklist.md

@@ -1,16 +1,8 @@
----
-sidebar_position: 3
----
-
-# Contributing
-
-Contributions are welcome!
-
-## PR Checklist
+# PR Checklist
 
 When contributing code through a pull request, please check the following:
 
-### Web Checks
+## Web Checks
 
 - [ ] `npm run lint` (linting via ESLint)
 - [ ] `npm run format` (formatting via Prettier)
@@ -21,7 +13,7 @@ When contributing code through a pull request, please check the following:
 Run all web checks with `npm run check:all`
 :::
 
-### Server Checks
+## Server Checks
 
 - [ ] `npm run lint` (linting via ESLint)
 - [ ] `npm run format` (formatting via Prettier)
@@ -32,12 +24,10 @@ Run all web checks with `npm run check:all`
 Run all server checks with `npm run check:all`
 :::
 
-### Open API
+## Open API
 
-The Open API client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file.
+The Open API client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. See [Open API](/docs/developer/open-api.md) for more details.
 
-- [ ] `npm run api:generate`
+## Database Migrations
 
-:::tip
-This can also be run via `make api` from the project root directory (not in the `server` folder)
-:::
+A database migration needs to be generated whenever there are changes to `server/src/infra/src/entities`. See [Database Migration](/docs/developer/database-migrations.md) for more details.

docs/docs/developer/setup.md

@@ -10,9 +10,9 @@ sidebar_position: 2
 
 This environment includes the following services:
 
-- Core server - `/server/apps/immich`
+- Core server - `/server/src/immich`
 - Machine learning - `/machine-learning`
-- Microservices - `/server/apps/microservicess`
+- Microservices - `/server/src/microservicess`
 - Web app - `/web`
 - Redis
 - PostgreSQL development database with exposed port `5432` so you can use any database client to acess it
@@ -92,27 +92,3 @@ in User `settings.json` (`cmd + shift + p` and search for `Open User Settings JS
   }
 }
 ```
-
-## OpenAPI generator
-
-OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). When you add a new or modify an existing endpoint, you must run the command below to update the client SDK.
-
-```bash
-npm run api:generate # Run from the `server` directory
-```
-
-You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
-
-## Database migrations
-
-After making any changes in the `server/libs/database/src/entities`, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.
-
-1. Attached to the server container shell.
-2. Run
-
-```bash
-npm run typeorm -- migration:generate ./libs/infra/src/db/<migration-name> -d ./libs/infra/src/db/config/database.config.ts
-```
-
-3. Check if the migration file makes sense.
-4. Move the migration file to folder `server/libs/database/src/migrations` in your code editor.

docs/docs/features/automatic-backup.md

@@ -14,17 +14,19 @@ Background backup is available thanks to the contribution effort of [@zoodyy](ht
 
 If background backup is enabled. The app will periodically check if there are any new photos or videos in the selected album(s) to be uploaded to the cloud. If there are, it will upload them to the cloud in the background.
 
-
 :::info Note
 
 #### General
+
 - The app must be in the background for the backup worker to start running.
 - If you reopen the app and the first page you see is the backup page, the counts will not reflect the background uploaded result. You have to navigate out of the page and come back to see the updated counts.
 
 #### Android
+
 - It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone.
 
 #### iOS
+
 - You must enable **Background App Refresh** for the app to work in the background. You can enable it in the Settings app under General > Background App Refresh.
 
 <div style={{textAlign: 'center'}}>

docs/docs/features/bulk-upload.md

@@ -42,6 +42,7 @@ immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recur
 | --server / -s    | Immich's server address                                             |
 | --threads / -t   | Number of threads to use (Default 5)                                |
 | --album/ -al     | Create albums for assets based on the parent folder or a given name |
+| --import/ -i     | Import gallery                                                      |
 
 ### Obtain the API Key
 
@@ -49,7 +50,6 @@ The API key can be obtained in the user setting panel on the web interface.
 
 ![Obtain Api Key](./img/obtain-api-key.png)
 
-
 ### Run via Docker
 
 You can run the CLI inside of a docker container to avoid needing to install anything.
@@ -74,13 +74,15 @@ immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
 
 :::tip Internal networking
 If you are running the CLI container on the same machine as your Immich server, you may not be able to reach the external address. In that case, try the following steps:
+
 1. Find the internal Docker network used by Immich via `docker network ls`.
 2. Adapt the above command to pass the `--network <immich_network>` argument to `docker run`, substituting `<immich_network>` with the result from step 1.
-3. Use `--server http://immich-server:3001/` for the upload command instead of the external address.
+3. Use `--server http://immich-server:3001` for the upload command instead of the external address.
 
 ```bash title="Upload to internal address"
-docker run --network immich_default -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://immich-server:3001/
+docker run --network immich_default -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://immich-server:3001
 ```
+
 :::
 
 ### Run from source

docs/docs/features/facial-recognition.md

@@ -0,0 +1,15 @@
+# Facial Recognition
+
+Immich recognizes faces in your photos and videos and groups them together. You can then assign names to the faces and search for them.
+
+The list of people is shown in the Explore page.
+
+<img src={require('./img/facial-recognition-1.png').default} title='Facial Recognition 1' />
+
+Upon clicking on a person, a list of assets that contain their face will be shown.
+
+<img src={require('./img/facial-recognition-2.png').default} title='Facial Recognition 2' />
+
+The asset detail view will also show the faces that are recognized in the asset.
+
+<img src={require('./img/facial-recognition-3.png').default} title='Facial Recognition 3' />

docs/docs/features/partner-sharing.md

@@ -0,0 +1,17 @@
+# Partner Sharing
+
+Immich allows you to share your library with other users. They can then view your library and download the assets.
+
+You can manage one or multiple users to have access to your library from the [User Settings](docs/features/user-settings.md) page.
+
+<img src={require('./img/partner-sharing-1.png').default} title='Partner Sharing 1' />
+
+<img src={require('./img/partner-sharing-2.png').default} title='Partner Sharing 2' />
+
+Accessing the shared library can be done from the Sharing page.
+
+<img src={require('./img/partner-sharing-3.png').default} title='Partner Sharing 3' />
+
+:::tip Sharing specific assets
+For sharing a specific set of assets, you can use the shared album feature of Immich.
+:::

docs/docs/features/read-only-gallery.md

@@ -0,0 +1,103 @@
+# Read-only Gallery [Experimental]
+
+## Overview
+
+This feature enables users to use an existing gallery without uploading the assets to Immich.
+
+Upon syncing the file information, it will be read by Immich to generate supported files.
+
+:::caution
+
+This feature is still in an experimental stage. And this is an initial implementation and will receive improvements in the future.
+
+The current limitations of this feature are:
+
+- Assets are not automatically synced and must instead be manually synced with the CLI tool.
+- Only new files that are added to the gallery will be detected.
+- Deleted and moved files will not be detected.
+
+:::
+
+## Usage
+
+:::tip Example scenario
+
+On the VM/system that Immich is running, I have 2 galleries that I want to use with Immich.
+
+- My gallery is stored at `/mnt/media/precious-memory`
+- My wife's gallery is stored at `/mnt/media/childhood-memory`
+
+We will use those values in the steps below.
+
+:::
+
+### Mount the gallery to the containers.
+
+`immich-server` and `immich-microservices` containers will need access to the gallery. Mount the directory path as in the example below
+
+```diff title="docker-compose.yml"
+  immich-server:
+    container_name: immich_server
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "immich" ]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
++     - /mnt/media/precious-memory:/mnt/media/precious-memory
++     - /mnt/media/childhood-memory:/mnt/media/childhood-memory
+    env_file:
+      - .env
+    depends_on:
+      - redis
+      - database
+      - typesense
+    restart: always
+
+  immich-microservices:
+    container_name: immich_microservices
+    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
+    command: [ "start.sh", "microservices" ]
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
++     - /mnt/media/precious-memory:/mnt/media/precious-memory
++     - /mnt/media/childhood-memory:/mnt/media/childhood-memory
+    env_file:
+      - .env
+    depends_on:
+      - redis
+      - database
+      - typesense
+    restart: always
+```
+
+:::tip
+Internal and external path have to be identical.
+:::
+
+_Remember to bring the container down/up to register the changes. Make sure you can see the mounted path in the container._
+
+### Register the path for the user.
+
+This action is done by the admin of the instance.
+
+- Navigate to `Administration > Users` page on the web.
+- Click on the user edit button.
+- Add the gallery path to the `External Path` field for the corresponding user and confirm the changes.
+
+<img src={require('./img/me.png').default} width='33%' title='My Account Storage Path' />
+
+<img src={require('./img/my-wife.png').default} width='33%' title='My Wifes Account Storage Path' />
+
+### Sync with the CLI tool.
+
+- Install or update the [CLI Tool](/docs/features/bulk-upload.md). The import feature is supported from version `v0.39.0` of the CLI
+- Run the command below to sync the gallery with Immich.
+
+```bash title="Import my gallery"
+immich upload --key <my-api-key> --server http://my-server-ip:2283/api /mnt/media/precious-memory --recursive --import
+```
+
+```bash title="Import my wife gallery"
+immich upload --key <my-wife-api-key> --server http://my-server-ip:2283/api /mnt/media/childhood-memory --recursive --import
+```
+
+The `--import` flag will tell Immich to import the files by path instead of uploading them.

docs/docs/features/reverse-geocoding.md

@@ -4,7 +4,7 @@ Immich supports [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_geocod
 
 ## Extraction
 
-During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country. 
+During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country.
 
 ## Usage
 

docs/docs/features/search.md

@@ -1,6 +1,6 @@
 # Search
 
-Immich uses Typesense as the primary search database to enable high performance search mechanism. 
+Immich uses Typesense as the primary search database to enable high performance search mechanism.
 
 Typesense is a powerful search engine that can be integrated with popular natural language processing (NLP) models like CLIP and SBERT to provide highly accurate and relevant search results. Here are some benefits of using Typesense integrated search for CLIP and SBERT:
 
@@ -10,11 +10,11 @@ Faster Search Response Times: Typesense is optimized for lightning-fast search r
 
 Enhanced Semantic Search Capabilities: CLIP and SBERT are powerful NLP models that can extract the semantic meaning from text, enabling more nuanced search queries. By integrating with Typesense, these models can help to improve the accuracy of semantic search, enabling users to find the most relevant results based on the true meaning of their query.
 
-Greater Search Flexibility: Typesense provides flexible search capabilities, including fuzzy search, partial search, enabling users to find the information they need quickly and easily. When integrated with CLIP and SBERT, Typesense can offer even greater flexibility, allowing users to refine their search queries using natural language and providing more accurate and relevant results. 
+Greater Search Flexibility: Typesense provides flexible search capabilities, including fuzzy search, partial search, enabling users to find the information they need quickly and easily. When integrated with CLIP and SBERT, Typesense can offer even greater flexibility, allowing users to refine their search queries using natural language and providing more accurate and relevant results.
 
 (Generated by Chat-GPT4)
 
-Some search examples: 
-<img src={require('./img/search-ex-2.webp').default}  title='Search Example 1' />
+Some search examples:
+<img src={require('./img/search-ex-2.webp').default} title='Search Example 1' />
 
 <img src={require('./img/search-ex-3.webp').default} title='Search Example 2' />

docs/docs/features/user-settings.md

@@ -10,7 +10,7 @@ View your User ID and email, and update your first and last name.
 
 ## Change Password
 
-Users can change their own passwords. 
+Users can change their own passwords.
 
 ![Change Password](./img/user-change-password.png)
 

docs/docs/features/xmp-sidecars.md

@@ -0,0 +1,13 @@
+# XMP Sidecars
+
+Immich can ingest XMP sidecars on file upload (via the CLI) as well as detect new sidecars that are placed in the filesystem for existing images.
+
+<img src={require('./img/xmp-sidecars.png').default} title='XMP sidecars' />
+
+XMP sidecars are external XML files that contain metadata related to media files. Many applications read and write these files either exclusively or in addition to the metadata written to image files. They can be a powerful tool for editing and storing metadata of a media file without modifying the media file itself. When Immich receives or detects an XMP sidecar for a media file, it will attempt to extract the metadata from both the sidecar as well as the media file. It will prioritize the metadata for fields in the sidecar but will fall back and use the metadata in the media file if necessary.
+
+When importing files via the CLI bulk uploader, Immich will automatically detect XMP sidecar files as files that exist next to the original media file and have the exact same name with an additional `.xmp` file extension (i.e., `PXL_20230401_203352928.MP.jpg` and `PXL_20230401_203352928.MP.jpg.xmp`).
+
+There are 2 administrator jobs associated with sidecar files: `SYNC` and `DISCOVER`. The sync job will re-scan all media with existing sidecar files and queue them for a metadata refresh. This is a great use case when third-party applications are used to modify the metadata of media. The discover job will attempt to scan the filesystem for new sidecar files for all media that does not currently have a sidecar file associated with it.
+
+<img src={require('./img/sidecar-jobs.png').default} title='Sidecar Administrator Jobs' />

docs/docs/install/docker-compose.md

@@ -136,6 +136,15 @@ IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3003
 ####################################################################################
 
 #IMMICH_API_URL_EXTERNAL=http://localhost:3001
+
+###################################################################################
+# Immich Version - Optional
+#
+# This allows all immich docker images to be pinned to a specific version. By default,
+# the version is "release" but could be a specific version, like "v1.59.0".
+###################################################################################
+
+#IMMICH_VERSION=
 ```
 
 </details>
@@ -159,6 +168,8 @@ For more information on how to use the application, please refer to the [Post In
 
 ### Step 4 - Upgrading
 
+If `IMMICH_VERSION` is set, it will need to be updated to the latest or desired version.
+
 When a new version of Immich is [released](https://github.com/immich-app/immich/releases), the application can be upgraded with the following commands, run in the directory with the `docker-compose.yml` file:
 
 ```bash title="Upgrade Immich"

docs/docs/install/environment-variables.md

@@ -0,0 +1,186 @@
+# Environment Variables
+
+## Docker Compose
+
+| Variable          | Description           |  Default  | Services                                                       |
+| :---------------- | :-------------------- | :-------: | :------------------------------------------------------------- |
+| `IMMICH_VERSION`  | Image tags            | `release` | server, microservices, machine learning, web, proxy, typesense |
+| `UPLOAD_LOCATION` | Host Path for uploads |           | server, microservices                                          |
+
+:::tip
+
+These environment variables are used by the `docker-compose.yml` file and do **NOT** affect the containers directly.
+
+:::
+
+## General
+
+| Variable                    | Description                                  |   Default    | Services                                     |
+| :-------------------------- | :------------------------------------------- | :----------: | :------------------------------------------- |
+| `TZ`                        | Timezone                                     |              | microservices                                |
+| `NODE_ENV`                  | Environment (production, development)        | `production` | server, microservices, machine learning, web |
+| `LOG_LEVEL`                 | Log Level (verbose, debug, log, warn, error) |    `log`     | server, microservices                        |
+| `IMMICH_MEDIA_LOCATION`     | Media Location                               |  `./upload`  | server, microservices                        |
+| `PUBLIC_LOGIN_PAGE_MESSAGE` | Public Login Page Message                    |              | web                                          |
+
+:::tip
+
+`TZ` is only used by the `exiftool` as a fallback in case the timezone cannot be determined from the image metadata.
+
+`exiftool` is only present in the microservices container.
+
+:::
+
+## Geocoding
+
+| Variable                           | Description                         |           Default            | Services      |
+| :--------------------------------- | :---------------------------------- | :--------------------------: | :------------ |
+| `DISABLE_REVERSE_GEOCODING`        | Disable Reverse Geocoding Precision |           `false`            | microservices |
+| `REVERSE_GEOCODING_PRECISION`      | Reverse Geocoding Precision         |             `3`              | microservices |
+| `REVERSE_GEOCODING_DUMP_DIRECTORY` | Reverse Geocoding Dump Directory    | `./.reverse-geocoding-dump/` | microservices |
+
+## Ports
+
+| Variable                | Description           | Default | Services         |
+| :---------------------- | :-------------------- | :-----: | :--------------- |
+| `PORT`                  | Web Port              | `3000`  | web              |
+| `SERVER_PORT`           | Server Port           | `3001`  | server           |
+| `MICROSERVICES_PORT`    | Microservices Port    | `3002`  | microservices    |
+| `MACHINE_LEARNING_PORT` | Machine Learning Port | `3003`  | machine learning |
+
+## URLs
+
+| Variable                      | Description                                              |                Default                | Services              |
+| :---------------------------- | :------------------------------------------------------- | :-----------------------------------: | :-------------------- |
+| `IMMICH_WEB_URL`              | Immich Web URL                                           |       `http://immich-web:3000`        | proxy                 |
+| `IMMICH_SERVER_URL`           | Immich Server URL                                        |      `http://immich-server:3001`      | web, proxy            |
+| `IMMICH_MACHINE_LEARNING_URL` | Immich Machine Learning URL, set `"false"` to disable ML | `http://immich-machine-learning:3003` | server, microservices |
+| `PUBLIC_IMMICH_SERVER_URL`    | Public Immich URL                                        |      `http://immich-server:3001`      | web                   |
+| `IMMICH_API_URL_EXTERNAL`     | Immich API URL External                                  |                `/api`                 | web                   |
+
+:::info
+
+The above paths are modifying the internal paths of the containers.
+
+:::
+
+## Database
+
+| Variable      | Description       |   Default   | Services              |
+| :------------ | :---------------- | :---------: | :-------------------- |
+| `DB_URL`      | Database URL      |             | server, microservices |
+| `DB_HOSTNAME` | Database Host     | `localhost` | server, microservices |
+| `DB_PORT`     | Database Port     |   `5432`    | server, microservices |
+| `DB_USERNAME` | Database User     | `postgres`  | server, microservices |
+| `DB_PASSWORD` | Database Password | `postgres`  | server, microservices |
+| `DB_DATABASE` | Database Name     |  `immich`   | server, microservices |
+
+:::info
+
+When `DB_URL` is defined, the other database (`DB_*`) variables are ignored.
+
+:::
+
+## Redis
+
+| Variable         | Description    |    Default     | Services              |
+| :--------------- | :------------- | :------------: | :-------------------- |
+| `REDIS_URL`      | Redis URL      |                | server, microservices |
+| `REDIS_HOSTNAME` | Redis Host     | `immich_redis` | server, microservices |
+| `REDIS_PORT`     | Redis Port     |     `6379`     | server, microservices |
+| `REDIS_DBINDEX`  | Redis DB Index |      `0`       | server, microservices |
+| `REDIS_USERNAME` | Redis Username |                | server, microservices |
+| `REDIS_PASSWORD` | Redis Password |                | server, microservices |
+| `REDIS_SOCKET`   | Redis Socket   |                | server, microservices |
+
+:::info
+
+`REDIS_URL` must start with `ioredis://` and then include a `base64` encoded JSON string for the configuration.
+More info can be found in the upstream [ioredis](https://ioredis.readthedocs.io/en/latest/API/) documentation.
+
+- When `REDIS_URL` is defined, the other redis (`REDIS_*`) variables are ignored.
+- When `REDIS_SOCKET` is defined, the other redis (`REDIS_*`) variables are ignored.
+
+:::
+
+Redis (Sentinel) URL example JSON before encoding:
+
+```json
+{
+  "sentinels": [
+    {
+      "host": "redis-sentinel-node-0",
+      "port": 26379
+    },
+    {
+      "host": "redis-sentinel-node-1",
+      "port": 26379
+    },
+    {
+      "host": "redis-sentinel-node-2",
+      "port": 26379
+    }
+  ],
+  "name": "redis-sentinel"
+}
+```
+
+## Typesense
+
+| Variable             | Description              |   Default   | Services                         |
+| :------------------- | :----------------------- | :---------: | :------------------------------- |
+| `TYPESENSE_ENABLED`  | Enable Typesense         |             | server, microservices            |
+| `TYPESENSE_URL`      | Typesense URL            |             | server, microservices            |
+| `TYPESENSE_HOST`     | Typesense Host           | `typesense` | server, microservices            |
+| `TYPESENSE_PORT`     | Typesense Port           |   `8108`    | server, microservices            |
+| `TYPESENSE_PROTOCOL` | Typesense Protocol       |   `http`    | server, microservices            |
+| `TYPESENSE_API_KEY`  | Typesense API Key        |             | server, microservices, typesense |
+| `TYPESENSE_DATA_DIR` | Typesense Data Directory |   `/data`   | typesense                        |
+
+:::info
+
+`TYPESENSE_URL` must start with `ha://` and then include a `base64` encoded JSON string for the configuration.
+
+`TYPESENSE_ENABLED`: Anything other than `false`, behaves as `true`.
+Even undefined is treated as `true`.
+
+- When `TYPESENSE_URL` is defined, the other typesense (`TYPESENSE_*`) variables are ignored.
+
+:::
+
+Typesense URL example JSON before encoding:
+
+```json
+[
+  {
+    "host": "typesense-1.example.net",
+    "port": "443",
+    "protocol": "https"
+  },
+  {
+    "host": "typesense-2.example.net",
+    "port": "443",
+    "protocol": "https"
+  },
+  {
+    "host": "typesense-3.example.net",
+    "port": "443",
+    "protocol": "https"
+  }
+]
+```
+
+## Machine Learning
+
+| Variable                                    | Description                    |        Default        | Services         |
+| :------------------------------------------ | :----------------------------- | :-------------------: | :--------------- |
+| `MACHINE_LEARNING_MIN_FACE_SCORE`           | Minimum Face Score             |         `0.7`         | machine learning |
+| `MACHINE_LEARNING_MODEL_TTL`                | Model TTL                      |         `300`         | machine learning |
+| `MACHINE_LEARNING_EAGER_STARTUP`            | Eager Startup                  |        `true`         | machine learning |
+| `MACHINE_LEARNING_MIN_TAG_SCORE`            | Minimum Tag Score              |         `0.9`         | machine learning |
+| `MACHINE_LEARNING_FACIAL_RECOGNITION_MODEL` | Facial Recognition Model       |      `buffalo_l`      | machine learning |
+| `MACHINE_LEARNING_CLIP_TEXT_MODEL`          | Clip Text Model                |    `clip-ViT-B-32`    | machine learning |
+| `MACHINE_LEARNING_CLIP_IMAGE_MODEL`         | Clip Image Model               |    `clip-ViT-B-32`    | machine learning |
+| `MACHINE_LEARNING_CLASSIFICATION_MODEL`     | Classification Model           | `microsoft/resnet-50` | machine learning |
+| `MACHINE_LEARNING_CACHE_FOLDER`             | ML Cache Location              |       `/cache`        | machine learning |
+| `TRANSFORMERS_CACHE`                        | ML Transformers Cache Location |       `/cache`        | machine learning |

docs/docs/install/portainer.md

@@ -13,37 +13,36 @@ Install Immich using Portainer's Stack feature.
 5. Replace `.env` with `stack.env` for all containers that need to use environment variables in the web editor.
 
 <img
-  src={require('./img/dot-env.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/dot-env.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
 8. Click on "**Advanced Mode**" in the **Environment Variables** section.
 
 <img
-  src={require('./img/env-1.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/env-1.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
 9. Copy the content of the `example.env` file from the [GitHub repository](https://github.com/immich-app/immich/releases/latest/download/example.env) and paste into the editor.
 10. Switch back to "**Simple Mode**".
 
 <img
-  src={require('./img/env-2.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/env-2.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
-* Populate custom database information if necessary.
-* Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
+- Populate custom database information if necessary.
+- Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
 
 11. Click on "**Deploy the stack**".
 
-
 :::tip
 For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.mdx) guide.
 :::

docs/docs/install/requirements.md

@@ -2,8 +2,8 @@
 sidebar_position: 10
 ---
 
-
 # Requirements
+
 Hardware and software requirements for Immich
 
 ## Software
@@ -18,5 +18,5 @@ You can also use Podman to run the application. However, additional configuratio
 ## Hardware
 
 - **OS**: Preferred unix-based operating system (Ubuntu, Debian, MacOS, etc). Windows works too, with [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/)
-- **RAM**: At least 2GB, preferred 4GB.
+- **RAM**: At least 4GB, preferred 6GB.
 - **CPU**: At least 2 cores, preferred 4 cores.

docs/docs/install/unraid.md

@@ -5,6 +5,7 @@ sidebar_position: 60
 # Unraid
 
 Immich can easily be installed and updated on Unraid via:
+
 1. [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin from the Unraid Community Apps
 2. Community made template on the Unraid Community Apps
 
@@ -20,7 +21,7 @@ In order to install Immich from the Unraid CA, you will need an existing Redis a
 
 Once you have Redis and PostgreSQL running, search for Immich on the Unraid CA, choose either of the templates listed and fill out the example variables.
 
-For more information about setting up the community image see [here](https://github.com/imagegenius/docker-immich#application-setup) 
+For more information about setting up the community image see [here](https://github.com/imagegenius/docker-immich#application-setup)
 
 ## Docker-Compose Method (Official)
 

docs/docs/overview/introduction.mdx

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Introduction
 
-<img src={require('./img/feature-panel.png').default} alt='Immich' />
+<img src={require('./img/feature-panel.png').default} alt="Immich" />
 
 ## Welcome!
 

docs/docs/overview/support-the-project.md

@@ -18,7 +18,6 @@ If you feel like this is the right cause and the app is something you see yourse
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
 
-
 ## Contributing
 
 There are lots of non-monetary ways to contribute to Immich as well.

docs/docusaurus.config.js

@@ -7,8 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Immich',
-  tagline:
-    'High performance self-hosted photo and video backup solution directly from your mobile phone',
+  tagline: 'High performance self-hosted photo and video backup solution directly from your mobile phone',
   url: 'https://documentation.immich.app',
   baseUrl: '/',
   onBrokenLinks: 'throw',
@@ -111,11 +110,6 @@ const config = {
             label: 'GitHub',
             position: 'right',
           },
-          {
-            href: 'https://github.com/orgs/immich-app/projects/1',
-            label: 'Roadmap',
-            position: 'right',
-          },
         ],
       },
       footer: {
@@ -154,10 +148,6 @@ const config = {
                 label: 'GitHub',
                 href: 'https://github.com/immich-app/immich',
               },
-              {
-                label: 'Roadmap',
-                href: 'https://github.com/orgs/immich-app/projects/1',
-              },
             ],
           },
         ],

docs/package.json

@@ -4,6 +4,8 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
     "start": "docusaurus start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
@@ -12,7 +14,7 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "check": "tsc"
   },
   "dependencies": {
     "@docusaurus/core": "2.1.0",
@@ -32,7 +34,8 @@
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.1.0",
     "@tsconfig/docusaurus": "^1.0.5",
-    "typescript": "^4.7.4"
+    "prettier": "^2.8.8",
+    "typescript": "^5.0.0"
   },
   "browserslist": {
     "production": [

docs/sidebars.js

@@ -14,7 +14,7 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+  tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
 
   // But you can create a sidebar manually
   /*

docs/src/components/HomepageFeatures/index.tsx

@@ -14,8 +14,8 @@ const FeatureList: FeatureItem[] = [
     Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        Docusaurus was designed from the ground up to be easily installed and used to get your website up and running
+        quickly.
       </>
     ),
   },
@@ -24,8 +24,8 @@ const FeatureList: FeatureItem[] = [
     Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go ahead and move your docs into the{' '}
+        <code>docs</code> directory.
       </>
     ),
   },
@@ -34,14 +34,14 @@ const FeatureList: FeatureItem[] = [
     Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+        Extend or customize your website layout by reusing React. Docusaurus can be extended while reusing the same
+        header and footer.
       </>
     ),
   },
 ];
 
-function Feature({title, Svg, description}: FeatureItem) {
+function Feature({ title, Svg, description }: FeatureItem) {
   return (
     <div className={clsx('col col--4')}>
       <div className="text--center">

docs/src/css/custom.css

@@ -7,12 +7,12 @@
 @tailwind components;
 @tailwind utilities;
 
-@import url("https://fonts.googleapis.com/css2?family=Overpass:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&display=swap");
-@import url("https://fonts.googleapis.com/css2?family=Snowburst+One&display=swap");
+@import url('https://fonts.googleapis.com/css2?family=Overpass:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=Snowburst+One&display=swap');
 
 html,
 button {
-  font-family: "Overpass", sans-serif;
+  font-family: 'Overpass', sans-serif;
 }
 
 /* You can override the default Infima variables here. */
@@ -29,7 +29,7 @@ button {
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
-[data-theme="dark"] {
+[data-theme='dark'] {
   --ifm-color-primary: #adcbfa;
   --ifm-color-primary-dark: #85b2f8;
   --ifm-color-primary-darker: #71a5f6;

docs/src/pages/index.tsx

@@ -1,6 +1,6 @@
-import React from "react";
-import Link from "@docusaurus/Link";
-import Layout from "@theme/Layout";
+import React from 'react';
+import Link from '@docusaurus/Link';
+import Layout from '@theme/Layout';
 
 function HomepageHeader() {
   return (
@@ -31,7 +31,7 @@ function HomepageHeader() {
           </Link>
         </div>
 
-        <img src="/img/immich-screenshots.webp" alt="logo" />
+        <img src="/img/immich-screenshots.png" alt="logo" />
       </section>
     </header>
   );

docs/src/theme/SearchBar/DocSearch.js

@@ -1,297 +1,256 @@
-import Hogan from "hogan.js";
-import LunrSearchAdapter from "./lunar-search";
-import autocomplete from "autocomplete.js";
-import templates from "./templates";
-import utils from "./utils";
-import $ from "autocomplete.js/zepto";
+import Hogan from 'hogan.js';
+import LunrSearchAdapter from './lunar-search';
+import autocomplete from 'autocomplete.js';
+import templates from './templates';
+import utils from './utils';
+import $ from 'autocomplete.js/zepto';
 
 class DocSearch {
-    constructor({
-        searchDocs,
-        searchIndex,
-        inputSelector,
-        debug = false,
-        baseUrl = '/',
-        queryDataCallback = null,
-        autocompleteOptions = {
-            debug: false,
-            hint: false,
-            autoselect: true
+  constructor({
+    searchDocs,
+    searchIndex,
+    inputSelector,
+    debug = false,
+    baseUrl = '/',
+    queryDataCallback = null,
+    autocompleteOptions = {
+      debug: false,
+      hint: false,
+      autoselect: true,
+    },
+    transformData = false,
+    queryHook = false,
+    handleSelected = false,
+    enhancedSearchInput = false,
+    layout = 'collumns',
+  }) {
+    this.input = DocSearch.getInputFromSelector(inputSelector);
+    this.queryDataCallback = queryDataCallback || null;
+    const autocompleteOptionsDebug =
+      autocompleteOptions && autocompleteOptions.debug ? autocompleteOptions.debug : false;
+    // eslint-disable-next-line no-param-reassign
+    autocompleteOptions.debug = debug || autocompleteOptionsDebug;
+    this.autocompleteOptions = autocompleteOptions;
+    this.autocompleteOptions.cssClasses = this.autocompleteOptions.cssClasses || {};
+    this.autocompleteOptions.cssClasses.prefix = this.autocompleteOptions.cssClasses.prefix || 'ds';
+    const inputAriaLabel = this.input && typeof this.input.attr === 'function' && this.input.attr('aria-label');
+    this.autocompleteOptions.ariaLabel = this.autocompleteOptions.ariaLabel || inputAriaLabel || 'search input';
+
+    this.isSimpleLayout = layout === 'simple';
+
+    this.client = new LunrSearchAdapter(searchDocs, searchIndex, baseUrl);
+
+    if (enhancedSearchInput) {
+      this.input = DocSearch.injectSearchBox(this.input);
+    }
+    this.autocomplete = autocomplete(this.input, autocompleteOptions, [
+      {
+        source: this.getAutocompleteSource(transformData, queryHook),
+        templates: {
+          suggestion: DocSearch.getSuggestionTemplate(this.isSimpleLayout),
+          footer: templates.footer,
+          empty: DocSearch.getEmptyTemplate(),
         },
-        transformData = false,
-        queryHook = false,
-        handleSelected = false,
-        enhancedSearchInput = false,
-        layout = "collumns"
-    }) {
-        this.input = DocSearch.getInputFromSelector(inputSelector);
-        this.queryDataCallback = queryDataCallback || null;
-        const autocompleteOptionsDebug =
-            autocompleteOptions && autocompleteOptions.debug
-                ? autocompleteOptions.debug
-                : false;
+      },
+    ]);
+
+    const customHandleSelected = handleSelected;
+    this.handleSelected = customHandleSelected || this.handleSelected;
+
+    // We prevent default link clicking if a custom handleSelected is defined
+    if (customHandleSelected) {
+      $('.algolia-autocomplete').on('click', '.ds-suggestions a', (event) => {
+        event.preventDefault();
+      });
+    }
+
+    this.autocomplete.on('autocomplete:selected', this.handleSelected.bind(null, this.autocomplete.autocomplete));
+
+    this.autocomplete.on('autocomplete:shown', this.handleShown.bind(null, this.input));
+
+    if (enhancedSearchInput) {
+      DocSearch.bindSearchBoxEvent();
+    }
+  }
+
+  static injectSearchBox(input) {
+    input.before(templates.searchBox);
+    const newInput = input.prev().prev().find('input');
+    input.remove();
+    return newInput;
+  }
+
+  static bindSearchBoxEvent() {
+    $('.searchbox [type="reset"]').on('click', function () {
+      $('input#docsearch').focus();
+      $(this).addClass('hide');
+      autocomplete.autocomplete.setVal('');
+    });
+
+    $('input#docsearch').on('keyup', () => {
+      const searchbox = document.querySelector('input#docsearch');
+      const reset = document.querySelector('.searchbox [type="reset"]');
+      reset.className = 'searchbox__reset';
+      if (searchbox.value.length === 0) {
+        reset.className += ' hide';
+      }
+    });
+  }
+
+  /**
+   * Returns the matching input from a CSS selector, null if none matches
+   * @function getInputFromSelector
+   * @param  {string} selector CSS selector that matches the search
+   * input of the page
+   * @returns {void}
+   */
+  static getInputFromSelector(selector) {
+    const input = $(selector).filter('input');
+    return input.length ? $(input[0]) : null;
+  }
+
+  /**
+   * Returns the `source` method to be passed to autocomplete.js. It will query
+   * the Algolia index and call the callbacks with the formatted hits.
+   * @function getAutocompleteSource
+   * @param  {function} transformData An optional function to transform the hits
+   * @param {function} queryHook An optional function to transform the query
+   * @returns {function} Method to be passed as the `source` option of
+   * autocomplete
+   */
+  getAutocompleteSource(transformData, queryHook) {
+    return (query, callback) => {
+      if (queryHook) {
         // eslint-disable-next-line no-param-reassign
-        autocompleteOptions.debug = debug || autocompleteOptionsDebug;
-        this.autocompleteOptions = autocompleteOptions;
-        this.autocompleteOptions.cssClasses =
-            this.autocompleteOptions.cssClasses || {};
-        this.autocompleteOptions.cssClasses.prefix =
-            this.autocompleteOptions.cssClasses.prefix || "ds";
-        const inputAriaLabel =
-            this.input &&
-            typeof this.input.attr === "function" &&
-            this.input.attr("aria-label");
-        this.autocompleteOptions.ariaLabel =
-            this.autocompleteOptions.ariaLabel || inputAriaLabel || "search input";
-
-        this.isSimpleLayout = layout === "simple";
-
-        this.client = new LunrSearchAdapter(searchDocs, searchIndex, baseUrl);
-
-        if (enhancedSearchInput) {
-            this.input = DocSearch.injectSearchBox(this.input);
+        query = queryHook(query) || query;
+      }
+      this.client.search(query).then((hits) => {
+        if (this.queryDataCallback && typeof this.queryDataCallback == 'function') {
+          this.queryDataCallback(hits);
         }
-        this.autocomplete = autocomplete(this.input, autocompleteOptions, [
-            {
-                source: this.getAutocompleteSource(transformData, queryHook),
-                templates: {
-                    suggestion: DocSearch.getSuggestionTemplate(this.isSimpleLayout),
-                    footer: templates.footer,
-                    empty: DocSearch.getEmptyTemplate()
-                }
-            }
-        ]);
-
-        const customHandleSelected = handleSelected;
-        this.handleSelected = customHandleSelected || this.handleSelected;
-
-        // We prevent default link clicking if a custom handleSelected is defined
-        if (customHandleSelected) {
-            $(".algolia-autocomplete").on("click", ".ds-suggestions a", event => {
-                event.preventDefault();
-            });
+        if (transformData) {
+          hits = transformData(hits) || hits;
         }
+        callback(DocSearch.formatHits(hits));
+      });
+    };
+  }
 
-        this.autocomplete.on(
-            "autocomplete:selected",
-            this.handleSelected.bind(null, this.autocomplete.autocomplete)
-        );
+  // Given a list of hits returned by the API, will reformat them to be used in
+  // a Hogan template
+  static formatHits(receivedHits) {
+    const clonedHits = utils.deepClone(receivedHits);
+    const hits = clonedHits.map((hit) => {
+      if (hit._highlightResult) {
+        // eslint-disable-next-line no-param-reassign
+        hit._highlightResult = utils.mergeKeyWithParent(hit._highlightResult, 'hierarchy');
+      }
+      return utils.mergeKeyWithParent(hit, 'hierarchy');
+    });
 
-        this.autocomplete.on(
-            "autocomplete:shown",
-            this.handleShown.bind(null, this.input)
-        );
+    // Group hits by category / subcategory
+    let groupedHits = utils.groupBy(hits, 'lvl0');
+    $.each(groupedHits, (level, collection) => {
+      const groupedHitsByLvl1 = utils.groupBy(collection, 'lvl1');
+      const flattenedHits = utils.flattenAndFlagFirst(groupedHitsByLvl1, 'isSubCategoryHeader');
+      groupedHits[level] = flattenedHits;
+    });
+    groupedHits = utils.flattenAndFlagFirst(groupedHits, 'isCategoryHeader');
 
-        if (enhancedSearchInput) {
-            DocSearch.bindSearchBoxEvent();
-        }
+    // Translate hits into smaller objects to be send to the template
+    return groupedHits.map((hit) => {
+      const url = DocSearch.formatURL(hit);
+      const category = utils.getHighlightedValue(hit, 'lvl0');
+      const subcategory = utils.getHighlightedValue(hit, 'lvl1') || category;
+      const displayTitle = utils
+        .compact([
+          utils.getHighlightedValue(hit, 'lvl2') || subcategory,
+          utils.getHighlightedValue(hit, 'lvl3'),
+          utils.getHighlightedValue(hit, 'lvl4'),
+          utils.getHighlightedValue(hit, 'lvl5'),
+          utils.getHighlightedValue(hit, 'lvl6'),
+        ])
+        .join('<span class="aa-suggestion-title-separator" aria-hidden="true"> › </span>');
+      const text = utils.getSnippetedValue(hit, 'content');
+      const isTextOrSubcategoryNonEmpty = (subcategory && subcategory !== '') || (displayTitle && displayTitle !== '');
+      const isLvl1EmptyOrDuplicate = !subcategory || subcategory === '' || subcategory === category;
+      const isLvl2 = displayTitle && displayTitle !== '' && displayTitle !== subcategory;
+      const isLvl1 = !isLvl2 && subcategory && subcategory !== '' && subcategory !== category;
+      const isLvl0 = !isLvl1 && !isLvl2;
+
+      return {
+        isLvl0,
+        isLvl1,
+        isLvl2,
+        isLvl1EmptyOrDuplicate,
+        isCategoryHeader: hit.isCategoryHeader,
+        isSubCategoryHeader: hit.isSubCategoryHeader,
+        isTextOrSubcategoryNonEmpty,
+        category,
+        subcategory,
+        title: displayTitle,
+        text,
+        url,
+      };
+    });
+  }
+
+  static formatURL(hit) {
+    const { url, anchor } = hit;
+    if (url) {
+      const containsAnchor = url.indexOf('#') !== -1;
+      if (containsAnchor) return url;
+      else if (anchor) return `${hit.url}#${hit.anchor}`;
+      return url;
+    } else if (anchor) return `#${hit.anchor}`;
+    /* eslint-disable */
+    console.warn('no anchor nor url for : ', JSON.stringify(hit));
+    /* eslint-enable */
+    return null;
+  }
+
+  static getEmptyTemplate() {
+    return (args) => Hogan.compile(templates.empty).render(args);
+  }
+
+  static getSuggestionTemplate(isSimpleLayout) {
+    const stringTemplate = isSimpleLayout ? templates.suggestionSimple : templates.suggestion;
+    const template = Hogan.compile(stringTemplate);
+    return (suggestion) => template.render(suggestion);
+  }
+
+  handleSelected(input, event, suggestion, datasetNumber, context = {}) {
+    // Do nothing if click on the suggestion, as it's already a <a href>, the
+    // browser will take care of it. This allow Ctrl-Clicking on results and not
+    // having the main window being redirected as well
+    if (context.selectionMethod === 'click') {
+      return;
     }
 
-    static injectSearchBox(input) {
-        input.before(templates.searchBox);
-        const newInput = input
-            .prev()
-            .prev()
-            .find("input");
-        input.remove();
-        return newInput;
+    input.setVal('');
+    window.location.assign(suggestion.url);
+  }
+
+  handleShown(input) {
+    const middleOfInput = input.offset().left + input.width() / 2;
+    let middleOfWindow = $(document).width() / 2;
+
+    if (isNaN(middleOfWindow)) {
+      middleOfWindow = 900;
     }
 
-    static bindSearchBoxEvent() {
-        $('.searchbox [type="reset"]').on("click", function () {
-            $("input#docsearch").focus();
-            $(this).addClass("hide");
-            autocomplete.autocomplete.setVal("");
-        });
-
-        $("input#docsearch").on("keyup", () => {
-            const searchbox = document.querySelector("input#docsearch");
-            const reset = document.querySelector('.searchbox [type="reset"]');
-            reset.className = "searchbox__reset";
-            if (searchbox.value.length === 0) {
-                reset.className += " hide";
-            }
-        });
+    const alignClass = middleOfInput - middleOfWindow >= 0 ? 'algolia-autocomplete-right' : 'algolia-autocomplete-left';
+    const otherAlignClass =
+      middleOfInput - middleOfWindow < 0 ? 'algolia-autocomplete-right' : 'algolia-autocomplete-left';
+    const autocompleteWrapper = $('.algolia-autocomplete');
+    if (!autocompleteWrapper.hasClass(alignClass)) {
+      autocompleteWrapper.addClass(alignClass);
     }
 
-    /**
-     * Returns the matching input from a CSS selector, null if none matches
-     * @function getInputFromSelector
-     * @param  {string} selector CSS selector that matches the search
-     * input of the page
-     * @returns {void}
-     */
-    static getInputFromSelector(selector) {
-        const input = $(selector).filter("input");
-        return input.length ? $(input[0]) : null;
-    }
-
-    /**
-     * Returns the `source` method to be passed to autocomplete.js. It will query
-     * the Algolia index and call the callbacks with the formatted hits.
-     * @function getAutocompleteSource
-     * @param  {function} transformData An optional function to transform the hits
-     * @param {function} queryHook An optional function to transform the query
-     * @returns {function} Method to be passed as the `source` option of
-     * autocomplete
-     */
-    getAutocompleteSource(transformData, queryHook) {
-        return (query, callback) => {
-            if (queryHook) {
-                // eslint-disable-next-line no-param-reassign
-                query = queryHook(query) || query;
-            }
-            this.client.search(query).then(hits => {
-                if (
-                    this.queryDataCallback &&
-                    typeof this.queryDataCallback == "function"
-                ) {
-                    this.queryDataCallback(hits);
-                }
-                if (transformData) {
-                    hits = transformData(hits) || hits;
-                }
-                callback(DocSearch.formatHits(hits));
-            });
-        };
-    }
-
-    // Given a list of hits returned by the API, will reformat them to be used in
-    // a Hogan template
-    static formatHits(receivedHits) {
-        const clonedHits = utils.deepClone(receivedHits);
-        const hits = clonedHits.map(hit => {
-            if (hit._highlightResult) {
-                // eslint-disable-next-line no-param-reassign
-                hit._highlightResult = utils.mergeKeyWithParent(
-                    hit._highlightResult,
-                    "hierarchy"
-                );
-            }
-            return utils.mergeKeyWithParent(hit, "hierarchy");
-        });
-
-        // Group hits by category / subcategory
-        let groupedHits = utils.groupBy(hits, "lvl0");
-        $.each(groupedHits, (level, collection) => {
-            const groupedHitsByLvl1 = utils.groupBy(collection, "lvl1");
-            const flattenedHits = utils.flattenAndFlagFirst(
-                groupedHitsByLvl1,
-                "isSubCategoryHeader"
-            );
-            groupedHits[level] = flattenedHits;
-        });
-        groupedHits = utils.flattenAndFlagFirst(groupedHits, "isCategoryHeader");
-
-        // Translate hits into smaller objects to be send to the template
-        return groupedHits.map(hit => {
-            const url = DocSearch.formatURL(hit);
-            const category = utils.getHighlightedValue(hit, "lvl0");
-            const subcategory = utils.getHighlightedValue(hit, "lvl1") || category;
-            const displayTitle = utils
-                .compact([
-                    utils.getHighlightedValue(hit, "lvl2") || subcategory,
-                    utils.getHighlightedValue(hit, "lvl3"),
-                    utils.getHighlightedValue(hit, "lvl4"),
-                    utils.getHighlightedValue(hit, "lvl5"),
-                    utils.getHighlightedValue(hit, "lvl6")
-                ])
-                .join(
-                    '<span class="aa-suggestion-title-separator" aria-hidden="true"> › </span>'
-                );
-            const text = utils.getSnippetedValue(hit, "content");
-            const isTextOrSubcategoryNonEmpty =
-                (subcategory && subcategory !== "") ||
-                (displayTitle && displayTitle !== "");
-            const isLvl1EmptyOrDuplicate =
-                !subcategory || subcategory === "" || subcategory === category;
-            const isLvl2 =
-                displayTitle && displayTitle !== "" && displayTitle !== subcategory;
-            const isLvl1 =
-                !isLvl2 &&
-                (subcategory && subcategory !== "" && subcategory !== category);
-            const isLvl0 = !isLvl1 && !isLvl2;
-
-            return {
-                isLvl0,
-                isLvl1,
-                isLvl2,
-                isLvl1EmptyOrDuplicate,
-                isCategoryHeader: hit.isCategoryHeader,
-                isSubCategoryHeader: hit.isSubCategoryHeader,
-                isTextOrSubcategoryNonEmpty,
-                category,
-                subcategory,
-                title: displayTitle,
-                text,
-                url
-            };
-        });
-    }
-
-    static formatURL(hit) {
-        const { url, anchor } = hit;
-        if (url) {
-            const containsAnchor = url.indexOf("#") !== -1;
-            if (containsAnchor) return url;
-            else if (anchor) return `${hit.url}#${hit.anchor}`;
-            return url;
-        } else if (anchor) return `#${hit.anchor}`;
-        /* eslint-disable */
-        console.warn("no anchor nor url for : ", JSON.stringify(hit));
-        /* eslint-enable */
-        return null;
-    }
-
-    static getEmptyTemplate() {
-        return args => Hogan.compile(templates.empty).render(args);
-    }
-
-    static getSuggestionTemplate(isSimpleLayout) {
-        const stringTemplate = isSimpleLayout
-            ? templates.suggestionSimple
-            : templates.suggestion;
-        const template = Hogan.compile(stringTemplate);
-        return suggestion => template.render(suggestion);
-    }
-
-    handleSelected(input, event, suggestion, datasetNumber, context = {}) {
-        // Do nothing if click on the suggestion, as it's already a <a href>, the
-        // browser will take care of it. This allow Ctrl-Clicking on results and not
-        // having the main window being redirected as well
-        if (context.selectionMethod === "click") {
-            return;
-        }
-
-        input.setVal("");
-        window.location.assign(suggestion.url);
-    }
-
-    handleShown(input) {
-        const middleOfInput = input.offset().left + input.width() / 2;
-        let middleOfWindow = $(document).width() / 2;
-
-        if (isNaN(middleOfWindow)) {
-            middleOfWindow = 900;
-        }
-
-        const alignClass =
-            middleOfInput - middleOfWindow >= 0
-                ? "algolia-autocomplete-right"
-                : "algolia-autocomplete-left";
-        const otherAlignClass =
-            middleOfInput - middleOfWindow < 0
-                ? "algolia-autocomplete-right"
-                : "algolia-autocomplete-left";
-        const autocompleteWrapper = $(".algolia-autocomplete");
-        if (!autocompleteWrapper.hasClass(alignClass)) {
-            autocompleteWrapper.addClass(alignClass);
-        }
-
-        if (autocompleteWrapper.hasClass(otherAlignClass)) {
-            autocompleteWrapper.removeClass(otherAlignClass);
-        }
+    if (autocompleteWrapper.hasClass(otherAlignClass)) {
+      autocompleteWrapper.removeClass(otherAlignClass);
     }
+  }
 }
 
 export default DocSearch;

docs/src/theme/SearchBar/algolia.css

@@ -11,8 +11,7 @@
   color: #3a33d1;
 }
 /* Highligted search terms in the main category headers */
-.algolia-docsearch-suggestion--category-header
-  .algolia-docsearch-suggestion--highlight {
+.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight {
   background-color: #4d47d5;
 }
 /* Currently selected suggestion */
@@ -343,9 +342,7 @@
   background: inherit;
 }
 
-.algolia-autocomplete
-  .algolia-docsearch-suggestion--text
-  .algolia-docsearch-suggestion--highlight {
+.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
   padding: 0 0 1px;
   background: inherit;
   box-shadow: inset 0 -2px 0 0 rgba(69, 142, 225, 0.8);
@@ -419,14 +416,11 @@
 .algolia-autocomplete
   .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main
   .algolia-docsearch-suggestion--category-header,
-.algolia-autocomplete
-  .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary {
+.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary {
   display: block;
 }
 
-.algolia-autocomplete
-  .algolia-docsearch-suggestion--subcategory-column
-  .algolia-docsearch-suggestion--highlight {
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight {
   background-color: inherit;
   color: inherit;
 }
@@ -459,9 +453,7 @@
   margin-top: -8px;
 }
 
-.algolia-autocomplete
-  .algolia-docsearch-suggestion--no-results
-  .algolia-docsearch-suggestion--text {
+.algolia-autocomplete .algolia-docsearch-suggestion--no-results .algolia-docsearch-suggestion--text {
   color: #ffffff;
   margin-top: 4px;
 }
@@ -477,14 +469,10 @@
   color: #222222;
   background-color: #ebebeb;
   border-radius: 3px;
-  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
-    monospace;
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
 }
 
-.algolia-autocomplete
-  .algolia-docsearch-suggestion
-  code
-  .algolia-docsearch-suggestion--highlight {
+.algolia-autocomplete .algolia-docsearch-suggestion code .algolia-docsearch-suggestion--highlight {
   background: none;
 }
 

docs/src/theme/SearchBar/index.js

@@ -1,10 +1,10 @@
-import React, { useRef, useCallback, useState } from "react";
-import classnames from "classnames";
-import { useHistory } from "@docusaurus/router";
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import React, { useRef, useCallback, useState } from 'react';
+import classnames from 'classnames';
+import { useHistory } from '@docusaurus/router';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import { usePluginData } from '@docusaurus/useGlobalData';
-import useIsBrowser from "@docusaurus/useIsBrowser";
-const Search = props => {
+import useIsBrowser from '@docusaurus/useIsBrowser';
+const Search = (props) => {
   const initialized = useRef(false);
   const searchBarRef = useRef(null);
   const [indexReady, setIndexReady] = useState(false);
@@ -13,65 +13,62 @@ const Search = props => {
   const isBrowser = useIsBrowser();
   const { baseUrl } = siteConfig;
   const initAlgolia = (searchDocs, searchIndex, DocSearch) => {
-      new DocSearch({
-        searchDocs,
-        searchIndex,
-        baseUrl,
-        inputSelector: "#search_input_react",
-        // Override algolia's default selection event, allowing us to do client-side
-        // navigation and avoiding a full page refresh.
-        handleSelected: (_input, _event, suggestion) => {
-          const url = suggestion.url || "/";
-          // Use an anchor tag to parse the absolute url into a relative url
-          // Alternatively, we can use new URL(suggestion.url) but its not supported in IE
-          const a = document.createElement("a");
-          a.href = url;
-          // Algolia use closest parent element id #__docusaurus when a h1 page title does not have an id
-          // So, we can safely remove it. See https://github.com/facebook/docusaurus/issues/1828 for more details.
+    new DocSearch({
+      searchDocs,
+      searchIndex,
+      baseUrl,
+      inputSelector: '#search_input_react',
+      // Override algolia's default selection event, allowing us to do client-side
+      // navigation and avoiding a full page refresh.
+      handleSelected: (_input, _event, suggestion) => {
+        const url = suggestion.url || '/';
+        // Use an anchor tag to parse the absolute url into a relative url
+        // Alternatively, we can use new URL(suggestion.url) but its not supported in IE
+        const a = document.createElement('a');
+        a.href = url;
+        // Algolia use closest parent element id #__docusaurus when a h1 page title does not have an id
+        // So, we can safely remove it. See https://github.com/facebook/docusaurus/issues/1828 for more details.
 
-          history.push(url);
-        }
-      });
+        history.push(url);
+      },
+    });
   };
 
   const pluginData = usePluginData('docusaurus-lunr-search');
   const getSearchDoc = () =>
-    process.env.NODE_ENV === "production"
+    process.env.NODE_ENV === 'production'
       ? fetch(`${baseUrl}${pluginData.fileNames.searchDoc}`).then((content) => content.json())
       : Promise.resolve([]);
 
   const getLunrIndex = () =>
-    process.env.NODE_ENV === "production"
+    process.env.NODE_ENV === 'production'
       ? fetch(`${baseUrl}${pluginData.fileNames.lunrIndex}`).then((content) => content.json())
       : Promise.resolve([]);
 
   const loadAlgolia = () => {
     if (!initialized.current) {
-      Promise.all([
-        getSearchDoc(),
-        getLunrIndex(),
-        import("./DocSearch"),
-        import("./algolia.css")
-      ]).then(([searchDocs, searchIndex, { default: DocSearch }]) => {
-        if (searchDocs.length === 0) {
-          return;
-        }
-        initAlgolia(searchDocs, searchIndex, DocSearch);
-        setIndexReady(true);
-      });
+      Promise.all([getSearchDoc(), getLunrIndex(), import('./DocSearch'), import('./algolia.css')]).then(
+        ([searchDocs, searchIndex, { default: DocSearch }]) => {
+          if (searchDocs.length === 0) {
+            return;
+          }
+          initAlgolia(searchDocs, searchIndex, DocSearch);
+          setIndexReady(true);
+        },
+      );
       initialized.current = true;
     }
   };
 
   const toggleSearchIconClick = useCallback(
-    e => {
+    (e) => {
       if (!searchBarRef.current.contains(e.target)) {
         searchBarRef.current.focus();
       }
 
       props.handleSearchBarToggle && props.handleSearchBarToggle(!props.isSearchBarExpanded);
     },
-    [props.isSearchBarExpanded]
+    [props.isSearchBarExpanded],
   );
 
   if (isBrowser) {
@@ -83,8 +80,8 @@ const Search = props => {
       <span
         aria-label="expand searchbar"
         role="button"
-        className={classnames("search-icon", {
-          "search-icon-hidden": props.isSearchBarExpanded
+        className={classnames('search-icon', {
+          'search-icon-hidden': props.isSearchBarExpanded,
         })}
         onClick={toggleSearchIconClick}
         onKeyDown={toggleSearchIconClick}
@@ -96,9 +93,9 @@ const Search = props => {
         placeholder={indexReady ? 'Search' : 'Loading...'}
         aria-label="Search"
         className={classnames(
-          "navbar__search-input",
-          { "search-bar-expanded": props.isSearchBarExpanded },
-          { "search-bar": !props.isSearchBarExpanded }
+          'navbar__search-input',
+          { 'search-bar-expanded': props.isSearchBarExpanded },
+          { 'search-bar': !props.isSearchBarExpanded },
         )}
         onClick={loadAlgolia}
         onMouseOver={loadAlgolia}

docs/src/theme/SearchBar/lunar-search.js

@@ -1,147 +1,161 @@
-import lunr from "@generated/lunr.client";
+import lunr from '@generated/lunr.client';
 lunr.tokenizer.separator = /[\s\-/]+/;
 
 class LunrSearchAdapter {
-    constructor(searchDocs, searchIndex, baseUrl = '/') {
-        this.searchDocs = searchDocs;
-        this.lunrIndex = lunr.Index.load(searchIndex);
-        this.baseUrl = baseUrl;
-    }
+  constructor(searchDocs, searchIndex, baseUrl = '/') {
+    this.searchDocs = searchDocs;
+    this.lunrIndex = lunr.Index.load(searchIndex);
+    this.baseUrl = baseUrl;
+  }
 
-    getLunrResult(input) {
-        return this.lunrIndex.query(function (query) {
-            const tokens = lunr.tokenizer(input);
-            query.term(tokens, {
-                boost: 10
-            });
-            query.term(tokens, {
-                wildcard: lunr.Query.wildcard.TRAILING
-            });
-        });
-    }
+  getLunrResult(input) {
+    return this.lunrIndex.query(function (query) {
+      const tokens = lunr.tokenizer(input);
+      query.term(tokens, {
+        boost: 10,
+      });
+      query.term(tokens, {
+        wildcard: lunr.Query.wildcard.TRAILING,
+      });
+    });
+  }
 
-    getHit(doc, formattedTitle, formattedContent) {
-        return {
-            hierarchy: {
-                lvl0: doc.pageTitle || doc.title,
-                lvl1: doc.type === 0 ? null : doc.title
+  getHit(doc, formattedTitle, formattedContent) {
+    return {
+      hierarchy: {
+        lvl0: doc.pageTitle || doc.title,
+        lvl1: doc.type === 0 ? null : doc.title,
+      },
+      url: doc.url,
+      _snippetResult: formattedContent
+        ? {
+            content: {
+              value: formattedContent,
+              matchLevel: 'full',
             },
-            url: doc.url,
-            _snippetResult: formattedContent ? {
-                content: {
-                    value: formattedContent,
-                    matchLevel: "full"
-                }
-            } : null,
-            _highlightResult: {
-                hierarchy: {
-                    lvl0: {
-                        value: doc.type === 0 ? formattedTitle || doc.title : doc.pageTitle,
-                    },
-                    lvl1:
-                        doc.type === 0
-                            ? null
-                            : {
-                                value: formattedTitle || doc.title
-                            }
-                }
-            }
-        };
-    }
-    getTitleHit(doc, position, length) {
-        const start = position[0];
-        const end = position[0] + length;
-        let formattedTitle = doc.title.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.title.substring(start, end) + '</span>' + doc.title.substring(end, doc.title.length);
-        return this.getHit(doc, formattedTitle)
-    }
+          }
+        : null,
+      _highlightResult: {
+        hierarchy: {
+          lvl0: {
+            value: doc.type === 0 ? formattedTitle || doc.title : doc.pageTitle,
+          },
+          lvl1:
+            doc.type === 0
+              ? null
+              : {
+                  value: formattedTitle || doc.title,
+                },
+        },
+      },
+    };
+  }
+  getTitleHit(doc, position, length) {
+    const start = position[0];
+    const end = position[0] + length;
+    let formattedTitle =
+      doc.title.substring(0, start) +
+      '<span class="algolia-docsearch-suggestion--highlight">' +
+      doc.title.substring(start, end) +
+      '</span>' +
+      doc.title.substring(end, doc.title.length);
+    return this.getHit(doc, formattedTitle);
+  }
 
-    getKeywordHit(doc, position, length) {
-        const start = position[0];
-        const end = position[0] + length;
-        let formattedTitle = doc.title + '<br /><i>Keywords: ' + doc.keywords.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.keywords.substring(start, end) + '</span>' + doc.keywords.substring(end, doc.keywords.length) + '</i>'
-        return this.getHit(doc, formattedTitle)
-    }
-
-    getContentHit(doc, position) {
-        const start = position[0];
-        const end = position[0] + position[1];
-        let previewStart = start;
-        let previewEnd = end;
-        let ellipsesBefore = true;
-        let ellipsesAfter = true;
-        for (let k = 0; k < 3; k++) {
-            const nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
-            const nextDot = doc.content.lastIndexOf('.', previewStart - 2);
-            if ((nextDot > 0) && (nextDot > nextSpace)) {
-                previewStart = nextDot + 1;
-                ellipsesBefore = false;
-                break;
-            }
-            if (nextSpace < 0) {
-                previewStart = 0;
-                ellipsesBefore = false;
-                break;
-            }
-            previewStart = nextSpace + 1;
-        }
-        for (let k = 0; k < 10; k++) {
-            const nextSpace = doc.content.indexOf(' ', previewEnd + 1);
-            const nextDot = doc.content.indexOf('.', previewEnd + 1);
-            if ((nextDot > 0) && (nextDot < nextSpace)) {
-                previewEnd = nextDot;
-                ellipsesAfter = false;
-                break;
-            }
-            if (nextSpace < 0) {
-                previewEnd = doc.content.length;
-                ellipsesAfter = false;
-                break;
-            }
-            previewEnd = nextSpace;
-        }
-        let preview = doc.content.substring(previewStart, start);
-        if (ellipsesBefore) {
-            preview = '... ' + preview;
-        }
-        preview += '<span class="algolia-docsearch-suggestion--highlight">' + doc.content.substring(start, end) + '</span>';
-        preview += doc.content.substring(end, previewEnd);
-        if (ellipsesAfter) {
-            preview += ' ...';
-        }
-        return this.getHit(doc, null, preview);
+  getKeywordHit(doc, position, length) {
+    const start = position[0];
+    const end = position[0] + length;
+    let formattedTitle =
+      doc.title +
+      '<br /><i>Keywords: ' +
+      doc.keywords.substring(0, start) +
+      '<span class="algolia-docsearch-suggestion--highlight">' +
+      doc.keywords.substring(start, end) +
+      '</span>' +
+      doc.keywords.substring(end, doc.keywords.length) +
+      '</i>';
+    return this.getHit(doc, formattedTitle);
+  }
 
+  getContentHit(doc, position) {
+    const start = position[0];
+    const end = position[0] + position[1];
+    let previewStart = start;
+    let previewEnd = end;
+    let ellipsesBefore = true;
+    let ellipsesAfter = true;
+    for (let k = 0; k < 3; k++) {
+      const nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
+      const nextDot = doc.content.lastIndexOf('.', previewStart - 2);
+      if (nextDot > 0 && nextDot > nextSpace) {
+        previewStart = nextDot + 1;
+        ellipsesBefore = false;
+        break;
+      }
+      if (nextSpace < 0) {
+        previewStart = 0;
+        ellipsesBefore = false;
+        break;
+      }
+      previewStart = nextSpace + 1;
     }
-    search(input) {
-        return new Promise((resolve, rej) => {
-            const results = this.getLunrResult(input);
-            const hits = [];
-            results.length > 5 && (results.length = 5);
-            this.titleHitsRes = []
-            this.contentHitsRes = []
-            results.forEach(result => {
-                const doc = this.searchDocs[result.ref];
-                const { metadata } = result.matchData;
-                for (let i in metadata) {
-                    if (metadata[i].title) {
-                        if (!this.titleHitsRes.includes(result.ref)) {
-                            const position = metadata[i].title.position[0]
-                            hits.push(this.getTitleHit(doc, position, input.length));
-                            this.titleHitsRes.push(result.ref);
-                        }
-                    } else if (metadata[i].content) {
-                        const position = metadata[i].content.position[0]
-                        hits.push(this.getContentHit(doc, position))
-                    } else if (metadata[i].keywords) {
-                        const position = metadata[i].keywords.position[0]
-                        hits.push(this.getKeywordHit(doc, position, input.length));
-                        this.titleHitsRes.push(result.ref);
-                    }
-                }
-            });
-            hits.length > 5 && (hits.length = 5);
-            resolve(hits);
-        });
+    for (let k = 0; k < 10; k++) {
+      const nextSpace = doc.content.indexOf(' ', previewEnd + 1);
+      const nextDot = doc.content.indexOf('.', previewEnd + 1);
+      if (nextDot > 0 && nextDot < nextSpace) {
+        previewEnd = nextDot;
+        ellipsesAfter = false;
+        break;
+      }
+      if (nextSpace < 0) {
+        previewEnd = doc.content.length;
+        ellipsesAfter = false;
+        break;
+      }
+      previewEnd = nextSpace;
     }
+    let preview = doc.content.substring(previewStart, start);
+    if (ellipsesBefore) {
+      preview = '... ' + preview;
+    }
+    preview += '<span class="algolia-docsearch-suggestion--highlight">' + doc.content.substring(start, end) + '</span>';
+    preview += doc.content.substring(end, previewEnd);
+    if (ellipsesAfter) {
+      preview += ' ...';
+    }
+    return this.getHit(doc, null, preview);
+  }
+  search(input) {
+    return new Promise((resolve, rej) => {
+      const results = this.getLunrResult(input);
+      const hits = [];
+      results.length > 5 && (results.length = 5);
+      this.titleHitsRes = [];
+      this.contentHitsRes = [];
+      results.forEach((result) => {
+        const doc = this.searchDocs[result.ref];
+        const { metadata } = result.matchData;
+        for (let i in metadata) {
+          if (metadata[i].title) {
+            if (!this.titleHitsRes.includes(result.ref)) {
+              const position = metadata[i].title.position[0];
+              hits.push(this.getTitleHit(doc, position, input.length));
+              this.titleHitsRes.push(result.ref);
+            }
+          } else if (metadata[i].content) {
+            const position = metadata[i].content.position[0];
+            hits.push(this.getContentHit(doc, position));
+          } else if (metadata[i].keywords) {
+            const position = metadata[i].keywords.position[0];
+            hits.push(this.getKeywordHit(doc, position, input.length));
+            this.titleHitsRes.push(result.ref);
+          }
+        }
+      });
+      hits.length > 5 && (hits.length = 5);
+      resolve(hits);
+    });
+  }
 }
 
 export default LunrSearchAdapter;

docs/src/theme/SearchBar/utils.js

@@ -1,27 +1,27 @@
-import $ from "autocomplete.js/zepto";
+import $ from 'autocomplete.js/zepto';
 
 const utils = {
   /*
-  * Move the content of an object key one level higher.
-  * eg.
-  * {
-  *   name: 'My name',
-  *   hierarchy: {
-  *     lvl0: 'Foo',
-  *     lvl1: 'Bar'
-  *   }
-  * }
-  * Will be converted to
-  * {
-  *   name: 'My name',
-  *   lvl0: 'Foo',
-  *   lvl1: 'Bar'
-  * }
-  * @param {Object} object Main object
-  * @param {String} property Main object key to move up
-  * @return {Object}
-  * @throws Error when key is not an attribute of Object or is not an object itself
-  */
+   * Move the content of an object key one level higher.
+   * eg.
+   * {
+   *   name: 'My name',
+   *   hierarchy: {
+   *     lvl0: 'Foo',
+   *     lvl1: 'Bar'
+   *   }
+   * }
+   * Will be converted to
+   * {
+   *   name: 'My name',
+   *   lvl0: 'Foo',
+   *   lvl1: 'Bar'
+   * }
+   * @param {Object} object Main object
+   * @param {String} property Main object key to move up
+   * @return {Object}
+   * @throws Error when key is not an attribute of Object or is not an object itself
+   */
   mergeKeyWithParent(object, property) {
     if (object[property] === undefined) {
       return object;
@@ -34,36 +34,36 @@ const utils = {
     return newObject;
   },
   /*
-  * Group all objects of a collection by the value of the specified attribute
-  * If the attribute is a string, use the lowercase form.
-  *
-  * eg.
-  * groupBy([
-  *   {name: 'Tim', category: 'dev'},
-  *   {name: 'Vincent', category: 'dev'},
-  *   {name: 'Ben', category: 'sales'},
-  *   {name: 'Jeremy', category: 'sales'},
-  *   {name: 'AlexS', category: 'dev'},
-  *   {name: 'AlexK', category: 'sales'}
-  * ], 'category');
-  * =>
-  * {
-  *   'devs': [
-  *     {name: 'Tim', category: 'dev'},
-  *     {name: 'Vincent', category: 'dev'},
-  *     {name: 'AlexS', category: 'dev'}
-  *   ],
-  *   'sales': [
-  *     {name: 'Ben', category: 'sales'},
-  *     {name: 'Jeremy', category: 'sales'},
-  *     {name: 'AlexK', category: 'sales'}
-  *   ]
-  * }
-  * @param {array} collection Array of objects to group
-  * @param {String} property The attribute on which apply the grouping
-  * @return {array}
-  * @throws Error when one of the element does not have the specified property
-  */
+   * Group all objects of a collection by the value of the specified attribute
+   * If the attribute is a string, use the lowercase form.
+   *
+   * eg.
+   * groupBy([
+   *   {name: 'Tim', category: 'dev'},
+   *   {name: 'Vincent', category: 'dev'},
+   *   {name: 'Ben', category: 'sales'},
+   *   {name: 'Jeremy', category: 'sales'},
+   *   {name: 'AlexS', category: 'dev'},
+   *   {name: 'AlexK', category: 'sales'}
+   * ], 'category');
+   * =>
+   * {
+   *   'devs': [
+   *     {name: 'Tim', category: 'dev'},
+   *     {name: 'Vincent', category: 'dev'},
+   *     {name: 'AlexS', category: 'dev'}
+   *   ],
+   *   'sales': [
+   *     {name: 'Ben', category: 'sales'},
+   *     {name: 'Jeremy', category: 'sales'},
+   *     {name: 'AlexK', category: 'sales'}
+   *   ]
+   * }
+   * @param {array} collection Array of objects to group
+   * @param {String} property The attribute on which apply the grouping
+   * @return {array}
+   * @throws Error when one of the element does not have the specified property
+   */
   groupBy(collection, property) {
     const newCollection = {};
     $.each(collection, (index, item) => {
@@ -84,94 +84,94 @@ const utils = {
     return newCollection;
   },
   /*
-  * Return an array of all the values of the specified object
-  * eg.
-  * values({
-  *   foo: 42,
-  *   bar: true,
-  *   baz: 'yep'
-  * })
-  * =>
-  * [42, true, yep]
-  * @param {object} object Object to extract values from
-  * @return {array}
-  */
+   * Return an array of all the values of the specified object
+   * eg.
+   * values({
+   *   foo: 42,
+   *   bar: true,
+   *   baz: 'yep'
+   * })
+   * =>
+   * [42, true, yep]
+   * @param {object} object Object to extract values from
+   * @return {array}
+   */
   values(object) {
-    return Object.keys(object).map(key => object[key]);
+    return Object.keys(object).map((key) => object[key]);
   },
   /*
-  * Flattens an array
-  * eg.
-  * flatten([1, 2, [3, 4], [5, 6]])
-  * =>
-  * [1, 2, 3, 4, 5, 6]
-  * @param {array} array Array to flatten
-  * @return {array}
-  */
+   * Flattens an array
+   * eg.
+   * flatten([1, 2, [3, 4], [5, 6]])
+   * =>
+   * [1, 2, 3, 4, 5, 6]
+   * @param {array} array Array to flatten
+   * @return {array}
+   */
   flatten(array) {
     const results = [];
-    array.forEach(value => {
+    array.forEach((value) => {
       if (!Array.isArray(value)) {
         results.push(value);
         return;
       }
-      value.forEach(subvalue => {
+      value.forEach((subvalue) => {
         results.push(subvalue);
       });
     });
     return results;
   },
   /*
-  * Flatten all values of an object into an array, marking each first element of
-  * each group with a specific flag
-  * eg.
-  * flattenAndFlagFirst({
-  *   'devs': [
-  *     {name: 'Tim', category: 'dev'},
-  *     {name: 'Vincent', category: 'dev'},
-  *     {name: 'AlexS', category: 'dev'}
-  *   ],
-  *   'sales': [
-  *     {name: 'Ben', category: 'sales'},
-  *     {name: 'Jeremy', category: 'sales'},
-  *     {name: 'AlexK', category: 'sales'}
-  *   ]
-  * , 'isTop');
-  * =>
-  * [
-  *     {name: 'Tim', category: 'dev', isTop: true},
-  *     {name: 'Vincent', category: 'dev', isTop: false},
-  *     {name: 'AlexS', category: 'dev', isTop: false},
-  *     {name: 'Ben', category: 'sales', isTop: true},
-  *     {name: 'Jeremy', category: 'sales', isTop: false},
-  *     {name: 'AlexK', category: 'sales', isTop: false}
-  * ]
-  * @param {object} object Object to flatten
-  * @param {string} flag Flag to set to true on first element of each group
-  * @return {array}
-  */
+   * Flatten all values of an object into an array, marking each first element of
+   * each group with a specific flag
+   * eg.
+   * flattenAndFlagFirst({
+   *   'devs': [
+   *     {name: 'Tim', category: 'dev'},
+   *     {name: 'Vincent', category: 'dev'},
+   *     {name: 'AlexS', category: 'dev'}
+   *   ],
+   *   'sales': [
+   *     {name: 'Ben', category: 'sales'},
+   *     {name: 'Jeremy', category: 'sales'},
+   *     {name: 'AlexK', category: 'sales'}
+   *   ]
+   * , 'isTop');
+   * =>
+   * [
+   *     {name: 'Tim', category: 'dev', isTop: true},
+   *     {name: 'Vincent', category: 'dev', isTop: false},
+   *     {name: 'AlexS', category: 'dev', isTop: false},
+   *     {name: 'Ben', category: 'sales', isTop: true},
+   *     {name: 'Jeremy', category: 'sales', isTop: false},
+   *     {name: 'AlexK', category: 'sales', isTop: false}
+   * ]
+   * @param {object} object Object to flatten
+   * @param {string} flag Flag to set to true on first element of each group
+   * @return {array}
+   */
   flattenAndFlagFirst(object, flag) {
-    const values = this.values(object).map(collection =>
+    const values = this.values(object).map((collection) =>
       collection.map((item, index) => {
         // eslint-disable-next-line no-param-reassign
         item[flag] = index === 0;
         return item;
-      })
+      }),
     );
     return this.flatten(values);
   },
   /*
-  * Removes all empty strings, null, false and undefined elements array
-  * eg.
-  * compact([42, false, null, undefined, '', [], 'foo']);
-  * =>
-  * [42, [], 'foo']
-  * @param {array} array Array to compact
-  * @return {array}
-  */
+   * Removes all empty strings, null, false and undefined elements array
+   * eg.
+   * compact([42, false, null, undefined, '', [], 'foo']);
+   * =>
+   * [42, [], 'foo']
+   * @param {array} array Array to compact
+   * @return {array}
+   */
   compact(array) {
     const results = [];
-    array.forEach(value => {
+    array.forEach((value) => {
       if (!value) {
         return;
       }
@@ -239,11 +239,7 @@ const utils = {
    * @return {string}
    **/
   getSnippetedValue(object, property) {
-    if (
-      !object._snippetResult ||
-      !object._snippetResult[property] ||
-      !object._snippetResult[property].value
-    ) {
+    if (!object._snippetResult || !object._snippetResult[property] || !object._snippetResult[property].value) {
       return object[property];
     }
     let snippet = object._snippetResult[property].value;
@@ -257,11 +253,11 @@ const utils = {
     return snippet;
   },
   /*
-  * Deep clone an object.
-  * Note: This will not clone functions and dates
-  * @param {object} object Object to clone
-  * @return {object}
-  */
+   * Deep clone an object.
+   * Note: This will not clone functions and dates
+   * @param {object} object Object to clone
+   * @return {object}
+   */
   deepClone(object) {
     return JSON.parse(JSON.stringify(object));
   },

docs/tailwind.config.js

@@ -4,25 +4,25 @@ module.exports = {
   corePlugins: {
     preflight: false, // disable Tailwind's reset
   },
-  content: ["./src/**/*.{js,jsx,ts,tsx}", "../docs/**/*.mdx"], // my markdown stuff is in ../docs, not /src
-  darkMode: ["class", '[data-theme="dark"]'], // hooks into docusaurus' dark mode settigns
+  content: ['./src/**/*.{js,jsx,ts,tsx}', '../docs/**/*.mdx'], // my markdown stuff is in ../docs, not /src
+  darkMode: ['class', '[data-theme="dark"]'], // hooks into docusaurus' dark mode settigns
   theme: {
     extend: {
       colors: {
         // Light Theme
-        "immich-primary": "#4250af",
-        "immich-bg": "white",
-        "immich-fg": "black",
-        "immich-gray": "#F6F6F4",
+        'immich-primary': '#4250af',
+        'immich-bg': 'white',
+        'immich-fg': 'black',
+        'immich-gray': '#F6F6F4',
 
         // Dark Theme
-        "immich-dark-primary": "#adcbfa",
-        "immich-dark-bg": "black",
-        "immich-dark-fg": "#e5e7eb",
-        "immich-dark-gray": "#212121",
+        'immich-dark-primary': '#adcbfa',
+        'immich-dark-bg': 'black',
+        'immich-dark-fg': '#e5e7eb',
+        'immich-dark-gray': '#212121',
       },
       fontFamily: {
-        "immich-title": ["Snowburst One", "cursive"],
+        'immich-title': ['Snowburst One', 'cursive'],
       },
     },
   },

docs/vercel.json

@@ -22,6 +22,7 @@
     { "source": "/docs/features/password-login", "destination": "/docs/administration/password-login" },
     { "source": "/docs/features/server-commands", "destination": "/docs/administration/server-commands" },
     { "source": "/docs/features/storage-template", "destination": "/docs/administration/storage-template" },
-    { "source": "/docs/features/user-management", "destination": "/docs/administration/user-management" }
+    { "source": "/docs/features/user-management", "destination": "/docs/administration/user-management" },
+    { "source": "/docs/developer/contributing", "destination": "/docs/developer/pr-checklist" }
   ]
 }

machine-learning/.dockerignore

@@ -1 +1,3 @@
-venv/
+venv/
+*.zip
+*.onnx

machine-learning/.gitignore

@@ -3,4 +3,170 @@
 upload/
 venv/
 __pycache__/
-model-cache/
+model-cache/
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+
+*.onnx
+*.zip

machine-learning/Dockerfile

@@ -1,27 +1,28 @@
-FROM python:3.10 as builder
+FROM python:3.11.4-bullseye@sha256:5b401676aff858495a5c9c726c60b8b73fe52833e9e16eccdb59e93d52741727 as builder
 
 ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    PIP_NO_CACHE_DIR=true
+  PYTHONUNBUFFERED=1 \
+  PIP_NO_CACHE_DIR=true
 
+RUN pip install --upgrade pip && pip install poetry
+RUN poetry config installer.max-workers 10 && \
+  poetry config virtualenvs.create false
 RUN python -m venv /opt/venv
-RUN /opt/venv/bin/pip install --pre torch  -f https://download.pytorch.org/whl/nightly/cpu/torch_nightly.html
-RUN /opt/venv/bin/pip install transformers tqdm numpy scikit-learn scipy nltk sentencepiece flask Pillow gunicorn
-RUN /opt/venv/bin/pip install --no-deps sentence-transformers
+ENV VIRTUAL_ENV="/opt/venv" PATH="/opt/venv/bin:${PATH}"
 
-FROM python:3.10-slim
+COPY poetry.lock pyproject.toml ./
+RUN poetry install --sync --no-interaction --no-ansi --no-root --only main
 
-ENV NODE_ENV=production
-
-COPY --from=builder /opt/venv /opt/venv
-
-ENV TRANSFORMERS_CACHE=/cache \
-    PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    PATH="/opt/venv/bin:$PATH"
+FROM python:3.11.4-slim-bullseye@sha256:91d194f58f50594cda71dcd2e8fdefd90e7ecc57d07823813b67c8521e565dcd
 
 WORKDIR /usr/src/app
+ENV NODE_ENV=production \
+  TRANSFORMERS_CACHE=/cache \
+  PYTHONDONTWRITEBYTECODE=1 \
+  PYTHONUNBUFFERED=1 \
+  PATH="/opt/venv/bin:$PATH" \
+  PYTHONPATH=`pwd`
 
-COPY . .
-
-CMD ["gunicorn", "src.main:server"]
+COPY --from=builder /opt/venv /opt/venv
+COPY app .
+ENTRYPOINT ["python", "main.py"]

machine-learning/README.md

@@ -1,5 +1,13 @@
-
 # Immich Machine Learning
 
-- Object Detection
-- Image Classification
+- Image classification
+- CLIP embeddings
+- Facial recognition
+
+# Setup
+
+This project uses [Poetry](https://python-poetry.org/docs/#installation), so be sure to install it first.
+Running `poetry install --no-root --with dev` will install everything you need in an isolated virtual environment.
+
+To add or remove dependencies, you can use the commands `poetry add $PACKAGE_NAME` and `poetry remove $PACKAGE_NAME`, respectively.
+Be sure to commit the `poetry.lock` and `pyproject.toml` files to reflect any changes in dependencies.

machine-learning/app/cache.py

@@ -0,0 +1,84 @@
+from aiocache.plugins import TimingPlugin, BasePlugin
+from aiocache.backends.memory import SimpleMemoryCache
+from aiocache.lock import OptimisticLock
+from typing import Any
+from models import get_model
+
+
+class ModelCache:
+    """Fetches a model from an in-memory cache, instantiating it if it's missing."""
+
+    def __init__(
+        self,
+        ttl: int | None = None,
+        revalidate: bool = False,
+        timeout: int | None = None,
+        profiling: bool = False,
+    ):
+        """
+        Args:
+            ttl: Unloads model after this duration. Disabled if None. Defaults to None.
+            revalidate: Resets TTL on cache hit. Useful to keep models in memory while active. Defaults to False.
+            timeout: Maximum allowed time for model to load. Disabled if None. Defaults to None.
+            profiling: Collects metrics for cache operations, adding slight overhead. Defaults to False.
+        """
+
+        self.ttl = ttl
+        plugins = []
+
+        if revalidate:
+            plugins.append(RevalidationPlugin())
+        if profiling:
+            plugins.append(TimingPlugin())
+
+        self.cache = SimpleMemoryCache(
+            ttl=ttl, timeout=timeout, plugins=plugins, namespace=None
+        )
+
+    async def get_cached_model(
+        self, model_name: str, model_type: str, **model_kwargs
+    ) -> Any:
+        """
+        Args:
+            model_name: Name of model in the model hub used for the task.
+            model_type: Model type or task, which determines which model zoo is used.
+
+        Returns:
+            model: The requested model.
+        """
+
+        key = self.cache.build_key(model_name, model_type)
+        model = await self.cache.get(key)
+        if model is None:
+            async with OptimisticLock(self.cache, key) as lock:
+                model = get_model(model_name, model_type, **model_kwargs)
+                await lock.cas(model, ttl=self.ttl)
+        return model
+
+    async def get_profiling(self) -> dict[str, float] | None:
+        if not hasattr(self.cache, "profiling"):
+            return None
+
+        return self.cache.profiling  # type: ignore
+
+
+class RevalidationPlugin(BasePlugin):
+    """Revalidates cache item's TTL after cache hit."""
+
+    async def post_get(self, client, key, ret=None, namespace=None, **kwargs):
+        if ret is None:
+            return
+        if namespace is not None:
+            key = client.build_key(key, namespace)
+        if key in client._handlers:
+            await client.expire(key, client.ttl)
+
+    async def post_multi_get(self, client, keys, ret=None, namespace=None, **kwargs):
+        if ret is None:
+            return
+
+        for key, val in zip(keys, ret):
+            if namespace is not None:
+                key = client.build_key(key, namespace)
+            if val is not None and key in client._handlers:
+                await client.expire(key, client.ttl)

machine-learning/app/config.py

@@ -0,0 +1,22 @@
+from pydantic import BaseSettings
+
+class Settings(BaseSettings):
+    cache_folder: str = "/cache"
+    classification_model: str = "microsoft/resnet-50"
+    clip_image_model: str = "clip-ViT-B-32"
+    clip_text_model: str = "clip-ViT-B-32"
+    facial_recognition_model: str = "buffalo_l"
+    min_tag_score: float = 0.9
+    eager_startup: bool = True
+    model_ttl: int = 300
+    host: str = "0.0.0.0"
+    port: int = 3003
+    workers: int = 1
+    min_face_score: float = 0.7
+
+    class Config(BaseSettings.Config):
+        env_prefix = 'MACHINE_LEARNING_'
+        case_sensitive = False
+
+
+settings = Settings()

machine-learning/app/main.py

@@ -0,0 +1,133 @@
+import os
+import io
+from typing import Any
+
+from cache import ModelCache
+from schemas import (
+    EmbeddingResponse,
+    FaceResponse,
+    TagResponse,
+    MessageResponse,
+    TextModelRequest,
+    TextResponse,
+)
+import uvicorn
+from PIL import Image
+from fastapi import FastAPI, HTTPException, Depends, Body
+from models import get_model, run_classification, run_facial_recognition
+from config import settings
+
+_model_cache = None
+
+app = FastAPI()
+
+
+@app.on_event("startup")
+async def startup_event() -> None:
+    global _model_cache
+    _model_cache = ModelCache(ttl=settings.model_ttl, revalidate=True)
+    models = [
+        (settings.classification_model, "image-classification"),
+        (settings.clip_image_model, "clip"),
+        (settings.clip_text_model, "clip"),
+        (settings.facial_recognition_model, "facial-recognition"),
+    ]
+
+    # Get all models
+    for model_name, model_type in models:
+        if settings.eager_startup:
+            await _model_cache.get_cached_model(model_name, model_type)
+        else:
+            get_model(model_name, model_type)
+
+
+def dep_model_cache():
+    if _model_cache is None:
+        raise HTTPException(status_code=500, detail="Unable to load model.")
+
+def dep_input_image(image: bytes = Body(...)) -> Image:
+    return Image.open(io.BytesIO(image))
+
+@app.get("/", response_model=MessageResponse)
+async def root() -> dict[str, str]:
+    return {"message": "Immich ML"}
+
+
+@app.get("/ping", response_model=TextResponse)
+def ping() -> str:
+    return "pong"
+
+
+@app.post(
+    "/image-classifier/tag-image",
+    response_model=TagResponse,
+    status_code=200,
+    dependencies=[Depends(dep_model_cache)],
+)
+async def image_classification(
+    image: Image = Depends(dep_input_image)
+) -> list[str]:
+    try:
+        model = await _model_cache.get_cached_model(
+            settings.classification_model, "image-classification"
+        )
+        labels = run_classification(model, image, settings.min_tag_score)
+    except Exception as ex:
+        raise HTTPException(status_code=500, detail=str(ex))
+    else:
+        return labels
+
+
+@app.post(
+    "/sentence-transformer/encode-image",
+    response_model=EmbeddingResponse,
+    status_code=200,
+    dependencies=[Depends(dep_model_cache)],
+)
+async def clip_encode_image(
+    image: Image = Depends(dep_input_image)
+) -> list[float]:
+    model = await _model_cache.get_cached_model(settings.clip_image_model, "clip")
+    embedding = model.encode(image).tolist()
+    return embedding
+
+
+@app.post(
+    "/sentence-transformer/encode-text",
+    response_model=EmbeddingResponse,
+    status_code=200,
+    dependencies=[Depends(dep_model_cache)],
+)
+async def clip_encode_text(
+    payload: TextModelRequest
+) -> list[float]:
+    model = await _model_cache.get_cached_model(settings.clip_text_model, "clip")
+    embedding = model.encode(payload.text).tolist()
+    return embedding
+
+
+@app.post(
+    "/facial-recognition/detect-faces",
+    response_model=FaceResponse,
+    status_code=200,
+    dependencies=[Depends(dep_model_cache)],
+)
+async def facial_recognition(
+    image: bytes = Body(...),
+) -> list[dict[str, Any]]:
+    model = await _model_cache.get_cached_model(
+        settings.facial_recognition_model, "facial-recognition"
+    )
+    faces = run_facial_recognition(model, image)
+    return faces
+
+
+if __name__ == "__main__":
+    is_dev = os.getenv("NODE_ENV") == "development"
+    uvicorn.run(
+        "main:app",
+        host=settings.host,
+        port=settings.port,
+        reload=is_dev,
+        workers=settings.workers,
+    )

machine-learning/app/models.py

@@ -0,0 +1,119 @@
+import torch
+from insightface.app import FaceAnalysis
+from pathlib import Path
+
+from transformers import pipeline, Pipeline
+from sentence_transformers import SentenceTransformer
+from typing import Any, BinaryIO
+import cv2 as cv
+import numpy as np
+from PIL import Image
+from config import settings
+
+device = "cuda" if torch.cuda.is_available() else "cpu"
+
+
+def get_model(model_name: str, model_type: str, **model_kwargs):
+    """
+    Instantiates the specified model.
+
+    Args:
+        model_name: Name of model in the model hub used for the task.
+        model_type: Model type or task, which determines which model zoo is used.
+            `facial-recognition` uses Insightface, while all other models use the HF Model Hub.
+
+            Options:
+                `image-classification`, `clip`,`facial-recognition`, `tokenizer`, `processor`
+
+    Returns:
+        model: The requested model.
+    """
+
+    cache_dir = _get_cache_dir(model_name, model_type)
+    match model_type:
+        case "facial-recognition":
+            model = _load_facial_recognition(
+                model_name, cache_dir=cache_dir, **model_kwargs
+            )
+        case "clip":
+            model = SentenceTransformer(
+                model_name, cache_folder=cache_dir, **model_kwargs
+            )
+        case _:
+            model = pipeline(
+                model_type,
+                model_name,
+                model_kwargs={"cache_dir": cache_dir, **model_kwargs},
+            )
+
+    return model
+
+
+def run_classification(
+    model: Pipeline, image: Image, min_score: float | None = None
+):
+    predictions: list[dict[str, Any]] = model(image)  # type: ignore
+    result = {
+        tag
+        for pred in predictions
+        for tag in pred["label"].split(", ")
+        if min_score is None or pred["score"] >= min_score
+    }
+
+    return list(result)
+
+
+def run_facial_recognition(
+    model: FaceAnalysis, image: bytes
+) -> list[dict[str, Any]]:
+    file_bytes = np.frombuffer(image, dtype=np.uint8)
+    img = cv.imdecode(file_bytes, cv.IMREAD_COLOR)
+    height, width, _ = img.shape
+    results = []
+    faces = model.get(img)
+
+    for face in faces:
+        x1, y1, x2, y2 = face.bbox
+
+        results.append(
+            {
+                "imageWidth": width,
+                "imageHeight": height,
+                "boundingBox": {
+                    "x1": round(x1),
+                    "y1": round(y1),
+                    "x2": round(x2),
+                    "y2": round(y2),
+                },
+                "score": face.det_score.item(),
+                "embedding": face.normed_embedding.tolist(),
+            }
+        )
+    return results
+
+
+def _load_facial_recognition(
+    model_name: str,
+    min_face_score: float | None = None,
+    cache_dir: Path | str | None = None,
+    **model_kwargs,
+):
+    if cache_dir is None:
+        cache_dir = _get_cache_dir(model_name, "facial-recognition")
+    if isinstance(cache_dir, Path):
+        cache_dir = cache_dir.as_posix()
+    if min_face_score is None:
+        min_face_score = settings.min_face_score
+
+    model = FaceAnalysis(
+        name=model_name,
+        root=cache_dir,
+        allowed_modules=["detection", "recognition"],
+        **model_kwargs,
+    )
+    model.prepare(ctx_id=0, det_thresh=min_face_score, det_size=(640, 640))
+    return model
+
+
+def _get_cache_dir(model_name: str, model_type: str) -> Path:
+    return Path(settings.cache_folder, device, model_type, model_name)

machine-learning/app/schemas.py

@@ -0,0 +1,56 @@
+from pydantic import BaseModel
+
+
+def to_lower_camel(string: str) -> str:
+    tokens = [
+        token.capitalize() if i > 0 else token
+        for i, token in enumerate(string.split("_"))
+    ]
+    return "".join(tokens)
+
+
+class TextModelRequest(BaseModel):
+    text: str
+
+
+class TextResponse(BaseModel):
+    __root__: str
+
+
+class MessageResponse(BaseModel):
+    message: str
+
+
+class TagResponse(BaseModel):
+    __root__: list[str]
+
+
+class Embedding(BaseModel):
+    __root__: list[float]
+
+
+class EmbeddingResponse(BaseModel):
+    __root__: Embedding
+
+
+class BoundingBox(BaseModel):
+    x1: int
+    y1: int
+    x2: int
+    y2: int
+
+
+class Face(BaseModel):
+    image_width: int
+    image_height: int
+    bounding_box: BoundingBox
+    score: float
+    embedding: Embedding
+
+    class Config:
+        alias_generator = to_lower_camel
+        allow_population_by_field_name = True
+
+
+class FaceResponse(BaseModel):
+    __root__: list[Face]

machine-learning/gunicorn.conf.py

@@ -1,29 +0,0 @@
-"""
-Gunicorn configuration options.
-https://docs.gunicorn.org/en/stable/settings.html
-"""
-import os
-
-
-# Set the bind address based on the env
-port = os.getenv("MACHINE_LEARNING_PORT") or "3003"
-listen_ip = os.getenv("MACHINE_LEARNING_IP") or "0.0.0.0"
-bind = [f"{listen_ip}:{port}"]
-
-# Preload the Flask app / models etc. before starting the server
-preload_app = True
-
-# Logging settings - log to stdout and set log level
-accesslog = "-"
-loglevel = os.getenv("MACHINE_LEARNING_LOG_LEVEL") or "info"
-
-# Worker settings
-# ----------------------
-# It is important these are chosen carefully as per
-# https://pythonspeed.com/articles/gunicorn-in-docker/
-# Otherwise we get workers failing to respond to heartbeat checks,
-# especially as requests take a long time to complete.
-workers = 2
-threads = 4
-worker_tmp_dir = "/dev/shm"
-timeout = 60

machine-learning/pyproject.toml

@@ -0,0 +1,57 @@
+[tool.poetry]
+name = "machine-learning"
+version = "1.59.1"
+description = ""
+authors = ["Hau Tran <alex.tran1502@gmail.com>"]
+readme = "README.md"
+packages = [{include = "app"}]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+torch = [
+    {markers = "platform_machine == 'arm64' or platform_machine == 'aarch64'", version = "=2.0.1", source = "pypi"},
+    {markers = "platform_machine == 'amd64' or platform_machine == 'x86_64'", version = "=2.0.1", source = "pytorch-cpu"}
+]
+transformers = "^4.29.2"
+sentence-transformers = "^2.2.2"
+onnxruntime = "^1.15.0"
+insightface = "^0.7.3"
+opencv-python-headless = "^4.7.0.72"
+pillow = "^9.5.0"
+fastapi = "^0.95.2"
+uvicorn = {extras = ["standard"], version = "^0.22.0"}
+pydantic = "^1.10.8"
+aiocache = "^0.12.1"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.3.0"
+black = "^23.3.0"
+pytest = "^7.3.1"
+
+[[tool.poetry.source]]
+name = "pytorch-cpu"
+url = "https://download.pytorch.org/whl/cpu"
+priority = "explicit"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.flake8]
+max-line-length = 120
+
+[tool.mypy]
+python_version = "3.11"
+plugins = "pydantic.mypy"
+follow_imports = "silent"
+warn_redundant_casts = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+disallow_untyped_defs = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+warn_untyped_fields = true

machine-learning/src/main.py

@@ -1,73 +0,0 @@
-import os
-from flask import Flask, request
-from transformers import pipeline
-from sentence_transformers import SentenceTransformer, util
-from PIL import Image
-
-is_dev = os.getenv('NODE_ENV') == 'development'
-server_port = os.getenv('MACHINE_LEARNING_PORT', 3003)
-server_host = os.getenv('MACHINE_LEARNING_HOST', '0.0.0.0')
-
-classification_model = os.getenv('MACHINE_LEARNING_CLASSIFICATION_MODEL', 'microsoft/resnet-50')
-object_model = os.getenv('MACHINE_LEARNING_OBJECT_MODEL', 'hustvl/yolos-tiny')
-clip_image_model = os.getenv('MACHINE_LEARNING_CLIP_IMAGE_MODEL', 'clip-ViT-B-32')
-clip_text_model = os.getenv('MACHINE_LEARNING_CLIP_TEXT_MODEL', 'clip-ViT-B-32')
-
-_model_cache = {}
-def _get_model(model, task=None):
-  global _model_cache
-  key = '|'.join([model, str(task)])
-  if key not in _model_cache:
-    if task:
-      _model_cache[key] = pipeline(model=model, task=task)
-    else:
-      _model_cache[key] = SentenceTransformer(model)
-  return _model_cache[key]
-
-server = Flask(__name__)
-
-@server.route("/ping")
-def ping():
-    return "pong"
-
-@server.route("/object-detection/detect-object", methods=['POST'])
-def object_detection():
-    model = _get_model(object_model, 'object-detection')
-    assetPath = request.json['thumbnailPath']
-    return run_engine(model, assetPath), 200
-
-@server.route("/image-classifier/tag-image", methods=['POST'])
-def image_classification():
-    model = _get_model(classification_model, 'image-classification')
-    assetPath = request.json['thumbnailPath']
-    return run_engine(model, assetPath), 200
-
-@server.route("/sentence-transformer/encode-image", methods=['POST'])
-def clip_encode_image():
-    model = _get_model(clip_image_model)
-    assetPath = request.json['thumbnailPath']
-    return model.encode(Image.open(assetPath)).tolist(), 200
-
-@server.route("/sentence-transformer/encode-text", methods=['POST'])
-def clip_encode_text():
-    model = _get_model(clip_text_model)
-    text = request.json['text']
-    return model.encode(text).tolist(), 200
-
-def run_engine(engine, path):
-    result = []
-    predictions = engine(path)
-
-    for index, pred in enumerate(predictions):
-        tags = pred['label'].split(', ')
-        if (pred['score'] > 0.9):
-            result = [*result, *tags]
-
-    if (len(result) > 1):
-        result = list(set(result))
-
-    return result
-
-
-if __name__ == "__main__":
-    server.run(debug=is_dev, host=server_host, port=server_port)

misc/release/pump-version.sh

@@ -61,26 +61,18 @@ fi
 
 if [ "$CURRENT_SERVER" != "$NEXT_SERVER" ]; then
   echo "Pumping Server: $CURRENT_SERVER => $NEXT_SERVER"
+  npm --prefix server version $SERVER_PUMP
+  npm --prefix server run api:generate
+  poetry --directory machine-learning version $SERVER_PUMP
 fi
 
 if [ "$CURRENT_MOBILE" != "$NEXT_MOBILE" ]; then
   echo "Pumping Mobile: $CURRENT_MOBILE => $NEXT_MOBILE"
 fi
 
-sed -i "s/^  \"version\": \"$CURRENT_SERVER\",$/  \"version\": \"$NEXT_SERVER\",/" server/package.json
-sed -i "s/^  \"version\": \"$CURRENT_SERVER\",$/  \"version\": \"$NEXT_SERVER\",/" server/package-lock.json
-sed -i "s/\"version\": \"$CURRENT_SERVER\",$/\"version\": \"$NEXT_SERVER\",/" server/immich-openapi-specs.json
 sed -i "s/\"android\.injected\.version\.name\" => \"$CURRENT_SERVER\",/\"android\.injected\.version\.name\" => \"$NEXT_SERVER\",/" mobile/android/fastlane/Fastfile
 sed -i "s/version_number: \"$CURRENT_SERVER\"$/version_number: \"$NEXT_SERVER\"/" mobile/ios/fastlane/Fastfile
 sed -i "s/\"android\.injected\.version\.code\" => $CURRENT_MOBILE,/\"android\.injected\.version\.code\" => $NEXT_MOBILE,/" mobile/android/fastlane/Fastfile
 sed -i "s/^version: $CURRENT_SERVER+$CURRENT_MOBILE$/version: $NEXT_SERVER+$NEXT_MOBILE/" mobile/pubspec.yaml
 
-# OpenApi Generated Files
-sed -i "s/API version: $CURRENT_SERVER,$/API version: $NEXT_SERVER/" mobile/openapi/README.md
-sed -i "s/OpenAPI document: $CURRENT_SERVER,$/OpenAPI document: $NEXT_SERVER/" web/src/api/open-api/api.ts
-sed -i "s/OpenAPI document: $CURRENT_SERVER,$/OpenAPI document: $NEXT_SERVER/" web/src/api/open-api/base.ts
-sed -i "s/OpenAPI document: $CURRENT_SERVER,$/OpenAPI document: $NEXT_SERVER/" web/src/api/open-api/common.ts
-sed -i "s/OpenAPI document: $CURRENT_SERVER,$/OpenAPI document: $NEXT_SERVER/" web/src/api/open-api/configuration.ts
-sed -i "s/OpenAPI document: $CURRENT_SERVER,$/OpenAPI document: $NEXT_SERVER/" web/src/api/open-api/index.ts
-
 echo "IMMICH_VERSION=v$NEXT_SERVER" >>$GITHUB_ENV

mobile/.fvm/fvm_config.json

@@ -1,4 +1,4 @@
 {
-  "flutterSdkVersion": "3.7.0",
+  "flutterSdkVersion": "3.10.0",
   "flavors": {}
-}
+}

mobile/.gitignore

@@ -49,3 +49,8 @@ app.*.map.json
 
 # Fastlane
 ios/fastlane/report.xml
+
+# Isar
+default.isar
+default.isar.lock
+libisar.so

mobile/android/app/build.gradle

@@ -72,6 +72,11 @@ android {
    }
 
     buildTypes {
+        debug {
+            applicationIdSuffix '.debug'
+            versionNameSuffix '-DEBUG'
+        }
+
         release {
             signingConfig signingConfigs.release
         }
@@ -84,6 +89,7 @@ flutter {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlin_coroutines_version"
     implementation "androidx.work:work-runtime-ktx:$work_version"
     implementation "androidx.concurrent:concurrent-futures:$concurrent_version"
     implementation "com.google.guava:guava:$guava_version"

mobile/android/app/src/main/kotlin/com/example/mobile/BackgroundServicePlugin.kt

@@ -1,10 +1,15 @@
 package app.alextran.immich
 
 import android.content.Context
+import android.util.Log
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.BinaryMessenger
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
+import java.security.MessageDigest
+import java.io.File
+import java.io.FileInputStream
+import kotlinx.coroutines.*
 
 /**
  * Android plugin for Dart `BackgroundService`
@@ -16,6 +21,7 @@ class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
 
     private var methodChannel: MethodChannel? = null
     private var context: Context? = null
+    private val sha1: MessageDigest = MessageDigest.getInstance("SHA-1")
 
     override fun onAttachedToEngine(binding: FlutterPlugin.FlutterPluginBinding) {
         onAttachedToEngine(binding.applicationContext, binding.binaryMessenger)
@@ -70,9 +76,40 @@ class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
             "isIgnoringBatteryOptimizations" -> {
                 result.success(BackupWorker.isIgnoringBatteryOptimizations(ctx))
             }
+            "digestFiles" -> {
+                val args = call.arguments<ArrayList<String>>()!!
+                GlobalScope.launch(Dispatchers.IO) {
+                    val buf = ByteArray(BUFSIZE)
+                    val digest: MessageDigest = MessageDigest.getInstance("SHA-1")
+                    val hashes = arrayOfNulls<ByteArray>(args.size)
+                    for (i in args.indices) {
+                        val path = args[i]
+                        var len = 0
+                        try {
+                            val file = FileInputStream(path)
+                            try {
+                                while (true) {
+                                    len = file.read(buf)
+                                    if (len != BUFSIZE) break
+                                    digest.update(buf)
+                                }
+                            } finally {
+                                file.close()
+                            }
+                            digest.update(buf, 0, len)
+                            hashes[i] = digest.digest()
+                        } catch (e: Exception) {
+                            // skip this file
+                            Log.w(TAG, "Failed to hash file ${args[i]}: $e")
+                        }
+                    }
+                    result.success(hashes.asList())
+                }
+            }
             else -> result.notImplemented()
         }
     }
 }
 
-private const val TAG = "BackgroundServicePlugin"
+private const val TAG = "BackgroundServicePlugin"
+private const val BUFSIZE = 2*1024*1024;

mobile/android/build.gradle

@@ -1,5 +1,6 @@
 buildscript {
     ext.kotlin_version = '1.8.20'
+    ext.kotlin_coroutines_version = '1.7.1'
     ext.work_version = '2.7.1'
     ext.concurrent_version = '1.1.0'
     ext.guava_version = '31.0.1-android'
@@ -30,6 +31,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

mobile/android/fastlane/Fastfile

@@ -35,8 +35,8 @@ platform :android do
       task: 'bundle', 
       build_type: 'Release',
       properties: {
-        "android.injected.version.code" => 77,
-        "android.injected.version.name" => "1.54.1",
+        "android.injected.version.code" => 86,
+        "android.injected.version.name" => "1.63.2",
       }
     )
     upload_to_play_store(skip_upload_apk: true, skip_upload_images: true, skip_upload_screenshots: true, aab: '../build/app/outputs/bundle/release/app-release.aab')

mobile/android/fastlane/metadata/android/en-US/changelogs/78.txt

@@ -0,0 +1 @@
+* Minor UI improvement

mobile/android/fastlane/metadata/android/en-US/changelogs/79.txt

@@ -0,0 +1,2 @@
+* Upgrade to Flutter 3.10
+* Lazy loading of timeline

mobile/android/fastlane/metadata/android/en-US/changelogs/80.txt

@@ -0,0 +1 @@
+* Remove Hive box

mobile/android/fastlane/report.xml

@@ -5,17 +5,17 @@
     
     
       
-      <testcase classname="fastlane.lanes" name="0: default_platform" time="0.000294">
+      <testcase classname="fastlane.lanes" name="0: default_platform" time="0.000296">
         
       </testcase>
     
       
-      <testcase classname="fastlane.lanes" name="1: bundleRelease" time="75.683384">
+      <testcase classname="fastlane.lanes" name="1: bundleRelease" time="64.042552">
         
       </testcase>
     
       
-      <testcase classname="fastlane.lanes" name="2: upload_to_play_store" time="24.839722">
+      <testcase classname="fastlane.lanes" name="2: upload_to_play_store" time="29.676557">
         
       </testcase>
     

mobile/assets/i18n/cs-CZ.json

@@ -1,6 +1,10 @@
 {
   "add_to_album_bottom_sheet_added": "Přidáno do {album}",
   "add_to_album_bottom_sheet_already_exists": "Již v {album}",
+  "advanced_settings_tile_subtitle": "Pokročilé uživatelské nastavení",
+  "advanced_settings_tile_title": "Pokročilé",
+  "advanced_settings_troubleshooting_subtitle": "Povolit dodatečné funkce pro řešení problémů",
+  "advanced_settings_troubleshooting_title": "Řešení problémů",
   "album_info_card_backup_album_excluded": "VYLOUČENO",
   "album_info_card_backup_album_included": "ZAHRNUTO",
   "album_thumbnail_card_item": "1 položka",
@@ -17,7 +21,10 @@
   "album_viewer_appbar_share_remove": "Odstranit z alba",
   "album_viewer_page_share_add_users": "Přidat uživatele",
   "all_videos_page_title": "Videa",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Archív ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Dynamické rozložení",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Seskupit položky podle",
   "asset_list_layout_settings_group_by_month": "Měsíc",
   "asset_list_layout_settings_group_by_month_day": "Měsíc + den",
@@ -108,10 +115,12 @@
   "control_bottom_app_bar_add_to_album": "Přidat do alba",
   "control_bottom_app_bar_album_info": "{} položek",
   "control_bottom_app_bar_album_info_shared": "{} položky - sdílené",
+  "control_bottom_app_bar_archive": "Archív",
   "control_bottom_app_bar_create_new_album": "Vytvořit nové album",
   "control_bottom_app_bar_delete": "Vymazat",
   "control_bottom_app_bar_favorite": "Oblíbené",
   "control_bottom_app_bar_share": "Sdílet",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Bez názvu",
   "create_shared_album_page_create": "Vytvořit",
   "create_shared_album_page_share": "Sdílet",
@@ -126,6 +135,8 @@
   "delete_dialog_cancel": "Zrušit",
   "delete_dialog_ok": "Vymazat",
   "delete_dialog_title": "Vymazat trvale",
+  "description_input_hint_text": "Přidat popis...",
+  "description_input_submit_error": "Chyba aktualizace popisu, další podrobnosti najdete v logu",
   "exif_bottom_sheet_description": "Přidat popis...",
   "exif_bottom_sheet_details": "PODROBNOSTI",
   "exif_bottom_sheet_location": "LOKALITA",
@@ -133,16 +144,19 @@
   "experimental_settings_new_asset_list_title": "Povolení experimentální mřížky fotografií",
   "experimental_settings_subtitle": "Používejte na vlastní riziko!",
   "experimental_settings_title": "Experimentální",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Oblíbené",
   "home_page_add_to_album_conflicts": "Přidáno {added} položek do alba {album}. {failed} položek již je v albu.",
   "home_page_add_to_album_err_local": "Zatím není možné přidat lokální média do alb, přeskakuje se",
   "home_page_add_to_album_success": "Přidány položky {added} do alba {album}.",
+  "home_page_archive_err_local": "Zatím nemohu archivovat lokální média, přeskakuji",
   "home_page_building_timeline": "Vytváření časové osy",
   "home_page_favorite_err_local": "Zatím není možné zařadit lokální média mezi oblíbená, přeskakuje se",
   "home_page_first_time_notice": "Pokud aplikaci používáte poprvé, nezapomeňte si vybrat zálohovaná alba, aby se na časové ose mohly nacházet fotografie a videa z vybraných albech.",
   "image_viewer_page_state_provider_download_error": "Chyba stahování",
   "image_viewer_page_state_provider_download_success": "Stahování bylo úspěšné",
   "library_page_albums": "Alba",
+  "library_page_archive": "Archív",
   "library_page_device_albums": "Alba v zařízení",
   "library_page_favorites": "Oblíbené",
   "library_page_new_album": "Nové album",
@@ -206,7 +220,7 @@
   "search_page_view_all_button": "Zobrazit vše",
   "search_page_your_activity": "Vaše aktivita",
   "search_result_page_new_search_hint": "Nové vyhledávání",
-  "search_suggestion_list_smart_search_hint_1": "Ve výchozím nastavení je chytré vyhledávání zapnuto, pro vyhledávání metadat použijte syntaxi",
+  "search_suggestion_list_smart_search_hint_1": "Ve výchozím nastavení je chytré vyhledávání zapnuto, pro vyhledávání metadat použijte syntaxi ",
   "search_suggestion_list_smart_search_hint_2": "m:vaše-vyhledávaná-fráze",
   "select_additional_user_for_sharing_page_suggestions": "Návrhy",
   "select_user_for_sharing_page_err_album": "Nepodařilo se vytvořit album",

mobile/assets/i18n/da-DK.json

@@ -1,6 +1,10 @@
 {
   "add_to_album_bottom_sheet_added": "Tilføjet til {album}",
   "add_to_album_bottom_sheet_already_exists": "Allerede i {album}",
+  "advanced_settings_tile_subtitle": "Avancerede brugerindstillinger",
+  "advanced_settings_tile_title": "Arkivér",
+  "advanced_settings_troubleshooting_subtitle": "Slå ekstra funktioner for fejlsøgning til",
+  "advanced_settings_troubleshooting_title": "Fejlsøgning",
   "album_info_card_backup_album_excluded": "EKSKLUDERET",
   "album_info_card_backup_album_included": "INKLUDERET",
   "album_thumbnail_card_item": "1 genstand",
@@ -17,7 +21,10 @@
   "album_viewer_appbar_share_remove": "Fjern fra album",
   "album_viewer_page_share_add_users": "Tilføj brugere",
   "all_videos_page_title": "Videoer",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Arkivér ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Dynamisk layout",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Gruppér elementer pr. ",
   "asset_list_layout_settings_group_by_month": "Måned",
   "asset_list_layout_settings_group_by_month_day": "Måned + dag",
@@ -108,10 +115,12 @@
   "control_bottom_app_bar_add_to_album": "Tilføj til album",
   "control_bottom_app_bar_album_info": "{} genstande",
   "control_bottom_app_bar_album_info_shared": "{} genstande • Delt",
+  "control_bottom_app_bar_archive": "Arkiv",
   "control_bottom_app_bar_create_new_album": "Opret nyt album",
   "control_bottom_app_bar_delete": "Slet",
   "control_bottom_app_bar_favorite": "Favorit",
   "control_bottom_app_bar_share": "Del",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Uden titel",
   "create_shared_album_page_create": "Opret",
   "create_shared_album_page_share": "Del",
@@ -126,6 +135,8 @@
   "delete_dialog_cancel": "Annuller",
   "delete_dialog_ok": "Slet",
   "delete_dialog_title": "Slet permanent",
+  "description_input_hint_text": "Tilføj en beskrivelse...",
+  "description_input_submit_error": "Fejl med at opdatere beskrivelsen. Tjek loggen for flere detaljer",
   "exif_bottom_sheet_description": "Tilføj beskrivelse...",
   "exif_bottom_sheet_details": "DETALJER",
   "exif_bottom_sheet_location": "LOKATION",
@@ -133,16 +144,19 @@
   "experimental_settings_new_asset_list_title": "Aktiver eksperimentelt fotogitter",
   "experimental_settings_subtitle": "Brug på eget ansvar!",
   "experimental_settings_title": "Eksperimentelle",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Favoritter",
   "home_page_add_to_album_conflicts": "Tilføjede {added} elementer til album {album}. {failed} elementer er allerede i albummet.",
   "home_page_add_to_album_err_local": "Kan endnu ikke tilføje lokale elementer til album. Springer over..",
   "home_page_add_to_album_success": "Tilføjede {added} elementer til album {album}.",
+  "home_page_archive_err_local": "Kan ikke arkivere lokalt element endnu.. Springer over",
   "home_page_building_timeline": "Bygger tidslinjen",
   "home_page_favorite_err_local": "Kan endnu ikke gøre lokale elementer til favoritter. Springer over..",
   "home_page_first_time_notice": "Hvis dette er din første gang i appen, bedes du vælge en backup af albummer så tidlinjen kan blive fyldt med billeder og videoer fra albummerne.",
   "image_viewer_page_state_provider_download_error": "Fejl ved download",
   "image_viewer_page_state_provider_download_success": "Download succesfuld",
   "library_page_albums": "Albummer",
+  "library_page_archive": "Arkiv",
   "library_page_device_albums": "Albummer på enhed",
   "library_page_favorites": "Favoritter",
   "library_page_new_album": "Nyt album",

mobile/assets/i18n/de-DE.json

@@ -1,13 +1,17 @@
 {
-  "add_to_album_bottom_sheet_added": "Added to {album}",
-  "add_to_album_bottom_sheet_already_exists": "Already in {album}",
+  "add_to_album_bottom_sheet_added": "Zu {album} hinzugefügt",
+  "add_to_album_bottom_sheet_already_exists": "Bereits in {album}",
+  "advanced_settings_tile_subtitle": "Erweiterte Benutzereinstellungen",
+  "advanced_settings_tile_title": "Sonstige",
+  "advanced_settings_troubleshooting_subtitle": "Aktiviere erweiterte Funktionen zur Fehlersuche",
+  "advanced_settings_troubleshooting_title": "Fehlersuche",
   "album_info_card_backup_album_excluded": "AUSGESCHLOSSEN",
   "album_info_card_backup_album_included": "EINGESCHLOSSEN",
   "album_thumbnail_card_item": "1 Element",
   "album_thumbnail_card_items": "{} Elemente",
   "album_thumbnail_card_shared": " · Geteilt",
   "album_thumbnail_owned": "Owned",
-  "album_thumbnail_shared_by": "Shared by {}",
+  "album_thumbnail_shared_by": "Geteilt von {}",
   "album_viewer_appbar_share_delete": "Album löschen",
   "album_viewer_appbar_share_err_delete": "Album konnte nicht gelöscht werden",
   "album_viewer_appbar_share_err_leave": "Album konnte nicht verlassen werden",
@@ -17,12 +21,15 @@
   "album_viewer_appbar_share_remove": "Entferne vom Album",
   "album_viewer_page_share_add_users": "Nutzer hinzufügen",
   "all_videos_page_title": "Videos",
-  "asset_list_layout_settings_dynamic_layout_title": "Dynamic layout",
-  "asset_list_layout_settings_group_by": "Group assets by",
-  "asset_list_layout_settings_group_by_month": "Month",
-  "asset_list_layout_settings_group_by_month_day": "Month + day",
-  "asset_list_settings_subtitle": "Photo grid layout settings",
-  "asset_list_settings_title": "Photo Grid",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Archive ({})",
+  "asset_list_layout_settings_dynamic_layout_title": "Dynamisches Layout",
+  "asset_list_layout_settings_group_automatically": "Automatic",
+  "asset_list_layout_settings_group_by": "Gruppiere Elemente nach",
+  "asset_list_layout_settings_group_by_month": "Monat",
+  "asset_list_layout_settings_group_by_month_day": "Monat + Tag",
+  "asset_list_settings_subtitle": "Einstellungen für das Fotogitter-Layout",
+  "asset_list_settings_title": "Fotogitter",
   "backup_album_selection_page_albums_device": "Alben auf dem Gerät ({})",
   "backup_album_selection_page_albums_tap": "Tippen um einzuschließen, doppelt tippen um zu entfernen",
   "backup_album_selection_page_assets_scatter": "Elemente können sich über mehrere Alben verteilen. Daher können diese vor der Sicherung eingeschlossen oder ausgeschlossen werden",
@@ -31,21 +38,21 @@
   "backup_album_selection_page_total_assets": "Elemente",
   "backup_all": "Alle",
   "backup_background_service_backup_failed_message": "Failed to backup assets. Retrying…",
-  "backup_background_service_connection_failed_message": "Failed to connect to the server. Retrying…",
-  "backup_background_service_current_upload_notification": "Uploading {}",
-  "backup_background_service_default_notification": "Suche nach neuen assets…",
-  "backup_background_service_error_title": "Backup error",
-  "backup_background_service_in_progress_notification": "Backing up your assets…",
-  "backup_background_service_upload_failure_notification": "Failed to upload {}",
+  "backup_background_service_connection_failed_message": "Konnte keine Verbindung zum Server herstellen. Neuer Versuch...",
+  "backup_background_service_current_upload_notification": "Lädt {} hoch",
+  "backup_background_service_default_notification": "Suche nach neuen Elementen…",
+  "backup_background_service_error_title": "Fehler bei der Sicherung",
+  "backup_background_service_in_progress_notification": "Elemente werden gesichert...",
+  "backup_background_service_upload_failure_notification": "Konnte {} nicht hochladen",
   "backup_controller_page_albums": "Gesicherte Alben",
-  "backup_controller_page_background_app_refresh_disabled_content": "Enable background app refresh in Settings > General > Background App Refresh in order to use background backup.",
-  "backup_controller_page_background_app_refresh_disabled_title": "Background app refresh disabled",
-  "backup_controller_page_background_app_refresh_enable_button_text": "Go to settings",
-  "backup_controller_page_background_battery_info_link": "Show me how",
+  "backup_controller_page_background_app_refresh_disabled_content": "Aktiviere Hintergrundaktualisierungen in Einstellungen -> Allgemein -> Hintergrundaktualisierungen um Sicherungen im Hintergrund zu ermöglichen. ",
+  "backup_controller_page_background_app_refresh_disabled_title": "Hintergrundaktualisierungen sind deaktiviert.",
+  "backup_controller_page_background_app_refresh_enable_button_text": "Gehe zu Einstellungen",
+  "backup_controller_page_background_battery_info_link": "Zeige mir wie",
   "backup_controller_page_background_battery_info_message": "For the best background backup experience, please disable any battery optimizations restricting background activity for Immich.\n\nSince this is device-specific, please lookup the required information for your device manufacturer.",
   "backup_controller_page_background_battery_info_ok": "OK",
-  "backup_controller_page_background_battery_info_title": "Battery optimizations",
-  "backup_controller_page_background_charging": "Only while charging",
+  "backup_controller_page_background_battery_info_title": "Batterieoptimierungen",
+  "backup_controller_page_background_charging": "Nur während des Ladens",
   "backup_controller_page_background_configure_error": "Failed to configure the background service",
   "backup_controller_page_background_delay": "Delay new assets backup: {}",
   "backup_controller_page_background_description": "Turn on the background service to automatically backup any new assets without needing to open the app",
@@ -53,7 +60,7 @@
   "backup_controller_page_background_is_on": "Automatic background backup is on",
   "backup_controller_page_background_turn_off": "Turn off background service",
   "backup_controller_page_background_turn_on": "Turn on background service",
-  "backup_controller_page_background_wifi": "Only on WiFi",
+  "backup_controller_page_background_wifi": "Nur im WLAN",
   "backup_controller_page_backup": "Sicherung",
   "backup_controller_page_backup_selected": "Ausgewählt: ",
   "backup_controller_page_backup_sub": "Gesicherte Fotos und Videos",
@@ -83,42 +90,44 @@
   "backup_err_only_album": "Das einzige Album kann nicht entfernt werden",
   "backup_info_card_assets": "Elemente",
   "cache_settings_album_thumbnails": "Library page thumbnails ({} assets)",
-  "cache_settings_clear_cache_button": "Clear cache",
-  "cache_settings_clear_cache_button_title": "Clears the app's cache. This will significantly impact the app's performance until the cache has rebuilt.",
+  "cache_settings_clear_cache_button": "Zwischenspeicher löschen",
+  "cache_settings_clear_cache_button_title": "Löscht den Zwischenspeicher der App. Dies wird die Leistungsfähigkeit der App deutlich einschränken, bis der Zwischenspeicher wieder aufgebaut wurde.",
   "cache_settings_image_cache_size": "Image cache size ({} assets)",
   "cache_settings_statistics_album": "Library thumbnails",
   "cache_settings_statistics_assets": "{} assets ({})",
   "cache_settings_statistics_full": "Full images",
   "cache_settings_statistics_shared": "Shared album thumbnails",
   "cache_settings_statistics_thumbnail": "Vorschaubilder",
-  "cache_settings_statistics_title": "Cache usage",
+  "cache_settings_statistics_title": "Zwischenspeicher Nutzung",
   "cache_settings_subtitle": "Control the caching behaviour of the Immich mobile application",
   "cache_settings_thumbnail_size": "Thumbnail cache size ({} assets)",
-  "cache_settings_title": "Caching Settings",
-  "change_password_form_confirm_password": "Confirm Password",
-  "change_password_form_description": "Hi {firstName} {lastName},\n\nThis is either the first time you are signing into the system or a request has been made to change your password. Please enter the new password below.",
-  "change_password_form_new_password": "New Password",
-  "change_password_form_password_mismatch": "Passwords do not match",
-  "change_password_form_reenter_new_password": "Re-enter New Password",
-  "common_add_to_album": "Add to album",
-  "common_change_password": "Change Password",
-  "common_create_new_album": "Create new album",
-  "common_server_error": "Please check your network connection, make sure the server is reachable and app/server versions are compatible.",
-  "common_shared": "Shared",
-  "control_bottom_app_bar_add_to_album": "Add to album",
-  "control_bottom_app_bar_album_info": "{} items",
-  "control_bottom_app_bar_album_info_shared": "{} items · Shared",
+  "cache_settings_title": "Zwischenspeicher Einstellungen",
+  "change_password_form_confirm_password": "Passwort bestätigen",
+  "change_password_form_description": "Hallo {firstName} {lastName}\n\nDas ist entweder das erste Mal dass du dich einloggst oder eine Anfrage zur Änderung deines Passwortes wurde gestellt. Bitte gebe das neue Passwort ein.",
+  "change_password_form_new_password": "Neues Passwort",
+  "change_password_form_password_mismatch": "Passwörter stimmen nicht überein",
+  "change_password_form_reenter_new_password": "Passwort erneut eingeben",
+  "common_add_to_album": "Zu Album hinzufügen",
+  "common_change_password": "Passwort ändern",
+  "common_create_new_album": "Erstelle ein neues Album",
+  "common_server_error": "Bitte überprüfe Deine Netzwerkverbindung und stelle sicher, dass die App und Server Versionen kompatibel sind.",
+  "common_shared": "Geteilt",
+  "control_bottom_app_bar_add_to_album": "Zu Album hinzufügen",
+  "control_bottom_app_bar_album_info": "{} Elemente",
+  "control_bottom_app_bar_album_info_shared": "{} Elemente · geteilt",
+  "control_bottom_app_bar_archive": "Archiv",
   "control_bottom_app_bar_create_new_album": "Neues Album erstellen",
   "control_bottom_app_bar_delete": "Löschen",
-  "control_bottom_app_bar_favorite": "Favorite",
+  "control_bottom_app_bar_favorite": "Favorit",
   "control_bottom_app_bar_share": "Teilen",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Unbenannt",
   "create_shared_album_page_create": "Erstellen",
   "create_shared_album_page_share": "Teilen",
   "create_shared_album_page_share_add_assets": "ELEMENTE HINZUFÜGEN",
   "create_shared_album_page_share_select_photos": "Fotos auswählen",
-  "curated_location_page_title": "Places",
-  "curated_object_page_title": "Things",
+  "curated_location_page_title": "Orte",
+  "curated_object_page_title": "Dinge",
   "daily_title_text_date": "E, dd MMM",
   "daily_title_text_date_year": "E, dd MMM, yyyy",
   "date_format": "E d. LLL y • hh:mm",
@@ -126,110 +135,115 @@
   "delete_dialog_cancel": "Abbrechen",
   "delete_dialog_ok": "Löschen",
   "delete_dialog_title": "Für immer löschen",
+  "description_input_hint_text": "Beschreibung hinzufügen...",
+  "description_input_submit_error": "Beschreibung konnte nicht geändert werden, bitte im Log für mehr Details nachsehen.",
   "exif_bottom_sheet_description": "Beschreibung hinzufügen...",
   "exif_bottom_sheet_details": "DETAILS",
   "exif_bottom_sheet_location": "STANDORT",
   "experimental_settings_new_asset_list_subtitle": "In Arbeit",
-  "experimental_settings_new_asset_list_title": "Enable experimental photo grid",
-  "experimental_settings_subtitle": "Use at your own risk!",
+  "experimental_settings_new_asset_list_title": "Experimentelle Fotogitter aktivieren",
+  "experimental_settings_subtitle": "Benutzung auf eigene Gefahr!",
   "experimental_settings_title": "Experimentell",
-  "favorites_page_title": "Favorites",
-  "home_page_add_to_album_conflicts": "Added {added} assets to album {album}. {failed} assets are already in the album.",
-  "home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping",
-  "home_page_add_to_album_success": "Added {added} assets to album {album}.",
-  "home_page_building_timeline": "Building the timeline",
-  "home_page_favorite_err_local": "Can not favorite local assets yet, skipping",
-  "home_page_first_time_notice": "If this is your first time using the app, please make sure to choose a backup album(s) so that the timeline can populate photos and videos in the album(s).",
-  "image_viewer_page_state_provider_download_error": "Download Error",
-  "image_viewer_page_state_provider_download_success": "Download Success",
+  "favorites_page_no_favorites": "No favorite assets found",
+  "favorites_page_title": "Favoriten",
+  "home_page_add_to_album_conflicts": "{added} Elemente zu {album} hinzugefügt. {failed} Elemente sind bereits vorhanden.",
+  "home_page_add_to_album_err_local": "Kann lokale Elemente noch nicht zu Alben hinzufügen, überspringe",
+  "home_page_add_to_album_success": "{added} Elemente zu {album} hinzugefügt.",
+  "home_page_archive_err_local": "Kann lokale Elemente nicht archvieren, überspringe",
+  "home_page_building_timeline": "Zeitachse wird erstellt.",
+  "home_page_favorite_err_local": "Kann lokale Elemente noch nicht favorisieren, überspringe",
+  "home_page_first_time_notice": "Wenn dies das erste Mal ist dass Du Immich nutzt, stelle bitte sicher, dass mindestens ein Album zur Sicherung ausgewählt ist, sodass die Zeitachse mit Fotos und Videos gefüllt werden kann.",
+  "image_viewer_page_state_provider_download_error": "Fehler beim Herunterladen",
+  "image_viewer_page_state_provider_download_success": "Erfolgreich heruntergeladen",
   "library_page_albums": "Alben",
-  "library_page_device_albums": "Albums on Device",
-  "library_page_favorites": "Favorites",
+  "library_page_archive": "Archiv",
+  "library_page_device_albums": "Alben auf dem Gerät.",
+  "library_page_favorites": "Favoriten",
   "library_page_new_album": "Neues Album",
-  "library_page_sharing": "Sharing",
-  "library_page_sort_created": "Most recently created",
-  "library_page_sort_title": "Album title",
-  "login_form_api_exception": "API exception. Please check the server URL and try again.",
+  "library_page_sharing": "Teilen",
+  "library_page_sort_created": "Zuletzt erstellt",
+  "library_page_sort_title": "Albumtitel",
+  "login_form_api_exception": "API Fehler. Bitte die Serveradresse überprüfen und erneut versuchen.",
   "login_form_button_text": "Anmelden",
   "login_form_email_hint": "deine@email.de",
   "login_form_endpoint_hint": "http://deine-server-ip:port/api",
   "login_form_endpoint_url": "Server URL",
   "login_form_err_http": "Bitte gebe http:// oder https:// an",
   "login_form_err_invalid_email": "Ungültige E-Mail",
-  "login_form_err_invalid_url": "Invalid URL",
+  "login_form_err_invalid_url": "Ungültige URL",
   "login_form_err_leading_whitespace": "Führendes Leerzichen",
   "login_form_err_trailing_whitespace": "Folgendes Leerzeichen",
-  "login_form_failed_get_oauth_server_config": "Error logging using OAuth, check server URL",
-  "login_form_failed_get_oauth_server_disable": "OAuth feature is not available on this server",
+  "login_form_failed_get_oauth_server_config": "Fehler beim Login per OAuth, Server-URL überprüfen",
+  "login_form_failed_get_oauth_server_disable": "OAuth-Funktion nicht verfügbar auf diesem Server.",
   "login_form_failed_login": "Error logging you in, check server url, email and password",
   "login_form_label_email": "E-Mail",
   "login_form_label_password": "Passwort",
-  "login_form_next_button": "Next",
+  "login_form_next_button": "Weiter",
   "login_form_password_hint": "password",
   "login_form_save_login": "Angemeldet bleiben",
-  "login_form_server_empty": "Enter a server URL.",
-  "login_form_server_error": "Could not connect to server.",
+  "login_form_server_empty": "Serveradresse eingeben.",
+  "login_form_server_error": "Konnte nicht mit Server verbinden.",
   "monthly_title_text_date_format": "MMMM y",
-  "motion_photos_page_title": "Motion Photos",
-  "notification_permission_dialog_cancel": "Cancel",
-  "notification_permission_dialog_content": "To enable notifications, go to Settings and select allow.",
-  "notification_permission_dialog_settings": "Settings",
-  "notification_permission_list_tile_content": "Grant permission to enable notifications.",
-  "notification_permission_list_tile_enable_button": "Enable Notifications",
-  "notification_permission_list_tile_title": "Notification Permission",
-  "permission_onboarding_continue_anyway": "Continue anyway",
+  "motion_photos_page_title": "Live Photos",
+  "notification_permission_dialog_cancel": "Abbrechen",
+  "notification_permission_dialog_content": "Um Benachrichtigungen zu aktivieren, navigiere zu Einstellungen und klicke \"Erlauben\"",
+  "notification_permission_dialog_settings": "Einstellungen",
+  "notification_permission_list_tile_content": "Erlaube Berechtigung für Benachrichtigungen",
+  "notification_permission_list_tile_enable_button": "Aktiviere Benachrichtigungen",
+  "notification_permission_list_tile_title": "Benachrichtigungs-Berechtigung",
+  "permission_onboarding_continue_anyway": "Trotzdem fortfahren",
   "permission_onboarding_get_started": "Get started",
-  "permission_onboarding_go_to_settings": "Go to settings",
-  "permission_onboarding_grant_permission": "Grant permission",
-  "permission_onboarding_log_out": "Log out",
-  "permission_onboarding_permission_denied": "Permission denied. To use Immich, grant photo and video permissions in Settings.",
-  "permission_onboarding_permission_granted": "Permission granted! You are all set.",
-  "permission_onboarding_permission_limited": "Permission limited. To let Immich backup and manage your entire gallery collection, grant photo and video permissions in Settings.",
-  "permission_onboarding_request": "Immich requires permission to view your photos and videos.",
+  "permission_onboarding_go_to_settings": "Gehe zu Einstellungen",
+  "permission_onboarding_grant_permission": "Berechtigung erteilen",
+  "permission_onboarding_log_out": "Abmelden",
+  "permission_onboarding_permission_denied": "Berechtigungen verweigert. Um Immich zu benutzen, Zugriff auf Fotos und Videos in Einstellungen erlauben.",
+  "permission_onboarding_permission_granted": "Berechtigung erteilt! Du bist startklar.",
+  "permission_onboarding_permission_limited": "Berechtigungen unzureichend. Um Immich das Sichern von ganzen Sammlungen zu ermöglichen, muss der Zugriff auf alle Fotos und Videos in den Einstellungen erlaubt werden.",
+  "permission_onboarding_request": "Immich benötigt Berechtigung um auf deine Fotos und Videos zuzugreifen.",
   "profile_drawer_app_logs": "Logs",
   "profile_drawer_client_server_up_to_date": "App und Server sind aktuell",
   "profile_drawer_settings": "Einstellungen",
   "profile_drawer_sign_out": "Abmelden",
-  "recently_added_page_title": "Recently Added",
+  "recently_added_page_title": "Zuletzt hinzugefügt",
   "search_bar_hint": "Durchsuche deine Fotos",
-  "search_page_categories": "Categories",
-  "search_page_favorites": "Favorites",
-  "search_page_motion_photos": "Motion Photos",
+  "search_page_categories": "Kategorien",
+  "search_page_favorites": "Favoriten",
+  "search_page_motion_photos": "Live Photos",
   "search_page_no_objects": "Keine Objektinformationen verfügbar",
   "search_page_no_places": "Keine Informationen über Orte verfügbar",
   "search_page_places": "Orte",
-  "search_page_recently_added": "Recently added",
-  "search_page_screenshots": "Screenshots",
+  "search_page_recently_added": "Zuletzt hinzugefügt",
+  "search_page_screenshots": "Bildschirmfotos",
   "search_page_selfies": "Selfies",
   "search_page_things": "Dinge",
   "search_page_videos": "Videos",
-  "search_page_view_all_button": "View all",
-  "search_page_your_activity": "Your activity",
+  "search_page_view_all_button": "Alle anzeigen",
+  "search_page_your_activity": "Deine Aktivität",
   "search_result_page_new_search_hint": "Neue Suche",
-  "search_suggestion_list_smart_search_hint_1": "Smart search is enabled by default, to search for metadata use the syntax ",
-  "search_suggestion_list_smart_search_hint_2": "m:your-search-term",
+  "search_suggestion_list_smart_search_hint_1": "Intelligente Suche ist standardmäßig aktiviert; um nach Metadaten zu suchen Syntax benutzen",
+  "search_suggestion_list_smart_search_hint_2": "m:dein-suchbegriff",
   "select_additional_user_for_sharing_page_suggestions": "Vorschläge",
   "select_user_for_sharing_page_err_album": "Album konnte nicht erstellt werden",
   "select_user_for_sharing_page_share_suggestions": "Suggestions",
   "server_info_box_app_version": "App Version",
   "server_info_box_server_version": "Server Version",
-  "setting_image_viewer_help": "The detail viewer loads the small thumbnail first, then loads the medium-size preview (if enabled), finally loads the original (if enabled).",
-  "setting_image_viewer_original_subtitle": "Enable to load the original full-resolution image (large!). Disable to reduce data usage (both network and on device cache).",
-  "setting_image_viewer_original_title": "Load original image",
-  "setting_image_viewer_preview_subtitle": "Enable to load a medium-resolution image. Disable to either directly load the original or only use the thumbnail.",
-  "setting_image_viewer_preview_title": "Load preview image",
+  "setting_image_viewer_help": "Der Detailviewer lädt zuerst die kleine Miniaturansicht, dann die Vorschau in mittlerer Größe (falls aktiviert) und schließlich das Original (falls aktiviert).",
+  "setting_image_viewer_original_subtitle": "Aktivieren, um das Originalbild in voller Auflösung (groß!) zu laden. Deaktivieren, um den Datenverbrauch zu reduzieren (sowohl im Netzwerk als auch im Gerätespeicher).",
+  "setting_image_viewer_original_title": "Original laden",
+  "setting_image_viewer_preview_subtitle": "Aktivieren, um ein Bild mit mittlerer Auflösung zu laden. Deaktivieren, um entweder das Original direkt zu laden oder nur die Miniaturansicht zu verwenden.",
+  "setting_image_viewer_preview_title": "Vorschaubild laden",
   "setting_notifications_notify_failures_grace_period": "Notify background backup failures: {}",
-  "setting_notifications_notify_hours": "{} hours",
-  "setting_notifications_notify_immediately": "immediately",
-  "setting_notifications_notify_minutes": "{} minutes",
-  "setting_notifications_notify_never": "never",
-  "setting_notifications_notify_seconds": "{} seconds",
+  "setting_notifications_notify_hours": "{} Stunden",
+  "setting_notifications_notify_immediately": "sofort",
+  "setting_notifications_notify_minutes": "{} Minuten",
+  "setting_notifications_notify_never": "niemals",
+  "setting_notifications_notify_seconds": "{} Sekunden",
   "setting_notifications_single_progress_subtitle": "Detaillierte Upload Informationen für jedes Element.",
-  "setting_notifications_single_progress_title": "Show background backup detail progress",
+  "setting_notifications_single_progress_title": "Zeige Hintergrund-Sicherungs Detailfortschritt",
   "setting_notifications_subtitle": "Adjust your notification preferences",
-  "setting_notifications_title": "Notifications",
-  "setting_notifications_total_progress_subtitle": "Overall upload progress (done/total assets)",
-  "setting_notifications_total_progress_title": "Show background backup total progress",
+  "setting_notifications_title": "Benachrichtigungen",
+  "setting_notifications_total_progress_subtitle": "Gesamter Upload-Fortschritt (abgeschlossen/Anzahl Elemente)",
+  "setting_notifications_total_progress_title": "Zeige Hintergrundsicherungsfortschritt",
   "setting_pages_app_bar_settings": "Einstellungen",
   "settings_require_restart": "Bitte starte Immich neu, um diese Einstellung anzuwenden.",
   "share_add": "Hinzufügen",
@@ -247,8 +261,8 @@
   "tab_controller_nav_photos": "Fotos",
   "tab_controller_nav_search": "Suche",
   "tab_controller_nav_sharing": "Teilen",
-  "theme_setting_asset_list_storage_indicator_title": "Show storage indicator on asset tiles",
-  "theme_setting_asset_list_tiles_per_row_title": "Number of assets per row ({})",
+  "theme_setting_asset_list_storage_indicator_title": "Zeige Sicherungsstatus auf Miniaturbild",
+  "theme_setting_asset_list_tiles_per_row_title": "Anzahl der Elemente pro Reihe ({})",
   "theme_setting_dark_mode_switch": "Dunkler Modus",
   "theme_setting_image_viewer_quality_subtitle": "Einstellen der Qualität des Detailbildbetrachters",
   "theme_setting_image_viewer_quality_title": "Qualität des Bildbetrachters",

mobile/assets/i18n/en-US.json

@@ -1,6 +1,10 @@
 {
   "add_to_album_bottom_sheet_added": "Added to {album}",
   "add_to_album_bottom_sheet_already_exists": "Already in {album}",
+  "advanced_settings_tile_subtitle": "Advanced user's settings",
+  "advanced_settings_tile_title": "Advanced",
+  "advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting",
+  "advanced_settings_troubleshooting_title": "Troubleshooting",
   "album_info_card_backup_album_excluded": "EXCLUDED",
   "album_info_card_backup_album_included": "INCLUDED",
   "album_thumbnail_card_item": "1 item",
@@ -17,7 +21,10 @@
   "album_viewer_appbar_share_remove": "Remove from album",
   "album_viewer_page_share_add_users": "Add users",
   "all_videos_page_title": "Videos",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Archive ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Dynamic layout",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Group assets by",
   "asset_list_layout_settings_group_by_month": "Month",
   "asset_list_layout_settings_group_by_month_day": "Month + day",
@@ -108,11 +115,12 @@
   "control_bottom_app_bar_add_to_album": "Add to album",
   "control_bottom_app_bar_album_info": "{} items",
   "control_bottom_app_bar_album_info_shared": "{} items · Shared",
+  "control_bottom_app_bar_archive": "Archive",
   "control_bottom_app_bar_create_new_album": "Create new album",
   "control_bottom_app_bar_delete": "Delete",
   "control_bottom_app_bar_favorite": "Favorite",
-  "control_bottom_app_bar_archive": "Archive",
   "control_bottom_app_bar_share": "Share",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Untitled",
   "create_shared_album_page_create": "Create",
   "create_shared_album_page_share": "Share",
@@ -127,6 +135,8 @@
   "delete_dialog_cancel": "Cancel",
   "delete_dialog_ok": "Delete",
   "delete_dialog_title": "Delete Permanently",
+  "description_input_hint_text": "Add description...",
+  "description_input_submit_error": "Error updating description, check the log for more details",
   "exif_bottom_sheet_description": "Add Description...",
   "exif_bottom_sheet_details": "DETAILS",
   "exif_bottom_sheet_location": "LOCATION",
@@ -134,22 +144,23 @@
   "experimental_settings_new_asset_list_title": "Enable experimental photo grid",
   "experimental_settings_subtitle": "Use at your own risk!",
   "experimental_settings_title": "Experimental",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Favorites",
   "home_page_add_to_album_conflicts": "Added {added} assets to album {album}. {failed} assets are already in the album.",
   "home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping",
   "home_page_add_to_album_success": "Added {added} assets to album {album}.",
+  "home_page_archive_err_local": "Can not archive local assets yet, skipping",
   "home_page_building_timeline": "Building the timeline",
   "home_page_favorite_err_local": "Can not favorite local assets yet, skipping",
-  "home_page_archive_err_local": "Can not archive local assets yet, skipping",
   "home_page_first_time_notice": "If this is your first time using the app, please make sure to choose a backup album(s) so that the timeline can populate photos and videos in the album(s).",
   "image_viewer_page_state_provider_download_error": "Download Error",
   "image_viewer_page_state_provider_download_success": "Download Success",
   "library_page_albums": "Albums",
+  "library_page_archive": "Archive",
   "library_page_device_albums": "Albums on Device",
   "library_page_favorites": "Favorites",
   "library_page_new_album": "New album",
   "library_page_sharing": "Sharing",
-  "library_page_archive": "Archive",
   "library_page_sort_created": "Most recently created",
   "library_page_sort_title": "Album title",
   "login_form_api_exception": "API exception. Please check the server URL and try again.",
@@ -206,6 +217,7 @@
   "search_page_selfies": "Selfies",
   "search_page_things": "Things",
   "search_page_videos": "Videos",
+  "search_page_people": "People",
   "search_page_view_all_button": "View all",
   "search_page_your_activity": "Your activity",
   "search_result_page_new_search_hint": "New Search",
@@ -246,6 +258,15 @@
   "sharing_page_empty_list": "EMPTY LIST",
   "sharing_silver_appbar_create_shared_album": "Create shared album",
   "sharing_silver_appbar_share_partner": "Share with partner",
+  "partner_page_title": "Partner",
+  "partner_page_no_more_users": "No more users to add",
+  "partner_page_empty_message": "Your photos are not yet shared with any partner.",
+  "partner_page_shared_to_title": "Shared to",
+  "partner_page_select_partner": "Select partner",
+  "partner_page_add_partner": "Add partner",
+  "partner_page_partner_add_failed": "Failed to add partner",
+  "partner_page_stop_sharing_title": "Stop sharing your photos?",
+  "partner_page_stop_sharing_content": "{} will no longer be able to access your photos.",
   "tab_controller_nav_library": "Library",
   "tab_controller_nav_photos": "Photos",
   "tab_controller_nav_search": "Search",
@@ -266,11 +287,5 @@
   "version_announcement_overlay_text_2": "please take your time to visit the ",
   "version_announcement_overlay_text_3": " and ensure your docker-compose and .env setup is up-to-date to prevent any misconfigurations, especially if you use WatchTower or any mechanism that handles updating your server application automatically.",
   "version_announcement_overlay_title": "New Server Version Available \uD83C\uDF89",
-  "advanced_settings_tile_title": "Advanced",
-  "advanced_settings_tile_subtitle": "Advanced user's settings",
-  "advanced_settings_troubleshooting_title": "Troubleshooting",
-  "advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting",
-  "description_input_submit_error": "Error updating description, check the log for more details",
-  "description_input_hint_text": "Add description...",
-  "archive_page_title": "Archive ({})"
+  "all_people_page_title": "People"
 }

mobile/assets/i18n/es-ES.json

@@ -1,6 +1,10 @@
 {
   "add_to_album_bottom_sheet_added": "Added to {album}",
   "add_to_album_bottom_sheet_already_exists": "Already in {album}",
+  "advanced_settings_tile_subtitle": "Advanced user's settings",
+  "advanced_settings_tile_title": "Advanced",
+  "advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting",
+  "advanced_settings_troubleshooting_title": "Troubleshooting",
   "album_info_card_backup_album_excluded": "EXCLUIDOS",
   "album_info_card_backup_album_included": "INCLUIDOS",
   "album_thumbnail_card_item": "1 item",
@@ -17,7 +21,10 @@
   "album_viewer_appbar_share_remove": "Eliminar del álbum ",
   "album_viewer_page_share_add_users": "Añadir usuarios",
   "all_videos_page_title": "Videos",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Archive ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Disposición dinámica",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Agrupar recursos por",
   "asset_list_layout_settings_group_by_month": "Mes",
   "asset_list_layout_settings_group_by_month_day": "Mes + día",
@@ -108,10 +115,12 @@
   "control_bottom_app_bar_add_to_album": "Añadir al álbum",
   "control_bottom_app_bar_album_info": "{} elementos",
   "control_bottom_app_bar_album_info_shared": "{} elementos · Compartido",
+  "control_bottom_app_bar_archive": "Archive",
   "control_bottom_app_bar_create_new_album": "Crear nuevo álbum",
   "control_bottom_app_bar_delete": "Eliminar",
   "control_bottom_app_bar_favorite": "Favorite",
   "control_bottom_app_bar_share": "Share",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Untitled",
   "create_shared_album_page_create": "Create",
   "create_shared_album_page_share": "Compartir",
@@ -126,6 +135,8 @@
   "delete_dialog_cancel": "Cancelar",
   "delete_dialog_ok": "Eliminar",
   "delete_dialog_title": "Eliminar Permanentemente",
+  "description_input_hint_text": "Add description...",
+  "description_input_submit_error": "Error updating description, check the log for more details",
   "exif_bottom_sheet_description": "Añadir Descripción...",
   "exif_bottom_sheet_details": "DETALLES",
   "exif_bottom_sheet_location": "LOCALZACIÓN",
@@ -133,16 +144,19 @@
   "experimental_settings_new_asset_list_title": "Enable experimental photo grid",
   "experimental_settings_subtitle": "Use at your own risk!",
   "experimental_settings_title": "Experimental",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Favoritos",
   "home_page_add_to_album_conflicts": "Añadidos {added} elementos al álbum {album}. {failed} elementos ya están añadidos.",
   "home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping",
   "home_page_add_to_album_success": "Añadidos {added} elementos al álbum {album}.",
+  "home_page_archive_err_local": "Can not archive local assets yet, skipping",
   "home_page_building_timeline": "Construyendo la línea de tiempo",
   "home_page_favorite_err_local": "Can not favorite local assets yet, skipping",
   "home_page_first_time_notice": "Si esta es la primera vez que usas la app, por favor, asegúrate de elegir un álbum de respaldo para que la línea de tiempo pueda cargar fotos y videos en los álbumes.",
   "image_viewer_page_state_provider_download_error": "Download Error",
   "image_viewer_page_state_provider_download_success": "Download Success",
   "library_page_albums": "Albums",
+  "library_page_archive": "Archive",
   "library_page_device_albums": "Albums on Device",
   "library_page_favorites": "Favoritos",
   "library_page_new_album": "New album",

mobile/assets/i18n/fi-FI.json

@@ -1,13 +1,17 @@
 {
-  "add_to_album_bottom_sheet_added": "Added to {album}",
-  "add_to_album_bottom_sheet_already_exists": "Already in {album}",
+  "add_to_album_bottom_sheet_added": "Lisätty albumiin {album}",
+  "add_to_album_bottom_sheet_already_exists": "Kohde on jo albumissa {album}",
+  "advanced_settings_tile_subtitle": "Edistyneen käyttäjän asetukset",
+  "advanced_settings_tile_title": "Edistyneet",
+  "advanced_settings_troubleshooting_subtitle": "Kytke vianetsinnän lisäominaisuudet päälle",
+  "advanced_settings_troubleshooting_title": "Vianetsintä",
   "album_info_card_backup_album_excluded": "JÄTETTY POIS",
   "album_info_card_backup_album_included": "SISÄLLYTETTY",
   "album_thumbnail_card_item": "1 kohde",
   "album_thumbnail_card_items": "{} kohdetta",
   "album_thumbnail_card_shared": "Jaettu",
-  "album_thumbnail_owned": "Owned",
-  "album_thumbnail_shared_by": "Shared by {}",
+  "album_thumbnail_owned": "Omistettu",
+  "album_thumbnail_shared_by": "Jakanut {}",
   "album_viewer_appbar_share_delete": "Poista albumi",
   "album_viewer_appbar_share_err_delete": "Albumin poistaminen epäonnistui",
   "album_viewer_appbar_share_err_leave": "Albumista poistuminen epäonnistui",
@@ -16,8 +20,11 @@
   "album_viewer_appbar_share_leave": "Poistu albumista",
   "album_viewer_appbar_share_remove": "Poista albumista",
   "album_viewer_page_share_add_users": "Lisää käyttäjiä",
-  "all_videos_page_title": "Videos",
+  "all_videos_page_title": "Videot",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Arkisto ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Dynaaminen asetelma",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Ryhmittele",
   "asset_list_layout_settings_group_by_month": "Kuukauden mukaan",
   "asset_list_layout_settings_group_by_month_day": "Kuukauden ja päivän mukaan",
@@ -38,9 +45,9 @@
   "backup_background_service_in_progress_notification": "Varmuuskopioidaan kohteita...",
   "backup_background_service_upload_failure_notification": "Lähetys palvelimelle epäonnistui {}",
   "backup_controller_page_albums": "Varmuuskopioi albumit",
-  "backup_controller_page_background_app_refresh_disabled_content": "Enable background app refresh in Settings > General > Background App Refresh in order to use background backup.",
-  "backup_controller_page_background_app_refresh_disabled_title": "Background app refresh disabled",
-  "backup_controller_page_background_app_refresh_enable_button_text": "Go to settings",
+  "backup_controller_page_background_app_refresh_disabled_content": "Salli sovelluksen päivittäminen taustalla suorittaaksesi varmuuskopiointia taustalla: Asetukset > Yleiset > Appien päivitys taustalla",
+  "backup_controller_page_background_app_refresh_disabled_title": "Sovelluksen päivittäminen taustalla on pois päältä",
+  "backup_controller_page_background_app_refresh_enable_button_text": "Siirry asetuksiin",
   "backup_controller_page_background_battery_info_link": "Näytä minulle miten",
   "backup_controller_page_background_battery_info_message": "Kytke pois päältä kaikki Immichin taustatyöskentelyyn liittyvät akun optimoinnit, jotta varmistat taustavarmuuskopioinnin parhaan mahdollisen toiminnan.\n\nKoska tämä on laitekohtaista, tarkista tarvittavat toimet laitevalmistajan ohjeista.",
   "backup_controller_page_background_battery_info_ok": "OK",
@@ -95,30 +102,32 @@
   "cache_settings_subtitle": "Hallitse Immich-mobiilisovelluksen välimuistin käyttöä",
   "cache_settings_thumbnail_size": "Esikatselukuvien välimuistin koko ({} kohdetta)",
   "cache_settings_title": "Välimuistin asetukset",
-  "change_password_form_confirm_password": "Confirm Password",
-  "change_password_form_description": "Hi {firstName} {lastName},\n\nThis is either the first time you are signing into the system or a request has been made to change your password. Please enter the new password below.",
-  "change_password_form_new_password": "New Password",
-  "change_password_form_password_mismatch": "Passwords do not match",
-  "change_password_form_reenter_new_password": "Re-enter New Password",
-  "common_add_to_album": "Add to album",
-  "common_change_password": "Change Password",
-  "common_create_new_album": "Create new album",
-  "common_server_error": "Please check your network connection, make sure the server is reachable and app/server versions are compatible.",
-  "common_shared": "Shared",
+  "change_password_form_confirm_password": "Vahvista salasana",
+  "change_password_form_description": "Hei {firstName} {lastName},\n\nTämä on joko ensimmäinen kirjautumisesi järjestelmään tai salasanan vaihtaminen vaihtaminen on pakotettu. Ole hyvä ja syötä uusi salasana alle.",
+  "change_password_form_new_password": "Uusi salasana",
+  "change_password_form_password_mismatch": "Salasanat eivät täsmää",
+  "change_password_form_reenter_new_password": "Uusi salasana uudelleen",
+  "common_add_to_album": "Lisää albumiin",
+  "common_change_password": "Vaihda salasana",
+  "common_create_new_album": "Luo uusi albumi",
+  "common_server_error": "Tarkista internet-yhteytesi. Varmista että palvelin on saavutettavissa ja sovellus-/palvelinversiot ovat yhteensopivia.",
+  "common_shared": "Jaettu",
   "control_bottom_app_bar_add_to_album": "Lisää albumiin",
   "control_bottom_app_bar_album_info": "{} kohdetta",
   "control_bottom_app_bar_album_info_shared": "{} kohdetta · Jaettu",
+  "control_bottom_app_bar_archive": "Arkistoi",
   "control_bottom_app_bar_create_new_album": "Luo uusi albumi",
   "control_bottom_app_bar_delete": "Poista",
-  "control_bottom_app_bar_favorite": "Favorite",
+  "control_bottom_app_bar_favorite": "Suosikki",
   "control_bottom_app_bar_share": "Jaa",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Nimetön",
   "create_shared_album_page_create": "Luo",
   "create_shared_album_page_share": "Jaa",
   "create_shared_album_page_share_add_assets": "LISÄÄ KOHTEITA",
   "create_shared_album_page_share_select_photos": "Valitse kuvat",
-  "curated_location_page_title": "Places",
-  "curated_object_page_title": "Things",
+  "curated_location_page_title": "Paikat",
+  "curated_object_page_title": "Asiat",
   "daily_title_text_date": "E, MMM dd",
   "daily_title_text_date_year": "E, MMM dd, yyyy",
   "date_format": "E, LLL d, y • h:mm a",
@@ -126,6 +135,8 @@
   "delete_dialog_cancel": "Peruuta",
   "delete_dialog_ok": "Poista",
   "delete_dialog_title": "Poista pysyvästi",
+  "description_input_hint_text": "Lisää kuvaus...",
+  "description_input_submit_error": "Virhe kuvauksen päivittämisessä, tarkista lisätiedot lokista",
   "exif_bottom_sheet_description": "Lisää kuvaus…",
   "exif_bottom_sheet_details": "TIEDOT",
   "exif_bottom_sheet_location": "SIJAINTI",
@@ -133,23 +144,26 @@
   "experimental_settings_new_asset_list_title": "Ota käyttöön kokeellinen kuvaruudukko",
   "experimental_settings_subtitle": "Käyttö omalla vastuulla!",
   "experimental_settings_title": "Kokeellinen",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Suosikit",
   "home_page_add_to_album_conflicts": "Lisätty {added} kohdetta albumiin {album}. {failed} kohdetta on jo albumissa.",
-  "home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping",
+  "home_page_add_to_album_err_local": "Paikallisten kohteiden lisääminen albumeihin ei ole mahdollista, ohitetaan",
   "home_page_add_to_album_success": "Lisätty {added} kohdetta albumiin {album}.",
+  "home_page_archive_err_local": "Paikallisten kohteiden arkistointi ei ole mahdollista, ohitetaan",
   "home_page_building_timeline": "Rakennetaan aikajanaa",
-  "home_page_favorite_err_local": "Can not favorite local assets yet, skipping",
+  "home_page_favorite_err_local": "Paikallisten kohteiden lisääminen suosikkeihin ei ole mahdollista, ohitetaan",
   "home_page_first_time_notice": "Jos käytät sovellusta ensimmäistä kertaa, muista valita varmuuskopioitavat albumi(t), jotta aikajanalla voi olla kuvia ja videoita.",
-  "image_viewer_page_state_provider_download_error": "Download Error",
-  "image_viewer_page_state_provider_download_success": "Download Success",
+  "image_viewer_page_state_provider_download_error": "Lataus epäonnistui",
+  "image_viewer_page_state_provider_download_success": "Lataus onnistui",
   "library_page_albums": "Albumit",
-  "library_page_device_albums": "Albums on Device",
+  "library_page_archive": "Arkisto",
+  "library_page_device_albums": "Laitteen albumit",
   "library_page_favorites": "Suosikit",
   "library_page_new_album": "Uusi albumi",
   "library_page_sharing": "Jakaminen",
   "library_page_sort_created": "Viimeisin luotu",
   "library_page_sort_title": "Albumin otsikko",
-  "login_form_api_exception": "API exception. Please check the server URL and try again.",
+  "login_form_api_exception": "API-virhe. Tarkista palvelimen URL-osoite ja yritä uudelleen.",
   "login_form_button_text": "Kirjaudu",
   "login_form_email_hint": "sahkopostisi@esimerkki.fi",
   "login_form_endpoint_hint": "http://palvelimesi-osoite:portti/api",
@@ -164,55 +178,55 @@
   "login_form_failed_login": "Virhe kirjautumisessa. Tarkista palvelimen URL, sähköpostiosoite ja salasana.",
   "login_form_label_email": "Sähköposti",
   "login_form_label_password": "Salasana",
-  "login_form_next_button": "Next",
+  "login_form_next_button": "Seuraava",
   "login_form_password_hint": "salasana",
   "login_form_save_login": "Pysy kirjautuneena",
-  "login_form_server_empty": "Enter a server URL.",
-  "login_form_server_error": "Could not connect to server.",
+  "login_form_server_empty": "Syötä palvelimen URL-osoite.",
+  "login_form_server_error": "Palvelimeen ei saatu yhteyttä.",
   "monthly_title_text_date_format": "MMMM y",
-  "motion_photos_page_title": "Motion Photos",
-  "notification_permission_dialog_cancel": "Cancel",
-  "notification_permission_dialog_content": "To enable notifications, go to Settings and select allow.",
-  "notification_permission_dialog_settings": "Settings",
-  "notification_permission_list_tile_content": "Grant permission to enable notifications.",
-  "notification_permission_list_tile_enable_button": "Enable Notifications",
-  "notification_permission_list_tile_title": "Notification Permission",
-  "permission_onboarding_continue_anyway": "Continue anyway",
-  "permission_onboarding_get_started": "Get started",
-  "permission_onboarding_go_to_settings": "Go to settings",
-  "permission_onboarding_grant_permission": "Grant permission",
-  "permission_onboarding_log_out": "Log out",
-  "permission_onboarding_permission_denied": "Permission denied. To use Immich, grant photo and video permissions in Settings.",
-  "permission_onboarding_permission_granted": "Permission granted! You are all set.",
-  "permission_onboarding_permission_limited": "Permission limited. To let Immich backup and manage your entire gallery collection, grant photo and video permissions in Settings.",
-  "permission_onboarding_request": "Immich requires permission to view your photos and videos.",
+  "motion_photos_page_title": "Liikekuvat",
+  "notification_permission_dialog_cancel": "Peruuta",
+  "notification_permission_dialog_content": "Ottaaksesi ilmoitukset käyttöön, siirry asetuksiin ja valitse 'salli'.",
+  "notification_permission_dialog_settings": "Asetukset",
+  "notification_permission_list_tile_content": "Myönnä käyttöoikeus ottaaksesi ilmoitukset käyttöön.",
+  "notification_permission_list_tile_enable_button": "Ota ilmoitukset käyttöön",
+  "notification_permission_list_tile_title": "Ilmoitusten käyttöoikeus",
+  "permission_onboarding_continue_anyway": "Jatka silti",
+  "permission_onboarding_get_started": "Aloittaminen",
+  "permission_onboarding_go_to_settings": "Siirry asetuksiin",
+  "permission_onboarding_grant_permission": "Käyttöoikeuden myöntäminen",
+  "permission_onboarding_log_out": "Kirjaudu ulos",
+  "permission_onboarding_permission_denied": "Kielletty käyttöoikeus. Käyttääksesi Immichiä, myönnä oikeus kuviin ja videoihin asetuksista.",
+  "permission_onboarding_permission_granted": "Käyttöoikeus myönnetty! Kaikki valmista.",
+  "permission_onboarding_permission_limited": "Rajoitettu käyttöoikeus. Salliaksesi Immichin varmuuskopioida ja hallita koko kuvakirjastoasi, myönnä oikeus kuviin ja videoihin asetuksista.",
+  "permission_onboarding_request": "Immich vaatii käyttöoikeuden kuvien ja videoiden käyttämiseen.",
   "profile_drawer_app_logs": "Lokit",
   "profile_drawer_client_server_up_to_date": "Asiakassovellus ja palvelin ovat ajan tasalla",
   "profile_drawer_settings": "Asetukset",
   "profile_drawer_sign_out": "Kirjaudu ulos",
-  "recently_added_page_title": "Recently Added",
+  "recently_added_page_title": "Viimeksi lisätyt",
   "search_bar_hint": "Etsi kuvia",
-  "search_page_categories": "Categories",
-  "search_page_favorites": "Favorites",
-  "search_page_motion_photos": "Motion Photos",
+  "search_page_categories": "Kategoriat",
+  "search_page_favorites": "Suosikit",
+  "search_page_motion_photos": "Liikekuvat",
   "search_page_no_objects": "Objektitietoja ei ole saatavilla",
   "search_page_no_places": "Paikkatietoja ei ole saatavilla",
   "search_page_places": "Paikat",
-  "search_page_recently_added": "Recently added",
-  "search_page_screenshots": "Screenshots",
-  "search_page_selfies": "Selfies",
+  "search_page_recently_added": "Viimeksi lisätyt",
+  "search_page_screenshots": "Näyttökuvat",
+  "search_page_selfies": "Selfiet",
   "search_page_things": "Asiat",
-  "search_page_videos": "Videos",
-  "search_page_view_all_button": "View all",
-  "search_page_your_activity": "Your activity",
+  "search_page_videos": "Videot",
+  "search_page_view_all_button": "Näytä kaikki",
+  "search_page_your_activity": "Toimintasi",
   "search_result_page_new_search_hint": "Uusi haku",
-  "search_suggestion_list_smart_search_hint_1": "Smart search is enabled by default, to search for metadata use the syntax ",
-  "search_suggestion_list_smart_search_hint_2": "m:your-search-term",
+  "search_suggestion_list_smart_search_hint_1": "Älykäs haku on oletuksena käytössä. Käytä metatietojen etsimiseen syntaksia",
+  "search_suggestion_list_smart_search_hint_2": "m:hakusana",
   "select_additional_user_for_sharing_page_suggestions": "Ehdotukset",
   "select_user_for_sharing_page_err_album": "Albumin luonti epäonnistui",
   "select_user_for_sharing_page_share_suggestions": "Ehdotukset",
-  "server_info_box_app_version": "App Version",
-  "server_info_box_server_version": "Server Version",
+  "server_info_box_app_version": "Sovelluksen versio",
+  "server_info_box_server_version": "Palvelimen versio",
   "setting_image_viewer_help": "Sovellus lataa ensin pienen esikatselukuvan, toisena keskitarkkuuksisen kuvan (jos käytössä) ja kolmantena alkuperäisen täysitarkkuuksisen kuvan (jos käytössä)",
   "setting_image_viewer_original_subtitle": "Ota käyttöön ladataksesi alkuperäinen täysitarkkuuksinen kuva (suuri!). Poista käytöstä vähentääksesi datan käyttöä (sekä verkossa että laitteen välimuistissa).",
   "setting_image_viewer_original_title": "Lataa alkuperäinen kuva",

mobile/assets/i18n/fr-FR.json

@@ -1,6 +1,10 @@
 {
   "add_to_album_bottom_sheet_added": "Ajouté à {album}",
   "add_to_album_bottom_sheet_already_exists": "Déjà dans {album}",
+  "advanced_settings_tile_subtitle": "Advanced user's settings",
+  "advanced_settings_tile_title": "Advanced",
+  "advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting",
+  "advanced_settings_troubleshooting_title": "Troubleshooting",
   "album_info_card_backup_album_excluded": "EXCLU",
   "album_info_card_backup_album_included": "INCLUS",
   "album_thumbnail_card_item": "1 élément",
@@ -17,7 +21,10 @@
   "album_viewer_appbar_share_remove": "Retirer de l'album",
   "album_viewer_page_share_add_users": "Ajouter des utilisateurs",
   "all_videos_page_title": "Videos",
+  "archive_page_no_archived_assets": "No archived assets found",
+  "archive_page_title": "Archive ({})",
   "asset_list_layout_settings_dynamic_layout_title": "Affichage dynamique",
+  "asset_list_layout_settings_group_automatically": "Automatic",
   "asset_list_layout_settings_group_by": "Grouper les éléments par",
   "asset_list_layout_settings_group_by_month": "Mois",
   "asset_list_layout_settings_group_by_month_day": "Mois + jour",
@@ -108,10 +115,12 @@
   "control_bottom_app_bar_add_to_album": "Ajouter à l'album",
   "control_bottom_app_bar_album_info": "{} éléments",
   "control_bottom_app_bar_album_info_shared": "{} éléments - Partagés",
+  "control_bottom_app_bar_archive": "Archive",
   "control_bottom_app_bar_create_new_album": "Créer un nouvel album",
   "control_bottom_app_bar_delete": "Supprimer",
   "control_bottom_app_bar_favorite": "Favoris",
   "control_bottom_app_bar_share": "Partager",
+  "control_bottom_app_bar_unarchive": "Unarchive",
   "create_album_page_untitled": "Sans titre",
   "create_shared_album_page_create": "Créer",
   "create_shared_album_page_share": "Partager",
@@ -126,6 +135,8 @@
   "delete_dialog_cancel": "Annuler",
   "delete_dialog_ok": "Supprimer",
   "delete_dialog_title": "Supprimer définitivement",
+  "description_input_hint_text": "Add description...",
+  "description_input_submit_error": "Error updating description, check the log for more details",
   "exif_bottom_sheet_description": "Ajouter une description...",
   "exif_bottom_sheet_details": "DÉTAILS",
   "exif_bottom_sheet_location": "LOCALISATION",
@@ -133,16 +144,19 @@
   "experimental_settings_new_asset_list_title": "Activer la grille de photos expérimentale",
   "experimental_settings_subtitle": "Utilisez à vos dépends !",
   "experimental_settings_title": "Expérimental",
+  "favorites_page_no_favorites": "No favorite assets found",
   "favorites_page_title": "Favoris",
   "home_page_add_to_album_conflicts": "{added} éléments ajoutés à l'album {album}. Les éléments {failed} sont déjà dans l'album.",
   "home_page_add_to_album_err_local": "Impossible d'ajouter des éléments locaux aux albums pour le moment, étape ignorée",
   "home_page_add_to_album_success": "{added} éléments ajoutés à l'album {album}.",
+  "home_page_archive_err_local": "Can not archive local assets yet, skipping",
   "home_page_building_timeline": "Construction de la chronologie",
   "home_page_favorite_err_local": "Impossible d'ajouter des éléments locaux aux favoris pour le moment, étape ignorée",
   "home_page_first_time_notice": "Si c'est la première fois que vous utilisez l'application, veillez à choisir un ou plusieurs albums de sauvegarde afin que la chronologie puisse alimenter les photos et les vidéos de cet ou ces albums.",
   "image_viewer_page_state_provider_download_error": "Erreur de téléchargement",
   "image_viewer_page_state_provider_download_success": "Téléchargement réussi",
   "library_page_albums": "Albums",
+  "library_page_archive": "Archive",
   "library_page_device_albums": "Albums on Device",
   "library_page_favorites": "Favoris",
   "library_page_new_album": "Nouvel album",