Version v1.47.1

* feat(web): remove upload file limit with rxjs

* refactor: remove exif

* refactor: remove unused code

* fix: import lodash-es instead of lodash

* refactor: optimize import

.editorconfig

@@ -0,0 +1,19 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{ts,js}]
+quote_type = single
+
+[*.{md,mdx}]
+max_line_length = off
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+quote_type = double

.gitattributes

@@ -0,0 +1,13 @@
+mobile/openapi/**/*.md -diff -merge
+mobile/openapi/**/*.md linguist-generated=true
+mobile/openapi/**/*.dart -diff -merge
+mobile/openapi/**/*.dart linguist-generated=true
+
+web/src/api/open-api/**/*.md -diff -merge
+web/src/api/open-api/**/*.md linguist-generated=true
+
+web/src/api/open-api/**/*.ts -diff -merge
+web/src/api/open-api/**/*.ts linguist-generated=true
+
+mobile/openapi/.openapi-generator/FILES -diff -merge
+mobile/openapi/.openapi-generator/FILES linguist-generated=true

.github/DISCUSSION_TEMPLATE/feature-request.yaml

@@ -0,0 +1,24 @@
+title: "[Feature] <feature-name-goes-here>"
+labels: ["feature"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please use this form to request new feature for Immich
+  - type: textarea
+    id: feature
+    attributes:
+      label: The feature
+    validations:
+      required: true
+
+  - type: checkboxes
+    validations:
+      required: true
+    attributes:
+      label: Platform
+      options:
+        - label: Server
+        - label: Web
+        - label: Mobile

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,46 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: '[BUG] <title>'
-labels: bug, need triage
-assignees: ''
-
----
-
-<!--
-Note: Please search to see if an issue already exists for the bug you encountered.
--->
-
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Task List**
-
-*Please complete the task list below. We need this information to help us reproduce the bug or point out problems in your setup. You are not providing enough info may delay our effort to help you.*
-
-- [ ] I have read thoroughly the README setup and installation instructions.
-- [ ] I have included my `docker-compose` file.
-- [ ] I have included my redacted `.env` file.
-- [ ] I have included information on my machine, and environment.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**System**
-- Phone OS [iOS, Android]: `<version>`
-- Server Version: `<version>`
-- Mobile App Version: `<version>`
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,100 @@
+name: Report an issue with Immich
+description: Report an issue with Immich
+labels: ["bug", "need triage"]
+title: "[BUG] <title>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for reporting bugs only!
+
+        If you have a feature or enhancement request, please use the [feature request][fr] section of our [GitHub Discussions][fr].
+
+        [fr]: https://github.com/immich-app/immich/discussions/new?category=feature-request
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: The bug
+      description: >-
+        Describe the issue you are experiencing here, to communicate to the
+        maintainers. Tell us what you were trying to do and what happened.
+
+        Provide a clear and concise description of what the problem is.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: The OS that Immich Server is running on
+      placeholder: Ubuntu 22.10, Debian, Arch...etc
+
+  - type: input
+    id: version
+    validations:
+      required: true
+    attributes:
+      label: Version of Immich Server
+      placeholder: v1.0.0
+
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Version of Immich Mobile App
+      placeholder: v1.0.0
+
+  - type: checkboxes
+    validations:
+      required: true
+    attributes:
+      label: Platform with the issue
+      options:
+        - label: Server
+        - label: Web
+        - label: Mobile
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Your docker-compose.yml content
+      render: YAML
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Your .env content
+      description: Please provide the redacted .env content of your setup
+      render: Shell
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: "How do you trigger this bug? Please walk us through it step by step."
+      value: |
+        1.
+        2.
+        3.
+        ...
+      render: bash
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        If you have any additional information for us, use the field below.
+
+  - type: markdown
+    attributes:
+      value: Thank you for submitting the form

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,32 +0,0 @@
-name: Feature Request
-description: Request a feature that you would like for the app
-title: "[Feature]: "
-labels: ["feature", "need triage"]
-assignees:
-  - ""
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this feature request!
-
-  - type: textarea
-    id: feature-detail
-    attributes:
-      label: Feature detail
-      placeholder: Describe the feature you would like to see for the app
-    validations:
-      required: true
-
-  - type: dropdown
-    id: platform
-    attributes:
-      label: Platform
-      description: Choose the platform for the feature
-      options:
-        - Web
-        - Mobile App
-        - Server
-    validations:
-      required: true

.github/workflows/build-mobile.yml

@@ -0,0 +1,67 @@
+name: Build Mobile
+
+on:
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  build-sign-android:
+    name: Build and sign Android
+    runs-on: macos-12
+
+    steps:
+      - name: Determine ref
+        id: get-ref
+        run: |
+          input_ref="${{ inputs.ref }}"
+          github_ref="${{ github.sha }}"
+          ref="${input_ref:-$github_ref}"
+          echo "ref=$ref" >> $GITHUB_OUTPUT
+          
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ steps.get-ref.outputs.ref }}
+
+      - uses: actions/setup-java@v3
+        with:
+          distribution: "zulu"
+          java-version: "12.x"
+          cache: "gradle"
+
+      - name: Setup Flutter SDK
+        uses: subosito/flutter-action@v2
+        with:
+          channel: "stable"
+          flutter-version: "3.7.3"
+          cache: true
+
+      - name: Create the Keystore
+        env:
+          KEY_JKS: ${{ secrets.KEY_JKS }}
+        working-directory: ./mobile
+        run: echo $KEY_JKS | base64 -d > android/key.jks
+
+      - name: Get Packages
+        working-directory: ./mobile
+        run: flutter pub get
+
+      - name: Build Android App Bundle
+        working-directory: ./mobile
+        env:
+          ALIAS: ${{ secrets.ALIAS }}
+          ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_KEY_PASSWORD }}
+          ANDROID_STORE_PASSWORD: ${{ secrets.ANDROID_STORE_PASSWORD }}
+        run: flutter build apk --release
+
+      - name: Publish Android Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: release-apk-signed
+          path: mobile/build/app/outputs/flutter-apk/app-release.apk

.github/workflows/build_push_docker_latest.yml

@@ -1,120 +0,0 @@
-name: Build and Push Docker Image - Latest
-
-on:
-  workflow_dispatch:
-  push:
-    branches: [main]
-
-jobs:
-  # This image include both the server and microservices - the two containers can be slitted into separated
-  # service with its coressponding entry file.
-  build_and_push_server_monorepo_latest:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and push Immich Mono Repo
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./server
-          file: ./server/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: true
-          tags: |
-            altran1502/immich-server:latest
-
-  build_and_push_machine_learning_latest:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Machine Learning
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./machine-learning
-          file: ./machine-learning/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: true
-          tags: |
-            altran1502/immich-machine-learning:latest
-
-  build_and_push_web_latest:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Web
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./web
-          file: ./web/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          target: prod
-          push: true
-          tags: |
-            altran1502/immich-web:latest
-
-  build_and_push_nginx_latest:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Proxy
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./nginx
-          file: ./nginx/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: true
-          tags: |
-            altran1502/immich-proxy:latest

.github/workflows/build_push_docker_staging.yml

@@ -1,126 +0,0 @@
-name: Build and Push Docker Image - Staging
-
-on:
-  workflow_dispatch:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  # This image include both the server and microservices - the two containers can be slitted into separated
-  # service with its coressponding entry file.
-  build_and_push_server_monorepo_staging:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        if: ${{ github.repository == 'immich-app/immich' }}
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and push Immich Mono Repo
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./server
-          file: ./server/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name == 'pull_request' && github.repository == 'immich-app/immich' }}
-          tags: |
-            altran1502/immich-server:staging
-
-  build_and_push_machine_learning_staging:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        if: ${{ github.repository == 'immich-app/immich' }}
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Machine Learning
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./machine-learning
-          file: ./machine-learning/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name == 'pull_request' && github.repository == 'immich-app/immich' }}
-          tags: |
-            altran1502/immich-machine-learning:staging
-
-  build_and_push_web_staging:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        if: ${{ github.repository == 'immich-app/immich' }}
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Web
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./web
-          file: ./web/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          target: prod
-          push: ${{ github.event_name == 'pull_request' && github.repository == 'immich-app/immich' }}
-          tags: |
-            altran1502/immich-web:staging
-
-  build_and_push_nginx_staging:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        if: ${{ github.repository == 'immich-app/immich' }}
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Proxy
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./nginx
-          file: ./nginx/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name == 'pull_request' && github.repository == 'immich-app/immich' }}
-          tags: |
-            altran1502/immich-proxy:staging

.github/workflows/build_push_server_release.yml

@@ -1,158 +0,0 @@
-name: Build and push Docker image - Release
-
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  build_and_push_server_monorepo_release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: "main"
-          fetch-depth: 0
-
-      - name: "Get Previous tag"
-        id: previoustag
-        uses: "WyriHaximus/github-action-get-previous-tag@v1"
-        with:
-          fallback: latest
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Build and push immich-server release
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./server
-          file: ./server/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: |
-            altran1502/immich-server:${{ steps.previoustag.outputs.tag }}
-            altran1502/immich-server:release
-
-  build_and_push_machine_learning_release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: "Get Previous tag"
-        id: previoustag
-        uses: "WyriHaximus/github-action-get-previous-tag@v1"
-        with:
-          fallback: latest
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build and Push Machine Learning
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./machine-learning
-          file: ./machine-learning/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: true
-          tags: |
-            altran1502/immich-machine-learning:${{ steps.previoustag.outputs.tag }}
-            altran1502/immich-machine-learning:release
-
-  build_and_push_web_release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: "main"
-          fetch-depth: 0
-
-      - name: "Get Previous tag"
-        id: previoustag
-        uses: "WyriHaximus/github-action-get-previous-tag@v1"
-        with:
-          fallback: latest
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Build and push immich-web release
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./web
-          file: ./web/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          target: prod
-          tags: |
-            altran1502/immich-web:${{ steps.previoustag.outputs.tag }}
-            altran1502/immich-web:release
-
-  build_and_push_nginx_release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: "main"
-          fetch-depth: 0
-
-      - name: "Get Previous tag"
-        id: previoustag
-        uses: "WyriHaximus/github-action-get-previous-tag@v1"
-        with:
-          fallback: latest
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2.0.0
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Build and push immich-proxy release
-        uses: docker/build-push-action@v3.1.1
-        with:
-          context: ./nginx
-          file: ./nginx/Dockerfile
-          platforms: linux/arm/v7,linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: |
-            altran1502/immich-proxy:release
-            altran1502/immich-proxy:${{ steps.previoustag.outputs.tag }}

.github/workflows/cache-cleanup.yml

@@ -0,0 +1,33 @@
+name: Clean up actions cache on PR close
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        
+      - name: Cleanup
+        run: |
+          gh extension install actions/gh-actions-cache
+          
+          REPO=${{ github.repository }}
+          BRANCH=${{ github.ref }}
+
+          echo "Fetching list of cache keys"
+          cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH -L 100 | cut -f 1 )
+
+          ## Setting this to not fail the workflow while deleting cache keys. 
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeysForPR
+          do
+              gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dispatch_sdk_update.yml

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

.github/workflows/docker.yml

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

.github/workflows/prepare-release.yml

@@ -0,0 +1,78 @@
+name: Prepare new release
+
+on:
+  workflow_dispatch:
+    inputs:
+      serverBump:
+        description: "Bump server version"
+        required: true
+        default: "false"
+        type: choice
+        options:
+          - "false"
+          - minor
+          - patch
+      mobileBump:
+        description: "Bump mobile build number"
+        required: false
+        type: boolean
+
+jobs:
+  bump_version:
+    runs-on: ubuntu-latest
+    
+    outputs:
+      ref: ${{ steps.push-tag.outputs.commit_long_sha }}
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.ORG_RELEASE_TOKEN }}
+
+      - name: Bump version
+        run: misc/release/pump-version.sh -s "${{ inputs.serverBump }}" -m "${{ inputs.mobileBump }}"
+
+      - name: Commit and tag
+        id: push-tag
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: Immich Release Bot
+          author_email: bot@immich.app
+          message: "Version ${{ env.IMMICH_VERSION }}"
+          tag: ${{ env.IMMICH_VERSION }}
+          push: true
+          
+  build_mobile:
+    uses: ./.github/workflows/build-mobile.yml
+    needs: bump_version
+    secrets: inherit
+    with:
+      ref: ${{ needs.bump_version.outputs.ref }}
+
+  prepare_release:
+    runs-on: ubuntu-latest
+    needs: build_mobile
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.ORG_RELEASE_TOKEN }}
+          
+      - name: Download APK
+        uses: actions/download-artifact@v3
+        with:
+          name: release-apk-signed
+
+      - name: Create draft release
+        uses: softprops/action-gh-release@v1
+        with:
+          draft: true
+          tag_name: ${{ env.IMMICH_VERSION }}
+          generate_release_notes: true
+          body_path: misc/release/notes.tmpl
+          files: |
+            docker/docker-compose.yml
+            docker/example.env
+            *.apk

.github/workflows/static_analysis.yml

@@ -0,0 +1,31 @@
+name: Static Code Analysis
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  mobile-dart-analyze:
+    name: Run Dart Code Analysis
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Flutter SDK
+        uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+          flutter-version: '3.7.3'
+
+      - name: Install dependencies
+        run: dart pub get
+        working-directory: ./mobile
+
+      - name: Run dart analyze
+        run: dart analyze --fatal-infos
+        working-directory: ./mobile
+

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Run Immich Server 2E2 Test
+      - 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
 
   server-unit-tests:
@@ -39,3 +39,56 @@ jobs:
 
       - name: Run tests
         run: cd web && npm ci && npm run check:all
+
+  mobile-unit-tests:
+    name: Run mobile unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Flutter SDK
+        uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+          flutter-version: '3.7.3'
+      - name: Run tests
+        working-directory: ./mobile
+        run: flutter test
+
+  mobile-integration-tests:
+    name: Run mobile end-to-end integration tests
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '11'
+      - name: Cache android SDK
+        uses: actions/cache@v3
+        id: android-sdk
+        with:
+          key: android-sdk
+          path: |
+            /usr/local/lib/android/
+            ~/.android
+      - name: Setup Android SDK
+        if: steps.android-sdk.outputs.cache-hit != 'true'
+        uses: android-actions/setup-android@v2
+      - name: Setup Flutter SDK
+        uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+          flutter-version: '3.7.3'
+      - name: Run integration tests
+        uses: reactivecircus/android-emulator-runner@v2.27.0
+        with:
+          working-directory: ./mobile
+          api-level: 29
+          arch: x86_64
+          profile: pixel
+          target: default
+          emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim
+          disable-linux-hw-accel: false
+          script: |
+            flutter pub get
+            flutter test integration_test

.gitignore

@@ -1,3 +1,12 @@
 .DS_Store
-.vscode
-.idea
+.vscode/*
+!.vscode/launch.json
+.idea
+
+docker/upload
+uploads
+coverage
+
+mobile/gradle.properties
+mobile/openapi/pubspec.lock
+mobile/*.jks

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "restart": true,
+      "port": 9230,
+      "name": "Immich Server",
+      "remoteRoot": "/usr/src/app",
+      "localRoot": "${workspaceFolder}/server"
+    }
+  ]
+}

Makefile

@@ -4,6 +4,9 @@ dev:
 dev-new:
 	rm -rf ./server/dist && 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
+
 dev-update:
 	rm -rf ./server/dist && docker-compose -f ./docker/docker-compose.dev.yml up --build -V --remove-orphans
 
@@ -26,4 +29,7 @@ prod-scale:
 	docker-compose -f ./docker/docker-compose.yml up --build -V --scale immich-server=3 --scale immich-microservices=3 --remove-orphans
 
 api:
-	cd ./server && npm run api:generate
+	cd ./server && npm run api:generate
+
+attach-server:
+	docker exec -it docker_immich-server_1 sh

NOTES.md

@@ -1,9 +0,0 @@
-# TODO
-
-Server scenario with web
-
-[ ] 1 user exist without admin right -> make admin on first check
-
-[ ] 2 users exist without admin right -> ask user to choose which account will be the admin
-
-[ X ] No users exist -> prompt signup form for Admin

README.md

@@ -1,36 +1,55 @@
-<h1 align="center"> Immich </h1>
- <p align="center"> <b>High performance self-hosted photo and video backup solution.</b> </p>
-<p align="center">
-  <img src="design/feature-panel.png"  title="Immich Logo">
-</p>
-
-<p align="center">
+<p align="center"> 
+  <br/>  
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
-  <a href="https://github.com/alextran1502/immich"><img src="https://img.shields.io/github/stars/alextran1502/immich.svg?style=for-the-badge&logo=github&color=3F51B5&label=Stars&logoColor=000000&labelColor=ececec" alt="Star on Github"></a>
-  <a href="https://immichci.little-home.net/viewType.html?buildTypeId=Immich_BuildAndroidAndGetArtifact&guest=1">
-    <img src="https://img.shields.io/teamcity/http/immichci.little-home.net/s/Immich_BuildAndroidAndGetArtifact.svg?style=for-the-badge&label=Android&logo=teamcity&logoColor=000000&labelColor=ececec" alt="Android Build"/>
-  </a>
-  <a href="https://immichci.little-home.net/viewType.html?buildTypeId=Immich_BuildAndPublishIOSToTestFlight&guest=1">
-    <img src="https://img.shields.io/teamcity/http/immichci.little-home.net/s/Immich_BuildAndPublishIOSToTestFlight.svg?style=for-the-badge&label=iOS&logo=teamcity&logoColor=000000&labelColor=ececec" alt="iOS Build"/>
-  </a>
-  <a href="https://actions-badge.atrox.dev/alextran1502/immich/goto?ref=main">
-    <img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Falextran1502%2Fimmich%2Fbadge%3Fref%3Dmain&style=for-the-badge&label=Github Action&logo=github&labelColor=ececec&logoColor=000000" />
-  </a>
   <a href="https://discord.gg/D8JsnBEuKb">
-    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Immich%20Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Immich Discord"/>
+    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
   </a>
   <br/>  
   <br/>   
 </p>
 
+<p align="center">
+<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
+</p>
+<h3 align="center">Immich - High performance self-hosted photo and video backup solution</h3>
+<br/>
+<a href="https://immich.app">
+<img src="design/immich-screenshots.png" title="Main Screenshot">
+</a>
+<br/>
+<p align="center">
+  <a href="README_zh_CN.md">中文</a>
+</p>
+
+## Disclaimer
+
+- ⚠️ The project is under **very active** development.
+- ⚠️ Expect bugs and breaking changes.
+- ⚠️ **Do not use the app as the only way to store your photos and videos!**
+
+## Content
+
+- [Official Documentation](https://immich.app/docs)
+- [Roadmap](https://github.com/orgs/immich-app/projects/1)
+- [Demo](#demo)
+- [Features](#features)
+- [Introduction](https://immich.app/docs/overview/introduction)
+- [Installation](https://immich.app/docs/install/requirements)
+- [Contribution Guidelines](https://immich.app/docs/overview/support-the-project)
+- [Support The Project](#support-the-project)
+- [Known Issues](#known-issues)
+
+## Documentation
+
+You can find the main documentation, including installation guides, at https://immich.app/.
+
 ## Demo
 
 You can access the web demo at https://demo.immich.app
 
-For the mobile app, you can use https://demo.immich.app/api for the `Server Endpoint URL`
+For the mobile app, you can use `https://demo.immich.app/api` for the `Server Endpoint URL`
 
-
-```
+```bash title="Demo Credential"
 The credential
 email: demo@immich.app
 password: demo
@@ -40,228 +59,48 @@ password: demo
 Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 ```
 
-## Content
-- [Features](#features)
-- [Screenshots](#screenshots)
-- [Installation](#installation)
-- [Update](#update)
-- [Mobile App](#mobile-app)
-- [Development](#development)
-- [Support](#support)
-- [Known Issues](#known-issues)
-
-# Features 
-
-> ⚠️ WARNING: **NOT READY FOR PRODUCTION! DO NOT USE TO STORE YOUR ASSETS**. This project is under heavy development, there will be continuous functions, features and api changes.
-
-| 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 | Yes | Yes
-| Shared Albums | Yes | Yes
-| Quick navigation with draggable scrollbar | Yes | Yes
-| Support RAW (HEIC, HEIF, DNG, Apple ProRaw) | Yes | Yes
-| Metadata view (EXIF, map) | Yes | Yes
-| Search by metadata, objects and image tags | Yes | No
-| Administrative functions (user management) | N/A | Yes
-| Background backup | Android | N/A
-| Virtual scroll | N/A | Yes
-
-
-  <br/>  
-
-# Screenshots
-
-### Mobile
-| | | | | |
-| - | - | - | - | - |
-| <img src="design/login-screen.png" width="150" title="Login With Custom URL"> <p align="center"> Login with custom URL </p> | <img src="design/backup-screen.png" width="150" title="Backup Setting Info"> <p align="center"> Backup Settings </p> | <img src="design/selective-backup-screen.png" width="150" title="Backup Setting Info"> <p align="center"> Backup selection </p> | <img src="design/home-screen.jpeg" width="150" title="Home Screen"> <p align="center"> Home Screen </p> | <img src="design/search-screen.jpeg" width="150" title="Curated Search Info"> <p align="center"> Curated search </p> |
-| <img src="design/shared-albums.png" width="150" title="Shared Albums"> <p align="center"> Shared albums </p>  |  <img src="design/nsc6.png" width="150" title="EXIF Info"> <p align="center"> EXIF info </p>  | <img src="https://media.giphy.com/media/y8ZeaAigGmNvlSoKhU/giphy.gif" width="150" title="Loading ~4000 images/videos"> <p align="center"> Loading ~4000 images/videos </p>  |
-
-### Web
-| Home Dashboard | Image view |
-| - | - |
-|<img src="design/web-home.jpeg"  width="100%" title="Home Dashboard"> | <img src="design/web-detail.jpeg" width="100%" title="Detail">|
-
-
-  <br/>  
-
-# Project Details
-## 💾 System Requirements
-
-- **OS**: Preferred unix-based operating system (Ubuntu, Debian, MacOS...etc). 
-
-- **RAM**: At least 2GB, preferred 4GB.
-
-- **Core**: At least 2 cores, preferred 4 cores.
-
-## 🔩 Technology Stack
-
-There are several services that compose Immich:
-
-1. **NestJs** - Backend of the application
-2. **SvelteKit** - Web frontend of the application
-3. **PostgreSQL** - Main database of the application
-4. **Redis** - For sharing websocket instance between docker instances and background tasks message queue.
-5. **Nginx** - Load balancing and optimized file uploading.
-6. **TensorFlow** - Object Detection (COCO SSD) and Image Classification (ImageNet).
-
-
-  <br/>  
-
-# Installation
-
-NOTE: When using a reverse proxy in front of Immich (such as NGINX), the reverse proxy might require extra configuration to allow large files to be uploaded (such as client_max_body_size in the case of NGINX).
-
-## Testing One-step installation (not recommended for production)
-
-> ⚠️ *This installation method is for evaluating Immich before futher customization to meet the users' needs.*
-
-*Applicable system: Ubuntu, Debian, MacOS*
-
-- In the shell, from the directory of your choice, run the following command:
-
-```bash
-curl -o- https://raw.githubusercontent.com/immich-app/immich/main/install.sh | bash
-```
-
-This script will download the `docker-compose.yml` file and the `.env` file, then populate the necessary information, and finally run the `docker-compose up` or `docker compose up` (based on your docker's version) command. 
-
-The web application will be available at `http://<machine-ip-address>:2283`, and the server URL for the mobile app will be `http://<machine-ip-address>:2283/api`.
-
-The directory which is used to store the backup file is `./immich-app/immich-data`.
-
-
-  <br/>  
-
-## Custom installation (Recommended)
-
-### Step 1 - Download necessary files
-
-- Create a directory called `immich-app` and cd into it.
-
-- Get `docker-compose.yml`
-
-```bash
-wget https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml
-```
-
-- Get `.env`
-
-```bash
-wget -O .env https://raw.githubusercontent.com/immich-app/immich/main/docker/.env.example
-```
-
-### Step 2 - Populate .env file with custom information
-
-<a href="https://github.com/immich-app/immich/blob/main/docker/.env.example" target="_blank"><b>See the example <code>.env</code> file</b></a>
-
-* Populate custom database information if necessary.
-* Populate `UPLOAD_LOCATION` as prefered location for storing backup assets.
-* Populate a secret value for `JWT_SECRET`, you can use this command: `openssl rand -base64 128`
-
-### Step 3 - Start the containers
-
-- Run `docker-compose up` or `docker compose up` (based on your docker's version)
-
-### Step 4 - Register admin user
-
-- Navigate to the web at `http://<machine-ip-address>:2283` and follow the prompts to register admin user. 
-<p align="center">
-  <img src="design/admin-registration-form.png" width="300" title="Admin Registration">
-</p>
-
-- You can add and manage users from the administration page. 
-<p align="center">
- <img src="design/admin-interface.png" width="500" title="Admin User Management">
-</p>
-
-### Step 5 - Access the mobile app
-
-- Login the mobile app with the server endpoint URL at `http://<machine-ip-address>:2283/api`
-<p align="center">
-  <img src="design/login-screen.jpeg" width="250" title="Example login screen">
-</p> 
-
-  <br/>  
-
-## Update
-
-If you have installed, you can update the application by navigate to the directory that contains the `docker-compose.yml` file and run the following command:
-
-```bash
-docker-compose pull && docker-compose up -d
-```
-
-# Mobile app
-
-| F-Droid | Google Play | iOS |
-| - | - | - |
-| <a href="https://f-droid.org/packages/app.alextran.immich"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"></a> | <p align="left"> <a href="https://play.google.com/store/apps/details?id=app.alextran.immich"><img src="design/google-play-qr-code.png" width="200" title="Google Play Store"></a> <p/> | <p align="left"> <a href="https://apps.apple.com/us/app/immich/id1613945652"><img src="design/ios-qr-code.png" width="200" title="Apple App Store"></a> <p/> |
-
-> *The Play/App Store version might be lagging behind the latest release due to the review process.*
-
-
-  <br/>  
-
-# Development
-
-The development environment can be started from the root of the project after populating the `.env` file with the command:
-
-```bash
-make dev # required Makefile installed on the system.
-``` 
-
-All servers and web container are hot reload for quick feedback loop.
-
-## Note for developers
-### 1 - OpenAPI
-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 generate command below to update the client SDK.
-
-```bash
-npm run api:generate # Run from server directory
-```
-You can find the generated client SDK in the [`web/src/api`](web/src/api) for Typescript SDK and [`mobile/openapi`](mobile/openapi) for Dart SDK.
-
-
-  <br/>  
-
-# Support
-
-If you like the app, find it helpful, and want to support me to offset the cost of publishing to AppStores, you can sponsor the project with [**one time**](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) or monthly donation from [**Github Sponsor**](https://github.com/sponsors/alextran1502).
-
-You can also donate using crypto currency with the following addresses:
-
-<p align="" style="display: flex; place-items: center; gap: 15px" title="Bitcoin(BTC)"><img src="design/bitcoin.png" width="25" title="Bitcoin"> <b>Bitcoin</b>: <code>1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX</code></p>
-
-<p align="" style="display: flex; place-items: center; gap: 15px" title="Cardano(ADA)"> <img src="design/cardano.png" width="30" title="Cardano"> <b>Cardano</b>: <code>addr1qyy567vqhqrr3p7vpszr5p264gw89sqcwts2z8wqy4yek87cdmy79zazyjp7tmwhkluhk3krvslkzfvg0h43tytp3f5q49nycc</code> </p>
-
-
-This is also a meaningful way to give me motivation and encouragement to continue working on the app.
-
-Cheers! 🎉
-
-
-  <br/>  
+# 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 image tags  | Yes     | No  |
+| Administrative functions (user management)  | N/A     | Yes |
+| Background backup                           | Android | 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 |
+
+# Support the project
+
+I've committed to this project, and I will not stop. I will keep updating the docs, adding new features, and fixing bugs. But I can't do it alone. So I need your help to give me additional motivation to keep going.
+
+As our hosts in the [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) said, this is a massive undertaking of what the team and I are doing. And I would love to someday be able to do this full-time, and I am asking for your help to make that happen.
+
+If you feel like this is the right cause and the app is something you are seeing yourself using for a long time, please consider supporting the project with the option below.
+
+## Donation
+
+- [Monthly donation](https://github.com/sponsors/alextran1502) via GitHub Sponsors
+- [One-time donation](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via Github Sponsors
+- [Librepay](https://liberapay.com/alex.tran1502/)
+- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
+- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
 
 # Known Issues
 
-## TensorFlow Build Issue
+## immich-machine-learning fails to start
 
-*This is a known issue for incorrect Proxmox setup*
+Symptoms: the container logs `illegal instruction core dump` and restarts
 
-TensorFlow doesn't run with older CPU architecture, it requires a CPU with AVX and AVX2 instruction set. If you encounter the error `illegal instruction core dump` when running the docker-compose command above, check for your CPU flags with the command and make sure you see `AVX` and `AVX2`:
- 
-```bash
-more /proc/cpuinfo | grep flags
-``` 
-  
-If you are running virtualization in Proxmox, the VM doesn't have the flag enabled.
-  
-You need to change the CPU type from `kvm64` to `host` under VMs hardware tab.
-  
-`Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host`
+Solution: https://immich.app/docs/install/requirements#hardware

README_zh_CN.md

@@ -0,0 +1,115 @@
+<p align="center"> 
+  <br/>  
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt="License: MIT"></a>
+  <a href="https://discord.gg/D8JsnBEuKb">
+    <img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" atl="Discord"/>
+  </a>
+  <br/>  
+  <br/>   
+</p>
+
+<p align="center">
+<img src="design/immich-logo.svg" width="150" title="Login With Custom URL">
+</p>
+<h3 align="center">Immich - 高性能的自托管照片和视频备份方案</h3>
+<p align="center">  
+请注意: 此README不是由Immich团队维护, 这意味着它在某一时间点不会被更新，因为我们是依靠贡献者来更新的。感谢理解。
+</p>
+<br/>
+<a href="https://immich.app">
+<img src="design/immich-screenshots.png" title="Main Screenshot">
+</a>
+<br/>
+
+<p align="center">
+  <a href="README.md">English</a>
+</p>
+
+
+## 免责声明
+
+- ⚠️ 本项目正在 **非常活跃** 的开发中。
+- ⚠️ 可能存在bug或者重大变更。
+- ⚠️ **不要把本软件作为你存储照片或视频的唯一方式!**
+
+## 目录
+
+- [官方文档](https://immich.app/docs/overview/introduction)
+- [示例](#示例)
+- [功能特性](#功能特性)
+- [介绍](https://immich.app/docs/overview/introduction)
+- [安装](https://immich.app/docs/install/requirements)
+- [贡献指南](https://immich.app/docs/overview/support-the-project)
+- [支持本项目](#support-the-project)
+- [已知问题](#known-issues)
+
+## 官方文档
+
+你可以在 https://immich.app/ 找到包含安装手册的官方文档.
+## 示例
+
+你可以在 https://demo.immich.app  访问示例.
+
+在移动端, 你可以使用 `https://demo.immich.app/api`获取`服务终端链接`
+
+```bash title="示例认证信息"
+认证信息
+邮箱: demo@immich.app
+密码: demo
+```
+
+```
+规格: 甲骨文免费虚拟机套餐-阿姆斯特丹 4核 2.4Ghz ARM64 CPU, 24GB RAM。
+```
+
+# 功能特性
+
+| 功能特性                                     | 移动端  | 网页端 |
+| ------------------------------------------- | ------- | --- |
+| 上传并查看照片和视频                       | 是     | 是 |
+| 软件运行时自动备份          | 是     | N/A |
+| 选择需要备份的相册          | 是     | N/A |
+| 下载照片和视频到本地  | 是     | 是 |
+| 多用户支持                          | 是     | 是 |
+| 相册                                       | 是     | 是 |
+| 共享相册                               | 是     | 是 |
+| 可拖动的快速导航栏   | 是     | 是 |
+| 支持RAW格式 (HEIC, HEIF, DNG, Apple ProRaw) | 是     | 是 |
+| 元数据视图 (EXIF, 地图)                   | 是     | 是 |
+| 通过元数据、对象和标签进行搜索  | 是     | No  |
+| 管理功能 (用户管理)  | N/A     | 是 |
+| 后台备份                         | Android | N/A |
+| 虚拟滚动                             | 是     | 是 |
+| OAuth支持                               | 是     | 是 |
+| 实时照片备份和查看 (仅iOS)   | 是     | 是 |
+
+# 支持本项目
+
+我已经致力于本项目并且将我会持续更新文档、新增功能和修复问题。但是我不能一个人走下去，所以我需要你给予我走下去的动力。
+
+就像我主页里面 [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor'](https://selfhosted.show/79?t=1418) 说的一样,这是我和团队的一项艰巨的任务。我希望某一天我能够全职开发本项目，在此我希望你们能够助我梦想成真。
+
+如果你使用了本项目一段时间，并且觉得上面的话有道理，那么请你按照如下方式帮助我吧。
+
+## 捐赠
+
+- [按月捐赠](https://github.com/sponsors/alextran1502) via GitHub Sponsors
+- [一次捐赠](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) via Github Sponsors
+
+# 已知问题
+
+## TensorFlow 构建问题
+
+_这是一个针对于Proxmox的已知问题_
+
+TensorFlow 不能运行在很旧的CPU架构上, 需要运行在AVX和AVX2指令集的CPU上。如果你在docker-compose的命令行中遇到了 `illegal instruction core dump`的错误, 通过如下命令检查你的CPU flag寄存器然后确保你能够看到`AVX`和`AVX2`的字样:
+
+```bash
+more /proc/cpuinfo | grep flags
+```
+
+如果你在Proxmox中运行虚拟机, 虚拟机中没有启用flag寄存器。
+
+你需要在虚拟机的硬件面板中把CPU类型从`kvm64`改为`host`。
+
+`Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host`

docker/.env.test

@@ -5,14 +5,11 @@ DB_PASSWORD=postgres
 DB_DATABASE_NAME=e2e_test
 
 # Redis
-REDIS_HOSTNAME=immich_redis_test
+REDIS_HOSTNAME=immich-redis-test
 
 # Upload File Config
 UPLOAD_LOCATION=./upload
 
-# JWT SECRET
-JWT_SECRET=randomstringthatissolongandpowerfulthatnoonecanguess
-
 # MAPBOX
 ## ENABLE_MAPBOX is either true of false -> if true, you have to provide MAPBOX_KEY
 ENABLE_MAPBOX=false

docker/docker-compose.dev.yml

@@ -2,16 +2,20 @@ version: "3.8"
 
 services:
   immich-server:
+    container_name: immich_server
     image: immich-server-dev:latest
     build:
       context: ../server
       dockerfile: Dockerfile
       target: builder
-    command: npm run start:dev immich
+    command: npm run start:debug immich
     volumes:
       - ../server:/usr/src/app
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - /usr/src/app/node_modules
+    ports:
+      - 3001:3001
+      - 9230:9230
     env_file:
       - .env
     environment:
@@ -21,6 +25,7 @@ services:
       - database
 
   immich-machine-learning:
+    container_name: immich_machine_learning
     image: immich-machine-learning-dev:latest
     build:
       context: ../machine-learning
@@ -39,6 +44,7 @@ services:
       - database
 
   immich-microservices:
+    container_name: immich_microservices
     image: immich-microservices:latest
     build:
       context: ../server
@@ -58,6 +64,7 @@ services:
       - immich-server
 
   immich-web:
+    container_name: immich_web
     image: immich-web-dev:1.9.0
     build:
       context: ../web
@@ -66,6 +73,10 @@ services:
     command: npm run dev --host
     env_file:
       - .env
+    environment:
+      # Rename these values for svelte public interface
+      - PUBLIC_IMMICH_SERVER_URL=${IMMICH_SERVER_URL}
+      - PUBLIC_IMMICH_API_URL_EXTERNAL=${IMMICH_API_URL_EXTERNAL}
     ports:
       - 3000:3000
       - 24678:24678
@@ -98,6 +109,10 @@ services:
   immich-proxy:
     container_name: immich_proxy
     image: immich-proxy-dev:latest
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
     build:
       context: ../nginx
       dockerfile: Dockerfile

docker/docker-compose.staging.yml

@@ -2,6 +2,7 @@ version: "3.8"
 
 services:
   immich-server:
+    container_name: immich_server
     image: altran1502/immich-server:staging
     entrypoint: ["/bin/sh", "./start-server.sh"]
     volumes:
@@ -16,6 +17,7 @@ services:
     restart: always
 
   immich-microservices:
+    container_name: immich_microservices
     image: altran1502/immich-server:staging
     entrypoint: ["/bin/sh", "./start-microservices.sh"]
     volumes:
@@ -30,6 +32,7 @@ services:
     restart: always
 
   immich-machine-learning:
+    container_name: immich_machine_learning
     image: altran1502/immich-machine-learning:staging
     entrypoint: ["/bin/sh", "./entrypoint.sh"]
     volumes:
@@ -43,10 +46,15 @@ services:
     restart: always
 
   immich-web:
+    container_name: immich_web
     image: altran1502/immich-web:staging
     entrypoint: ["/bin/sh", "./entrypoint.sh"]
     env_file:
       - .env
+    environment:
+      # Rename these values for svelte public interface
+      - PUBLIC_IMMICH_SERVER_URL=${IMMICH_SERVER_URL}
+      - PUBLIC_IMMICH_API_URL_EXTERNAL=${IMMICH_API_URL_EXTERNAL}
     restart: always
 
   redis:
@@ -71,6 +79,10 @@ services:
   immich-proxy:
     container_name: immich_proxy
     image: altran1502/immich-proxy:staging
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
     ports:
       - 2283:8080
     logging:

docker/docker-compose.test.yml

@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 services:
   immich-server-test:
@@ -9,7 +9,7 @@ services:
       target: builder
     command: npm run test:e2e
     expose:
-      - "3000"
+      - '3000'
     volumes:
       - ../server:/usr/src/app
       - /usr/src/app/node_modules

docker/docker-compose.yml

@@ -2,6 +2,7 @@ version: "3.8"
 
 services:
   immich-server:
+    container_name: immich_server
     image: altran1502/immich-server:release
     entrypoint: ["/bin/sh", "./start-server.sh"]
     volumes:
@@ -16,6 +17,7 @@ services:
     restart: always
 
   immich-microservices:
+    container_name: immich_microservices
     image: altran1502/immich-server:release
     entrypoint: ["/bin/sh", "./start-microservices.sh"]
     volumes:
@@ -30,6 +32,7 @@ services:
     restart: always
 
   immich-machine-learning:
+    container_name: immich_machine_learning
     image: altran1502/immich-machine-learning:release
     entrypoint: ["/bin/sh", "./entrypoint.sh"]
     volumes:
@@ -43,6 +46,7 @@ services:
     restart: always
 
   immich-web:
+    container_name: immich_web
     image: altran1502/immich-web:release
     entrypoint: ["/bin/sh", "./entrypoint.sh"]
     env_file:
@@ -71,6 +75,10 @@ services:
   immich-proxy:
     container_name: immich_proxy
     image: altran1502/immich-proxy:release
+    environment:
+      # Make sure these values get passed through from the env file
+      - IMMICH_SERVER_URL
+      - IMMICH_WEB_URL
     ports:
       - 2283:8080
     logging:

docker/example.env

@@ -23,29 +23,16 @@ REDIS_HOSTNAME=immich_redis
 # REDIS_SOCKET=
 
 ###################################################################################
-# Upload File Config
+# Upload File Location
+#
+# This is the location where uploaded files are stored.
 ###################################################################################
 
 UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup
 
-###################################################################################
-# Log message level - [simple|verbose]
-###################################################################################
-
-LOG_LEVEL=simple
-
-###################################################################################
-# JWT SECRET
-###################################################################################
-
-JWT_SECRET=randomstringthatissolongandpowerfulthatnoonecanguess
-
 ###################################################################################
 # Reverse Geocoding
-####################################################################################
-
-# DISABLE_REVERSE_GEOCODING=false
-
+#
 # Reverse geocoding is done locally which has a small impact on memory usage
 # This memory usage can be altered by changing the REVERSE_GEOCODING_PRECISION variable
 # This ranges from 0-3 with 3 being the most precise
@@ -53,14 +40,40 @@ JWT_SECRET=randomstringthatissolongandpowerfulthatnoonecanguess
 # 2 - Cities > 1000 population: ~150MB RAM
 # 1 - Cities > 5000 population: ~80MB RAM
 # 0 - Cities > 15000 population: ~40MB RAM
+####################################################################################
 
+# DISABLE_REVERSE_GEOCODING=false
 # REVERSE_GEOCODING_PRECISION=3
 
 ####################################################################################
 # WEB - Optional
+#
+# Custom message on the login page, should be written in HTML form.
+# For example:
+# PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
 ####################################################################################
 
-# Custom message on the login page, should be written in HTML form.
-# For example PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
-
 PUBLIC_LOGIN_PAGE_MESSAGE=
+
+####################################################################################
+# Alternative Service Addresses - Optional
+#
+# This is an advanced feature for users who may be running their immich services on different hosts.
+# It will not change which address or port that services bind to within their containers, but it will change where other services look for their peers.
+# Note: immich-microservices is bound to 3002, but no references are made
+####################################################################################
+
+IMMICH_WEB_URL=http://immich-web:3000
+IMMICH_SERVER_URL=http://immich-server:3001
+IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3003
+
+####################################################################################
+# Alternative API's External Address - Optional
+#
+# This is an advanced feature used to control the public server endpoint returned to clients during Well-known discovery.
+# You should only use this if you want mobile apps to access the immich API over a custom URL. Do not include trailing slash.
+# NOTE: At this time, the web app will not be affected by this setting and will continue to use the relative path: /api
+# Examples: http://localhost:3001, http://immich-api.example.com, etc
+####################################################################################
+
+#IMMICH_API_URL_EXTERNAL=http://localhost:3001

docs/.gitignore

@@ -0,0 +1,21 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/blog/authors.yml

@@ -0,0 +1,5 @@
+alextran:
+  name: Alex Tran
+  title: Maintainer of Immich
+  url: https://github.com/alextran1502
+  image_url: https://github.com/alextran1502.png

docs/blog/release-1.36/index.mdx

@@ -0,0 +1,114 @@
+---
+slug: release-1-36
+title: Release v1.36.0
+authors: [alextran]
+tags: [release]
+date: 2022-11-10
+---
+
+Hello everyone, it is my pleasure to deliver the new release of Immich to you. The team has been working hard to bring you the new features and improvements. This release includes some big features that the community has been asking since the beginning of Immich. We hope you will enjoy it.
+
+Some notable features are:
+
+- [OAuth integration](#livephoto-ios-support-)
+- [LivePhoto support on iOS](#oauth-integration-)
+- User config system
+
+<!--truncate-->
+
+## LivePhoto iOS Support 🎉
+
+LivePhoto on iOS is now supported in Immich.
+
+The motion part will now be uploaded and can be played on the mobile app and the web.
+
+:::caution
+
+- The server and the app has to be on version **1.36.x** for the application to work correctly.
+- Previous uploaded photos will not be updated automatically, you will have to remove and reupload them if you want to keep the LivePhoto functionality.
+
+:::
+
+<img
+  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",
+  }}
+  title="LivePhoto playback on the web"
+/>
+
+## OAuth Integration 🎉
+
+I want to borrow this chance to express my gratitude to [@EnricoBilla](https://github.com/EnricoBilla), who has been the trailblazer for this feature since the beginning days of Immich. His PR has sparked ideas, suggestions, and discussion among the team member on how to integrate this feature successfully into the app. Thank you so much for your work and your time.
+
+OAuth is now integrated into the system. Please follow the guide [here](https://immich.app/docs/usage/oauth) to set up your OAuth integration
+
+After setting up the correct environment variables in the `.env` file, as shown below
+
+| Key                 | Type    | Default              | Description                                                               |
+| ------------------- | ------- | -------------------- | ------------------------------------------------------------------------- |
+| OAUTH_ENABLED       | boolean | false                | Enable/disable OAuth2                                                     |
+| OAUTH_ISSUER_URL    | URL     | (required)           | Required. Self-discovery URL for client                                   |
+| OAUTH_CLIENT_ID     | string  | (required)           | Required. Client ID                                                       |
+| OAUTH_CLIENT_SECRET | string  | (required)           | Required. Client Secret                                                   |
+| OAUTH_SCOPE         | string  | openid email profile | Full list of scopes to send with the request (space delimited)            |
+| OAUTH_AUTO_REGISTER | boolean | true                 | When true, will automatically register a user the first time they sign in |
+| OAUTH_BUTTON_TEXT   | string  | Login with OAuth     | Text for the OAuth button on the web                                      |
+
+```bash title="Authentik Example"
+OAUTH_ENABLED=true
+OAUTH_ISSUER_URL=http://10.1.15.216:9000/application/o/immich-test/
+OAUTH_CLIENT_ID=30596v8f78a4b6a97d5985c3076b6b4c4d12ddc33
+OAUTH_CLIENT_SECRET=50f1eafdec353b95b1c638db390db4ab67ef035a51212dbec2f56175e2eb272b5d572c099176e6fe116ecf47ffdd544bgdb9e2edc588307ee0339d25eeccd88
+OAUTH_BUTTON_TEXT=Login with Authentik
+```
+
+The web will have the option to sign in with OAuth.
+
+<img
+  src="https://user-images.githubusercontent.com/27055614/202923726-f43fa148-47f5-4182-8f29-b0b87e4586fa.png"
+  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",
+  }}
+/>
+
+The mobile app will check if the server has OAuth enabled before displaying the OAuth
+sign-in button.
+
+<img
+  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",
+  }}
+/>
+
+## Support
+
+<img
+  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",
+  }}
+  title="Support the project"
+/>
+
+If you find the project helpful and it helps you in some ways, you can support the project [one time](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502) or [monthly](https://github.com/sponsors/alextran1502) from GitHub Sponsor
+
+It is a great way to let me know that you want me to continue developing and working on this project for years to come.
+
+## Details
+
+For more details, please check out the [release note](https://github.com/immich-app/immich/releases/tag/v1.36.0_55-dev)

docs/docs/FAQ.md

@@ -0,0 +1,60 @@
+---
+sidebar_position: 7
+---
+
+# FAQ
+
+### What is the difference between the cloud icon on the mobile app?
+
+| Icon                               | Description                                                                                                                                     |
+| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| ![cloud](/img/cloud.svg)           | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload |
+| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up                                                                                  |
+| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device                      |
+
+### How can I sync an existing directory with Immich's server?
+
+Immich doesn't have the mechanism to sync an existing directory with the server. There is however, a helper CLI tool to help you bulk upload the existing photos and videos to the server. You can find the guide to use the CLI tool [here](/docs/features/bulk-upload.md).
+
+### Why doesn't Immich watch an existing photo gallery directory?
+
+The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well.
+
+### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
+
+Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
+
+### Why is object detection not very good?
+
+The model we used for machine learning is a prebuilt model, so the accuracy is not very good. It will hopefully be replaced with a better solution in the future.
+
+### How can I see Immich logs?
+
+Most Immich components are typically deployed using docker. To see logs for deployed docker containers, you can use the [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli/), specifically the `docker logs` command. For examples, see [Docker Help](/docs/guides/docker-help.md)
+
+### How can I run Immich as a non-root user?
+
+1. Set the `PUID`/`PGID` environment variables (in `.env`).
+2. Set the corresponding `user` argument in `docker-compose` for each service.
+3. Add an additional volume to `immich-microservices` that mounts internally to `/usr/src/app/.reverse-geocoding-dump`.
+
+The non-root user/group needs read/write access to the volume mounts, including `UPLOAD_LOCATION`.
+
+### How can I reset the admin password?
+
+The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.
+
+### How can I **purge** data from Immich?
+
+Data for Immich comes in two forms:
+
+1. **Metadata** stored in a postgres database, persisted via the `pg_data` volume
+2. **Files** (originals, thumbs, profile, etc.), stored in the `UPLOAD_LOCATION` folder.
+
+To remove the **Metadata** you can stop Immich and delete the volume.
+
+```bash title="Remove Immich (containers and volumes)"
+docker-compose down -v
+```
+
+After removing the the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting an unwanted files or folders.

docs/docs/administration/_category_.json

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

docs/docs/administration/jobs.md

@@ -0,0 +1,23 @@
+# Jobs
+
+Several Immich functionalities are implemented as jobs, which run in the background. To view the status of a job navigate to the Administration Screen, and then the `Jobs` page.
+
+
+## Generate Thumbnails
+
+![Generate Thumbnails](./img/admin-jobs-thumbnails.png)
+
+
+## Extract Exif
+
+![Extract Exif](./img/admin-jobs-exif.png)
+
+## Detect Objects
+
+![Detect Objects](./img/admin-jobs-objects.png)
+
+## Storage Migration
+
+This job can be run after changing the [Storage Template](/docs/administration/storage-template.mdx), in order to apply the change to the existing library.
+
+![Storage Migration](./img/admin-jobs-template.png)

docs/docs/administration/oauth.md

@@ -0,0 +1,107 @@
+# OAuth Authentication
+
+This page contains details about using OAuth in Immich.
+
+:::tip
+Unable to set `app.immich:/` as a valid redirect URI? See [Mobile Redirect URI](#mobile-redirect-uri) for an alternative solution.
+:::
+
+## Overview
+
+Immich supports 3rd party authentication via [OpenID Connect][oidc] (OIDC), an identity layer built on top of OAuth2. OIDC is supported by most identity providers, including:
+
+- [Authentik](https://goauthentik.io/integrations/sources/oauth/#openid-connect)
+- [Authelia](https://www.authelia.com/configuration/identity-providers/open-id-connect/)
+- [Okta](https://www.okta.com/openid-connect/)
+- [Google](https://developers.google.com/identity/openid-connect/openid-connect)
+
+## Prerequisites
+
+Before enabling OAuth in Immich, a new client application needs to be configured in the 3rd-party authentication server. While the specifics of this setup vary from provider to provider, the general approach should be the same.
+
+1. Create a new (Client) Application
+
+   1. The **Provider** type should be `OpenID Connect` or `OAuth2`
+   2. The **Client type** should be `Confidential`
+   3. The **Application** type should be `Web`
+   4. The **Grant** type should be `Authorization Code`
+
+2. Configure Redirect URIs/Origins
+
+   The **Sign-in redirect URIs** should include:
+
+   - `app.immich:/` - for logging in with OAuth from the [Mobile App](/docs/features/mobile-app.mdx)
+   - `http://DOMAIN:PORT/auth/login` - for logging in with OAuth from the Web Client
+   - `http://DOMAIN:PORT/user-settings` - for manually linking OAuth in the Web Client
+
+   Redirect URIs should contain all the domains you will be using to access Immich. Some examples include:
+
+   Mobile
+
+   - `app.immich:/` (You **MUST** include this for iOS and Android mobile apps to work properly)
+
+   Localhost
+
+   - `http://localhost:2283/auth/login`
+   - `http://localhost:2283/user-settings`
+
+   Local IP
+
+   - `http://192.168.0.200:2283/auth/login`
+   - `http://192.168.0.200:2283/user-settings`
+
+   Hostname
+
+   - `https://immich.example.com/auth/login`)
+   - `https://immich.example.com/user-settings`)
+
+## Enable OAuth
+
+Once you have a new OAuth client application configured, Immich can be configured using the Administration Settings page, available on the web (Administration -> Settings).
+
+| Setting                                              | Type    | Default              | Description                                                                         |
+| ---------------------------------------------------- | ------- | -------------------- | ----------------------------------------------------------------------------------- |
+| Enabled                                              | boolean | false                | Enable/disable OAuth                                                                |
+| Issuer URL                                           | URL     | (required)           | Required. Self-discovery URL for client (from previous step)                        |
+| Client ID                                            | string  | (required)           | Required. Client ID (from previous step)                                            |
+| Client Secret                                        | string  | (required)           | Required. Client Secret (previous step)                                             |
+| Scope                                                | string  | openid email profile | Full list of scopes to send with the request (space delimited)                      |
+| Button Text                                          | string  | Login with OAuth     | Text for the OAuth button on the web                                                |
+| Auto Register                                        | boolean | true                 | When true, will automatically register a user the first time they sign in           |
+| [Auto Launch](#auto-launch)                          | boolean | false                | When true, will skip the login page and automatically start the OAuth login process |
+| [Mobile Redirect URI Override](#mobile-redirect-uri) | URL     | (empty)              | Http(s) alternative mobile redirect URI                                             |
+
+:::info
+The Issuer URL should look something like the following, and return a valid json document.
+
+- `https://accounts.google.com/.well-known/openid-configuration`
+- `http://localhost:9000/application/o/immich/.well-known/openid-configuration`
+
+The `.well-known/openid-configuration` part of the url is optional and will be automatically added during discovery.
+:::
+
+## Auto Launch
+
+When Auto Launch is enabled, the login page will automatically redirect the user to the OAuth authorization url, to login with OAuth. To access the login screen again, use the browser's back button, or navigate directly to `/auth/login?autoLaunch=0`.
+
+## Mobile Redirect URI
+
+The redirect URI for the mobile app is `app.immich:/`, which is a [Custom Scheme](https://developer.apple.com/documentation/xcode/defining-a-custom-url-scheme-for-your-app). If this custom scheme is an invalid redirect URI for your OAuth Provider, you can work around this by doing the following:
+
+1. Configure an http(s) endpoint to forwards requests to `app.immich:/`
+2. Whitelist the new endpoint as a valid redirect URI with your provider.
+3. Specify the new endpoint as the `Mobile Redirect URI Override`, in the OAuth settings.
+
+With these steps in place, you should be able to use OAuth from the [Mobile App](/docs/features/mobile-app.mdx) without a custom scheme redirect URI.
+
+:::info
+Immich has a route (`/api/oauth/mobile-redirect`) that is already configured to forward requests to `app.immich:/`, and can be used for step 1.
+:::
+
+## Example Configuration
+
+Here's an example of OAuth configured for Authentik:
+
+![OAuth Settings](./img/oauth-settings.png)
+
+[oidc]: https://openid.net/connect/

docs/docs/administration/password-login.md

@@ -0,0 +1,32 @@
+# Password Login
+
+An overview of password login and related settings for Immich.
+
+## Enable/Disable
+
+Immich supports password login, which is enabled by default. The preferred way to disable it is via the [Administration Page](#administration-page), although it can also be changed via a [Server Command](#server-command) as well.
+
+### Administration Page
+
+To toggle the password login setting via the web, navigate to the "Administration", expand "Password Authentication", toggle the "Enabled" switch, and press "Save".
+
+![Password Login Settings](./img/password-login-settings.png)
+
+### Server Command
+
+There are two [Server Commands](/docs/administration/server-commands.md) for password login:
+
+1. `enable-password-login`
+2. `disable-password-login`
+
+See [Server Commands](/docs/administration/server-commands.md) for more details about how to run them.
+
+## Password Reset
+
+### Admin
+
+To reset the administrator password, use the `reset-admin-password` [Server Command](/docs/administration/server-commands.md).
+
+### User
+
+Immich does not currently support self-service password reset. However, the administration can reset passwords for other users. See [User Management: Password Reset](/docs/administration/user-management.mdx#password-reset) for more information about how to do this.

docs/docs/administration/server-commands.md

@@ -0,0 +1,33 @@
+# Server Commands
+
+The `immich-server` docker image comes preinstalled with an administrative CLI (`immich`) that supports the following commands:
+
+| Command                  | Description                           |
+| ------------------------ | ------------------------------------- |
+| `help`                   | Display help                          |
+| `reset-admin-password`   | Reset the password for the admin user |
+| `disable-password-login` | Disable password login                |
+| `enable-password-login`  | Enable password login                 |
+| `list-users`             | List Immich users                     |
+
+## How to run a command
+
+To run a command, [connect](/docs/guides/docker-help.md#attach-to-a-container) to the `immich_server` container and then execute the command via `immich <command>`.
+
+## Examples
+
+Reset Admin Password
+
+![Reset Admin Password](./img/reset-admin-password.png)
+
+Disable Password Login
+
+![Disable Password Login](./img/disable-password-login.png)
+
+Enabled Password Login
+
+![Enable Password Login](./img/enable-password-login.png)
+
+List Users
+
+![List Users](./img/list-users.png)

docs/docs/administration/storage-template.mdx

@@ -0,0 +1,5 @@
+import StorageTemplate from '../partials/_storage-template.md';
+
+# Storage Template
+
+<StorageTemplate />

docs/docs/administration/user-management.mdx

@@ -0,0 +1,24 @@
+import RegisterAdminUser from '../partials/_register-admin.md';
+import UserCreate from '../partials/_user-create.md';
+
+# User Management
+
+Immich supports multiple users, each with their own library.
+
+## Register the Admin User
+
+<RegisterAdminUser />
+
+## Create a New User
+
+<UserCreate />
+
+## Delete a User
+
+If you need to remove a user from Immich, head to "Administration", where users can be scheduled for deletion. The user account will immediately become disabled and their library and all associated data will be removed after 7 days.
+
+## Password Reset
+
+To reset a user's password, click the pencil icon to edit a user, then click "Reset Password". The user's password will be reset to "password" and they have to change it next time the sign in.
+
+![Reset Password](./img/user-management-update.png)

docs/docs/developer/_category_.json

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

docs/docs/developer/architecture.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 1
+---
+
+# Architecture
+
+## High Level Diagram
+
+![Immich Architecture](./img/app-architecture.png)
+
+## Technology
+
+Immich is a full-stack [TypeScript](https://www.typescriptlang.org/) application, with a [Flutter](https://flutter.dev/) mobile app.
+
+### Mobile
+
+- [Flutter](https://flutter.dev/)
+- [Riverpod](https://riverpod.dev/) for state management.
+
+### Web
+
+- [SvelteKit](https://kit.svelte.dev/)
+- [tailwindcss](https://tailwindcss.com/)
+
+### Server
+
+- [Node.js](https://nodejs.org/)
+- [Nest.js](https://nestjs.com/)
+- [TypeORM](https://typeorm.io/) for database management.
+- [Jest](https://jestjs.io/) for testing.
+
+### Database
+
+- [PostgreSQL](https://www.postgresql.org/)
+- [Redis](https://redis.io/) for job queuing.
+
+### Web Server
+
+- [NGINX](https://www.nginx.com/) for internal communication between containers and load balancing when scaling.

docs/docs/developer/contributing.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 3
+---
+
+# Contributing
+
+Contributions are welcome!
+
+## PR Checklist
+
+When contributing code through a pull request, please check the following:
+
+### Web Checks
+
+- [ ] `npm run lint` (linting via ESLint)
+- [ ] `npm run format` (formatting via Prettier)
+- [ ] `npm run check` (Type checking via SvelteKit)
+- [ ] `npm test` (Tests via Jest)
+
+:::tip
+Run all web checks with `npm run check:all`
+:::
+
+### Server Checks
+
+- [ ] `npm run lint` (linting via ESLint)
+- [ ] `npm run format` (formatting via Prettier)
+- [ ] `npm run check` (Type checking via `tsc`)
+- [ ] `npm test` (Tests via Jest)
+
+:::tip
+Run all server checks with `npm run check:all`
+:::
+
+### Open API
+
+The Open API client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file.
+
+- [ ] `npm run api:generate`
+
+:::tip
+This can also be run via `make api` from the project root directory (not in the `server` folder)
+:::

docs/docs/developer/open-api.md

@@ -0,0 +1,7 @@
+---
+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).

docs/docs/developer/setup.md

@@ -0,0 +1,106 @@
+---
+sidebar_position: 2
+---
+
+# Setup
+
+## Environment
+
+### Server and web app
+
+This environment includes the following services:
+
+- Core server - `/server/apps/immich`
+- Machine learning - `/machine-learning`
+- Microservices - `/server/apps/microservicess`
+- Web app - `/web`
+- Redis
+- PostgreSQL development database with exposed port `5432` so you can use any database client to acess it
+- NGINX Proxy - `nginx/nginx.conf`
+
+All the services are packaged to run as with single Docker Compose command.
+
+### Instructions
+
+1. Clone the project repo.
+2. Run `cp docker/example.env docker/.env`.
+3. Edit `docker/.env` to provide values for the required variable `UPLOAD_LOCATION`.
+4. From the root directory, run:
+
+```bash title="Start development server"
+make dev # required Makefile installed on the system.
+```
+
+5. Access the dev instance in your browser at http://localhost:2283, or connect via the mobile app.
+
+All the services will be started with hot-reloading enabled for a quick feedback loop.
+
+You can access the web from `http://your-machine-ip:2283` or `http://localhost:2283` and access the server from the mobile app at `http://your-machine-ip:2283/api`
+
+### Mobile app
+
+The mobile app `(/mobile)` will required Flutter toolchain to be installed on your system.
+
+Please refer to the [Flutter's official documentation](https://flutter.dev/docs/get-started/install) for more information on setting up the toolchain on your machine.
+
+## IDE 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 `Flutter`, `Prettier`, `ESLint` and `Svelte` extensions.
+
+in User `settings.json` (`cmd + shift + p` and search for `Open User Settings JSON`) add the following:
+
+```json title="settings.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"],
+  "[dart]": {
+    "editor.formatOnSave": true,
+    "editor.selectionHighlight": false,
+    "editor.suggest.snippetsPreventQuickSuggestions": false,
+    "editor.suggestSelection": "first",
+    "editor.tabCompletion": "onlySnippets",
+    "editor.wordBasedSuggestions": false,
+    "editor.defaultFormatter": "Dart-Code.dart-code"
+  }
+}
+```
+
+## 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/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Features",
+  "position": 3
+}

docs/docs/features/automatic-backup.md

@@ -0,0 +1,36 @@
+# Automatic Backup
+
+A guide on how the foreground and background automatic backup works.
+
+<img src={require('./img/background-foreground-backup.png').default} width="50%" title="Foreground&Background Backup" />
+
+On iOS, there is only one option for automatic backup
+
+- [Automatic Backup](#automatic-backup)
+  - [Foreground backup](#foreground-backup)
+
+On Android, there are two options for automatic backup
+
+- [Automatic Backup](#automatic-backup)
+  - [Foreground backup](#foreground-backup)
+  - [Background backup](#background-backup)
+
+## Foreground backup
+
+If foreground backup is enabled: whenever the app is opened or resumed, it will check if any photos or videos in the selected album(s) have yet to be uploaded to the cloud (the remainder count). If there are any, they will be uploaded.
+
+## Background backup
+
+Background backup is only available on Android thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy).
+
+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.
+
+A native Android notification shows up when the background upload is in progress. You can further customize the notification by going to the app's settings.
+
+:::info Note
+
+- The app must be in the background for the backup worker to start running.
+- 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.
+- 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.
+
+:::

docs/docs/features/bulk-upload.md

@@ -0,0 +1,96 @@
+# Bulk Upload (Using the CLI)
+
+You can use the CLI to upload an existing gallery to the Immich server
+
+[Immich CLI Repository](https://github.com/immich-app/CLI)
+
+## Requirements
+
+- Node.js 16 or above
+- Npm
+
+## Installation
+
+```bash
+npm i -g immich
+```
+
+## Quick Start
+
+Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from.
+
+```bash
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
+```
+
+---
+
+### Parameters
+
+| Parameter        | Description                                                         |
+| ---------------- | ------------------------------------------------------------------- |
+| --yes / -y       | Assume yes on all interactive prompts                               |
+| --delete / -da   | Delete local assets after upload                                    |
+| --key / -k       | User's API key                                                      |
+| --server / -s    | Immich's server address                                             |
+| --directory / -d | Directory to upload from                                            |
+| --threads / -t   | Number of threads to use (Default 5)                                |
+| --album/ -al     | Create albums for assets based on the parent folder or a given name |
+
+### Obtain the API Key
+
+The API key can be obtained in the user setting panel on the web interface.
+
+![Obtain Api Key](./img/obtain-api-key.png)
+
+
+### Run via Docker
+
+You can run the CLI inside of a docker container to avoid needing to install anything.
+
+:::caution Running inside Docker
+Be aware that as this runs inside a container, you need to mount the folder from which you want to import into the container.
+:::
+
+```bash title="Upload current directory"
+cd /DIRECTORY/WITH/IMAGES
+docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+```bash title="Upload target directory"
+docker run -it --rm -v /DIRECTORY/WITH/IMAGES:/import ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+```bash title="Create an alias"
+alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest"
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
+```
+
+:::tip Internal networking
+If you are running the CLI container on the same machine as your Immich server, you may not be able to reach the external address. In that case, try the following steps:
+1. Find the internal Docker network used by Immich via `docker network ls`.
+2. Adapt the above command to pass the `--network <immich_network>` argument to `docker run`, substituting `<immich_network>` with the result from step 1.
+3. Use `--server http://immich-server:3001/` for the upload command instead of the external address.
+
+```bash title="Upload to internal address"
+docker run --network immich_default -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://immich-server:3001/
+```
+:::
+
+### Run from source
+
+```bash title="Clone Repository"
+git clone https://github.com/immich-app/CLI
+```
+
+```bash title="Install dependencies"
+npm install
+```
+
+```bash title="Build the project"
+npm run build
+```
+
+```bash title="Run the command"
+node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
+```

docs/docs/features/mobile-app.mdx

@@ -0,0 +1,33 @@
+import MobileAppDownload from '../partials/_mobile-app-download.md';
+import MobileAppLogin from '../partials/_mobile-app-login.md';
+import MobileAppBackup from '../partials/_mobile-app-login.md';
+
+# Mobile App
+
+:::tip
+To upload from other devices, try using the [Bulk Upload CLI](/docs/features/bulk-upload.md).
+:::
+
+## Download
+
+<MobileAppDownload />
+
+:::info Beta Program
+The beta release channel allows users to test upcoming changes before they are officially released. To join the channel use the links below.
+
+- Android: Invitation link from [web](https://play.google.com/store/apps/details?id=app.alextran.immich) or from [mobile](https://play.google.com/store/apps/details?id=app.alextran.immich)
+- iOS: [TestFlight invitation link](https://testflight.apple.com/join/1vYsAa8P)
+
+:::
+
+## Login
+
+<MobileAppLogin />
+
+## Backup
+
+<MobileAppBackup />
+
+:::info
+You can enable automatic backup on supported devices. For more information see [Automatic Backup](/docs/features/automatic-backup.md).
+:::

docs/docs/features/reverse-geocoding.md

@@ -0,0 +1,14 @@
+# Reverse Geocoding
+
+Immich supports [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_geocoding) using data from the [GeoNames](https://www.geonames.org/) geographical database.
+
+## Extraction
+
+During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country. 
+
+## Usage
+
+Data from a reverse geocode is displayed in the image details, and used in [Search](/docs/features/search.md).
+
+<img src={require('./img/reverse-geocoding-mobile1.png').default} width='33%' title='Reverse Geocoding' />
+<img src={require('./img/reverse-geocoding-mobile2.png').default} width='33%' title='Reverse Geocoding' />

docs/docs/features/search.md

@@ -0,0 +1,16 @@
+# Search
+
+:::warning Work In Progress
+Search is work-in-progress and subject to change. Stay tuned!
+:::
+
+## Search by Place
+
+:::info
+Searching is currently only implemented in the [Mobile App](/docs/features/mobile-app.mdx)
+:::
+
+Searching by the name of a city, state, or country is possible for assets with geolocation data and successful [Reverse Geocoding](/docs/features/reverse-geocoding.md).
+
+<img src={require('./img/reverse-geocoding-mobile1.png').default} width='33%' title='Reverse Geocoding' />
+<img src={require('./img/reverse-geocoding-mobile2.png').default} width='33%' title='Reverse Geocoding' />

docs/docs/features/user-settings.md

@@ -0,0 +1,23 @@
+# User Settings
+
+![User Modal](./img/user-popup.png)
+
+## User Profile
+
+View your User ID and email, and update your first and last name.
+
+![User Profile](./img/user-profile.png)
+
+## Change Password
+
+Users can change their own passwords. 
+
+![Change Password](./img/user-change-password.png)
+
+:::tip Reset Password
+The admin can reset a password through the [User Management](/docs/administration/user-management.mdx) screen.
+:::
+
+:::tip Reset Admin Password
+The admin password can be reset using a [Server Command](/docs/administration/server-commands.md)
+:::

docs/docs/guides/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Guides",
+  "position": 6
+}

docs/docs/guides/docker-help.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 1
+---
+
+# Docker Help
+
+## Containers
+
+```bash
+docker ps                         # see a list of running containers
+docker ps -a                      # see a list of running and stopped containers
+```
+
+## Attach to a Container
+
+```bash
+docker exec -it <id or name> <command>          # attach to a container with a command
+docker exec -it immich_server sh
+docker exec -it immich_microservices sh
+docker exec -it immich_machine_learning sh
+docker exec -it immich_web sh
+docker exec -it immich_proxy sh
+```
+
+## Logs
+
+```bash
+docker logs <id or name>          # see the logs for a specific container (by id or name)
+
+docker logs immich_server
+docker logs immich_microservices
+docker logs immich_machine_learning
+docker logs immich_web
+docker logs immich_proxy
+```
+
+:::tip Follow a log
+Adding `--follow` to a `docker logs <id or name>` command will stream new logs, instead of immediately exiting, which is often useful for debugging.
+:::

docs/docs/install/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Install",
+  "position": 2
+}

docs/docs/install/all-in-one.md

@@ -0,0 +1,21 @@
+---
+sidebar_position: 70
+---
+
+# All-In-One [Community]
+
+:::note
+This is a community contribution and not officially supported by the Immich team, but included here for convenience.
+
+**Please report issues to the corresponding [Github Repository][github].**
+:::
+
+## Installation
+
+For installation instructions, refer to the [Github Repository][github].
+
+## Issues
+
+For issues, open an issue on the associated [GitHub Repository][github].
+
+[github]: https://github.com/imagegenius/docker-immich/

docs/docs/install/docker-compose.md

@@ -0,0 +1,121 @@
+---
+sidebar_position: 30
+---
+
+# Docker Compose [Recommended]
+
+Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose.
+
+### Step 1 - Download the required files
+
+Download [`docker-compose.yml`][compose-file] [`example.env`][env-file].
+
+From a directory of your choice (e.g. `./immich-app`) run the following commands:
+
+```bash title="Get docker-compose.yml file"
+wget https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
+```
+
+```bash title="Get .env file"
+wget -O .env https://github.com/immich-app/immich/releases/latest/download/example.env
+```
+
+### Step 2 - Populate the .env file with custom values
+
+<details>
+
+<summary>Example <code>.env</code> content</summary>
+
+```bash
+###################################################################################
+# Database
+###################################################################################
+
+DB_HOSTNAME=immich_postgres
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+DB_DATABASE_NAME=immich
+
+# Optional Database settings:
+# DB_PORT=5432
+
+###################################################################################
+# Redis
+###################################################################################
+
+REDIS_HOSTNAME=immich_redis
+
+# Optional Redis settings:
+# REDIS_PORT=6379
+# REDIS_DBINDEX=0
+# REDIS_PASSWORD=
+# REDIS_SOCKET=
+
+###################################################################################
+# Upload File Config
+###################################################################################
+
+UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup
+
+###################################################################################
+# Log message level - [simple|verbose]
+###################################################################################
+
+LOG_LEVEL=simple
+
+###################################################################################
+# Reverse Geocoding
+####################################################################################
+
+# DISABLE_REVERSE_GEOCODING=false
+
+# Reverse geocoding is done locally which has a small impact on memory usage
+# This memory usage can be altered by changing the REVERSE_GEOCODING_PRECISION variable
+# This ranges from 0-3 with 3 being the most precise
+# 3 - Cities > 500 population: ~200MB RAM
+# 2 - Cities > 1000 population: ~150MB RAM
+# 1 - Cities > 5000 population: ~80MB RAM
+# 0 - Cities > 15000 population: ~40MB RAM
+
+# REVERSE_GEOCODING_PRECISION=3
+
+####################################################################################
+# WEB - Optional
+####################################################################################
+
+# Custom message on the login page, should be written in HTML form.
+# For example PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
+
+PUBLIC_LOGIN_PAGE_MESSAGE="My Family Photos and Videos Backup Server"
+```
+
+</details>
+
+- Populate custom database information if necessary.
+- Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
+
+### Step 3 - Start the containers
+
+```bash title="Start the containers using docker compose command"
+docker-compose up -d # or `docker compose up -d` based on your docker-compose version
+```
+
+:::tip
+For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.mdx) guide.
+:::
+
+### Step 4 - Upgrading
+
+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"
+docker-compose pull && docker-compose up -d # Or `docker compose`
+```
+
+:::caution Automatic Updates
+Immich is currently under heavy development, which means you can expect breaking changes and bugs. Therefore, we recommend reading the release notes prior to updating and to take special care when using automated tools like [Watchtower][watchtower].
+:::
+
+[compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
+[env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env
+[watchtower]: https://containrrr.dev/watchtower/

docs/docs/install/kubernetes.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 40
+---
+
+# Kubernetes
+
+You can deploy Immich on Kubernetes using [the official Helm chart](https://github.com/immich-app/immich-charts/tree/main/charts/apps/immich). 
+
+If you want examples of how other people run Immich on Kubernetes, using the official chart or otherwise, you can find them at https://nanne.dev/k8s-at-home-search/#/immich.
+
+:::caution DNS in Alpine containers
+Immich makes use of Alpine container images. These can encounter [a DNS resolution bug](https://stackoverflow.com/a/65593511) on Kubernetes clusters if the host 
+nodes have a search domain set, like:
+
+```
+$ cat /etc/resolv.conf
+search home.lan
+nameserver 192.168.1.1
+```
+
+When you encounter this bug, it will cause the immich-microservices to crash on startup because it cannot download 
+the geocoder data. This can be solved in one of two ways: Either reconfigure your nodes to remove the searchdomain from 
+`resolv.conf`, or set the `DISABLE_REVERSE_GEOCODING` environment variable for Immich to `true` to disable the geocoder.
+:::

docs/docs/install/portainer.md

@@ -0,0 +1,49 @@
+---
+sidebar_position: 50
+---
+
+# Portainer
+
+Install Immich using Portainer's Stack feature.
+
+1. Go to "**Stacks**" in the left sidebar.
+2. Click on "**Add stack**".
+3. Give the stack a name (i.e. Immich), and select "**Web Editor**" as the build method.
+4. Copy the content of the `docker-compose.yml` file from the [GitHub repository](https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml).
+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"
+/>
+
+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"
+/>
+
+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"
+/>
+
+* 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/post-install.mdx

@@ -0,0 +1,38 @@
+---
+sidebar_position: 100
+---
+
+import RegisterAdminUser from '../partials/_register-admin.md';
+import UserCreate from '../partials/_user-create.md';
+import StorageTemplate from '../partials/_storage-template.md';
+import MobileAppDownload from '../partials/_mobile-app-download.md';
+import MobileAppLogin from '../partials/_mobile-app-login.md';
+import MobileAppBackup from '../partials/_mobile-app-backup.md';
+
+# Post Install Steps
+
+A list of common steps to take after installing Immich include:
+
+## Step 1 - Register the Admin User
+
+<RegisterAdminUser />
+
+## Step 2 - Create a New User (optional)
+
+<UserCreate />
+
+## Step 3 - Update the Storage Template
+
+<StorageTemplate />
+
+## Step 4 - Download the Mobile App
+
+<MobileAppDownload />
+
+## Step 5 - Login to the Mobile App
+
+<MobileAppLogin />
+
+## Step 6 - Backup Your Library
+
+<MobileAppBackup />

docs/docs/install/requirements.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 10
+---
+
+
+# Requirements
+Hardware and software requirements for Immich
+
+## Software
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+:::info Podman
+You can also use Podman to run the application. However, additional configuration might be required.
+:::
+
+## 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.
+- **CPU**: At least 2 cores, preferred 4 cores.
+
+:::info Machine Learning on older CPU
+
+The TensorFlow version used by Immich doesn't run on older CPU architectures. It requires a CPU with AVX and AVX2 instruction sets. If you encounter the error `illegal instruction core dump` check your CPU flags with the command below and make sure you see `avx` and `avx2`:
+
+```bash
+grep -E 'avx2?' /proc/cpuinfo
+```
+
+#### Promox
+
+If you are running virtualization in Proxmox, the CPU type of the VM is probably configured incorrectly.
+
+You need to change the CPU type from `kvm64` to `host` under VMs hardware tab.
+
+`Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host`
+
+#### Other platforms
+
+You can use the machine learning image that is built for Non-AVX CPU. The image is community maintained and can be found in the repository below
+
+https://github.com/bertmelis/immich-machine-learning-no-avx
+
+Otherwise, you can safely remove the `immich-machine-learning` service if you do not intend to use Immich's object detection features. Simply remove or comment out the declaration of the service in your compose file.
+:::