Up version of openapi

* chore: initial template

* feat: exlude null values

* chore: regenerate openapi

* chore: merge

* feat: store changes in a patch file

* feat: extract to sh script

* chore: regenerate openapi

* chore: remove duplicate file

* feat: generate mobile by itself

* Fixed number property not decorated correctly

* Revert hotfix, fix test

* Merge main

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>

.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

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

@@ -17,6 +17,9 @@
 <img src="design/immich-screenshots.png" title="Main Screenshot">
 </a>
 <br/>
+<p align="center">
+  <a href="README_zh_CN.md">中文</a>
+</p>
 
 ## Disclaimer
 
@@ -26,12 +29,13 @@
 
 ## Content
 
-- [Official Documentation](https://immich.app/docs/overview/introduction)
+- [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/installation/requirements)
-- [Contribution Guidelines](https://immich.app/docs/contribution-guidelines)
+- [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)
 
@@ -64,17 +68,17 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | 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 |
+| 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 |
-| LivePhotos Backup and Playback (iOS only)   | Yes     | Yes |
+| OAuth support                               | Yes     | Yes |
+| LivePhoto backup and playback               | iOS     | Yes |
+| User-defined storage structure              | Yes     | Yes |
 
 # Support the project
 
@@ -91,18 +95,8 @@ If you feel like this is the right cause and the app is something you are seeing
 
 # 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.example

@@ -30,12 +30,6 @@ REDIS_HOSTNAME=immich_redis
 
 UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup
 
-###################################################################################
-# Log message level - [simple|verbose]
-###################################################################################
-
-LOG_LEVEL=simple
-
 ###################################################################################
 # JWT SECRET
 #
@@ -79,21 +73,6 @@ PUBLIC_LOGIN_PAGE_MESSAGE=
 # 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
-
-####################################################################################
-# OAuth Setting - Optional
-#
-# These setting will enable OAuth login for your instance of Immich
-# Folow the instructions in the page https://immich.app/docs/usage/oauth to set up your OAuth provider
-####################################################################################
-
-# OAUTH_ENABLED=false
-# OAUTH_ISSUER_URL=
-# OAUTH_CLIENT_ID=
-# OAUTH_CLIENT_SECRET=
-# OAUTH_BUTTON_TEXT=Login with OAuth
-# OAUTH_AUTO_REGISTER=true
-# OAUTH_SCOPE="openid profile email"
+IMMICH_WEB_URL=http://immich-web:3000
+IMMICH_SERVER_URL=http://immich-server:3001
+IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3003

docker/docker-compose.dev.yml

@@ -2,6 +2,7 @@ version: '3.8'
 
 services:
   immich-server:
+    container_name: immich_server
     image: immich-server-dev:latest
     build:
       context: ../server
@@ -23,6 +24,7 @@ services:
       - database
 
   immich-machine-learning:
+    container_name: immich_machine_learning
     image: immich-machine-learning-dev:latest
     build:
       context: ../machine-learning
@@ -41,6 +43,7 @@ services:
       - database
 
   immich-microservices:
+    container_name: immich_microservices
     image: immich-microservices:latest
     build:
       context: ../server
@@ -60,6 +63,7 @@ services:
       - immich-server
 
   immich-web:
+    container_name: immich_web
     image: immich-web-dev:1.9.0
     build:
       context: ../web

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,6 +46,7 @@ services:
     restart: always
 
   immich-web:
+    container_name: immich_web
     image: altran1502/immich-web:staging
     entrypoint: ["/bin/sh", "./entrypoint.sh"]
     env_file:

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:

docs/blog/2019-05-28-first-blog-post.md

@@ -1,12 +0,0 @@
----
-slug: first-blog-post
-title: First Blog Post
-authors:
-  name: Gao Wei
-  title: Docusaurus Core Team
-  url: https://github.com/wgao19
-  image_url: https://github.com/wgao19.png
-tags: [hola, docusaurus]
----
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

docs/blog/2019-05-29-long-blog-post.md

@@ -1,44 +0,0 @@
----
-slug: long-blog-post
-title: Long Blog Post
-authors: endi
-tags: [hello, docusaurus]
----
-
-This is the summary of a very long blog post,
-
-Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
-
-<!--truncate-->
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

docs/blog/2021-08-01-mdx-blog-post.mdx

@@ -1,20 +0,0 @@
----
-slug: mdx-blog-post
-title: MDX Blog Post
-authors: [slorber]
-tags: [docusaurus]
----
-
-Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
-
-:::tip
-
-Use the power of React to create interactive blog posts.
-
-```js
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-```
-
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-
-:::

docs/blog/2021-08-26-welcome/index.md

@@ -1,25 +0,0 @@
----
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
----
-
-[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
-
-Simply add Markdown files (or folders) to the `blog` directory.
-
-Regular blog authors can be added to `authors.yml`.
-
-The blog post date can be extracted from filenames, such as:
-
-- `2019-05-30-welcome.md`
-- `2019-05-30-welcome/index.md`
-
-A blog post folder can be convenient to co-locate blog post images:
-
-![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
-
-The blog supports tags as well!
-
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

docs/blog/authors.yml

@@ -1,17 +1,5 @@
-endi:
-  name: Endilie Yacop Sucipto
-  title: Maintainer of Docusaurus
-  url: https://github.com/endiliey
-  image_url: https://github.com/endiliey.png
-
-yangshun:
-  name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
-  image_url: https://github.com/yangshun.png
-
-slorber:
-  name: Sébastien Lorber
-  title: Docusaurus maintainer
-  url: https://sebastienlorber.com
-  image_url: https://github.com/slorber.png
+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

@@ -13,7 +13,48 @@ sidebar_position: 6
 | ![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/usage/bulk-upload.md).
+
+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. 
+
+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/features/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/features/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 will need 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/features/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/developer/_category_.json

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

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/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

@@ -1,10 +1,10 @@
 ---
-sidebar_position: 5
+sidebar_position: 2
 ---
 
-# Contribution guidelines
+# Setup
 
-## Environment setup
+## Environment
 
 ### Server and web app
 
@@ -88,6 +88,7 @@ OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generato
 ```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
@@ -95,9 +96,11 @@ You can find the generated client SDK in the `web/src/api` for Typescript SDK an
 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 
+2. Run
+
 ```bash
 npm run typeorm -- migration:generate ./libs/database/src/<migration-name> -d libs/database/src/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

@@ -1,20 +1,19 @@
----
-sidebar_position: 2
----
-
-
 # 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 
-  * [**Foreground backup**](#foreground-backup)
+On iOS, there is only one option for automatic backup
 
-On Android, there are two options for automatic backup 
-  * [**Foreground backup**](#foreground-backup) 
-  * [**Background backup**](#background-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
 
@@ -22,14 +21,16 @@ If foreground backup is enabled: whenever the app is opened or resumed, it will
 
 ## Background backup
 
-Background backup is only available on Android thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy). 
+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.
 
-:::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.
+:::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

@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
 # Bulk Upload (Using the CLI)
 
 You can use the CLI to upload an existing gallery to the Immich server

docs/docs/features/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/features/storage-template.mdx), in order to apply the change to the existing library.
+
+![Storage Migration](./img/admin-jobs-template.png)

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/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/features/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/features/server-commands.md) for password login:
+
+1. `enable-password-login`
+2. `disable-password-login`
+
+See [Server Commands](/docs/features/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/features/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/features/user-management.mdx#password-reset) for more information about how to do this.

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/server-commands.md

@@ -0,0 +1,39 @@
+# 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                 |
+
+## How to run a command
+
+To run a command, connect to the container and then execute it by running `immich <command>`.
+
+## Examples
+
+```bash title="Reset Admin Password"
+docker exec -it immich_server sh
+
+/usr/src/app$ immich reset-admin-password
+? Please choose a new password (optional) immich-is-awesome-unlike-this-password
+New password:
+immich-is-awesome-unlike-this-password
+```
+
+```bash title="Disable Password Login"
+docker exec -it immich_server sh
+
+/usr/src/app$ immich disable-password-login
+Password login has been disabled.
+```
+
+```bash title="Enable Password Login"
+docker exec -it immich_server sh
+
+/usr/src/app$ immich enable-password-login
+Password login has been enabled.
+```

docs/docs/features/storage-template.mdx

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

docs/docs/features/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/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/features/user-management.mdx) screen.
+:::
+
+:::tip Reset Admin Password
+The admin password can be reset using a [Server Command](/docs/features/server-commands.md)
+:::

docs/docs/guides/_category_.json

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

docs/docs/guides/docker-help.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 1
+---
+
+# Docker Help
+
+## Logs
+
+```bash title="Log Examples"
+docker ps                         # see a list of running containers
+docker ps -a                      # see a list of running and stopped containers
+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/docker-compose.md

@@ -2,14 +2,15 @@
 sidebar_position: 3
 ---
 
+# Docker Compose [Recommended]
 
-# Recommended installation
-
-This is the recommended installation method for production use.
+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
 
-From a directory of your choice (e.g. `./immich-app`) run the following commands
+Download [`docker-compose.yml`][compose-file] [`.env.example`][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://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml
@@ -99,9 +100,9 @@ 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.
-* Populate a secret value for `JWT_SECRET`. You can use the command below to generate a secure key:
+- Populate custom database information if necessary.
+- Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
+- Populate a secret value for `JWT_SECRET`. You can use the command below to generate a secure key:
 
 ```bash title="Command to generate secure JWT_SECRET key"
 openssl rand -base64 128
@@ -114,5 +115,16 @@ docker-compose up -d # or `docker compose up -d` based on your docker-compose ve
 ```
 
 :::tip
-For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
+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`
+```
+
+[compose-file]: https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml
+[env-file]: https://raw.githubusercontent.com/immich-app/immich/main/docker/.env.example

docs/docs/install/portainer.md

@@ -50,5 +50,5 @@ openssl rand -base64 128
 
 
 :::tip
-For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
+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: 1
+---
+
+
+# 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.
+:::

docs/docs/install/script.md

@@ -2,10 +2,10 @@
 sidebar_position: 2
 ---
 
-# One-step installation
+# Install Script [Experimental]
 
 :::caution
-This method is for evaluation purposes only. It is not recommended for production use. For production usage, please refer to the recommended installation method [here](/docs/installation/recommended-installation).
+This method is experimental and not currently recommended for production use. For production, please refer to installing with [Docker Compose](/docs/install/docker-compose.md).
 :::
 
 In the shell, from a directory of your choice, run the following command:
@@ -25,5 +25,5 @@ The web application will be available at `http://<machine-ip-address>:2283`, and
 The directory which is used to store the library files is `./immich-data` relative to the current directory.
 
 :::tip
-For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
+For common next steps, see [Post Install Steps](/docs/install/post-install.mdx).
 :::

docs/docs/install/unraid.md

@@ -0,0 +1,142 @@
+---
+sidebar_position: 5
+---
+
+# Unraid
+
+Immich can easily be installed and updated on Unraid using the [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin from the Unraid Community Apps.
+
+:::info
+
+- Guide was written using Unraid v6.11.1
+- Requires you to have installed the plugin: [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/)
+- An Unraid share created for your images
+- There has been a [report](https://forums.unraid.net/topic/130006-errortraps-traps-node27707-trap-invalid-opcode-ip14fcfc8d03c0-sp7fff32889dd8-more/#comment-1189395) of this not working if your Unraid server doesn't support AVX _(e.g. using a T610)_
+
+:::
+
+## Installation Steps
+
+1. Go to "**Plugins**" and click on "**Compose.Manager**"
+2. Click "**Add New Stack**" and when prompted for a label enter "**Immich**"
+
+<img
+src={require('./img/unraid01.webp').default}
+width="70%"
+alt="Select Plugins > Compose.Manager > Add New Stack > Label it Immich"
+/>
+
+3.  Select the cog ⚙️ next to Immich then click "**Edit Stack**"
+4.  Click "**Compose File**" and then paste the entire contents of the [Immich Docker Compose](https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml) file into the Unraid editor
+    <details >
+        <summary>Using an existing Postgres container? Click me! Otherwise proceed to step 5.</summary>
+        <ul>
+            <li>Comment out the database service</li>
+            <img
+                src={require('./img/unraid02.png').default}
+                width="50%"
+                alt="Comment out database service in the compose file"
+            />
+            <li>Comment out the database dependency for <b>each service</b> <i>(example in screenshot below only shows 2 of the services - ensure you do this for all services)</i></li>
+            <img
+                src={require('./img/unraid03.png').default}
+                width="50%"
+                alt="Comment out every reference to the database service in the compose file"
+            />
+            <li>Comment out the volumes</li>
+            <img
+                src={require('./img/unraid04.png').default}
+                width="20%"
+                alt="Comment out database volume"
+            />
+        </ul>
+    </details>
+5.  Click "**Save Changes**", you will be promoted to edit stack UI labels, just leave this blank and click "**Ok**"
+6.  Select the cog ⚙️ next to Immich, click "**Edit Stack**", then click "**Env File**"
+7.  Past the entire contents of the [Immich .env.example](https://raw.githubusercontent.com/immich-app/immich/main/docker/.env.example) file into the Unraid editor, then **before saving** edit the following:
+
+    - `JWT_SECRET`: Generate a unique secret and paste the value here > Can be generated by either typing `openssl rand -base64 128` in your terminal or copying from [uuidgenerator](https://www.uuidgenerator.net/version1)
+    - `UPLOAD_LOCATION`: Create a folder in your Images Unraid share and place the **absolute** location here > For example my _"images"_ share has a folder within it called _"immich"_. If I browse to this directory in the terminal and type `pwd` the output is `/mnt/user/images/immich`. This is the exact value I need to enter as my `UPLOAD_LOCATION`
+
+      <img
+      src={require('./img/unraid05.webp').default}
+      width="70%"
+      alt="Absolute location of where you want immich images stored"
+      />
+
+    <details >
+        <summary>Using an existing Postgres container? Click me! Otherwise proceed to step 8.</summary>
+        <p>Update the following database variables as relevant to your Postgres container:</p>
+        <ul>
+            <li><code>DB_HOSTNAME</code></li>
+            <li><code>DB_USERNAME</code></li>
+            <li><code>DB_PASSWORD</code></li>
+            <li><code>DB_DATABASE_NAME</code></li>
+            <li><code>DB_PORT</code></li>
+        </ul>
+    </details>
+
+8.  Click "**Save Changes**" followed by "**Compose Up**" and Unraid will begin to create the Immich containers in a popup window. Once complete you will see a message on the popup window stating _"Connection Closed"_. Click "**Done**" and go to the Unraid "**Docker**" page
+
+    > Note: This can take several minutes depending on your Internet speed and Unraid hardware
+
+9.  Once on the Docker page you will see several Immich containers, one of them will be labelled `immich_proxy` and will have a port mapping. Visit the `IP:PORT` displayed in your web browser and you should see the Immich admin setup page.
+
+<img
+src={require('./img/unraid06.webp').default}
+width="80%"
+alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+/>
+
+<details >
+    <summary>Using the Unraid Docker Folders plugin? Click me! Otherwise you're complete!</summary>
+    <p>If you are using the Docker Folders plugin go the Docker tab and select "<b>New Folder</b>".<br />Label it <i>"Immich"</i> and use the logo from the <a href="https://immich.app/">Immich homepage</a> <i>(right click the logo, "Save As", and reupload to Unraid)</i><br />Then simply select all the Immich related containers before clicking "<b>Submit</b>"</p>
+    <img
+        src={require('./img/unraid07.webp').default}
+        width="80%"
+        alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+    />
+    <img
+        src={require('./img/unraid08.webp').default}
+        width="90%"
+        alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+    />
+    
+</details>
+
+:::tip
+For more information on how to use the application once installed, please refer to the [Post Install](/docs/install/post-install.mdx) guide.
+:::
+
+## Updating Steps
+
+Updating is extremely easy however it's important to be aware that containers managed via the Docker Compose Manager plugin do not integrate with Unraid's native dockerman ui, the label "_update ready_" will always be present on containers installed via the Docker Compose Manager.
+
+<img
+src={require('./img/unraid09.png').default}
+width="50%"
+alt="Docker Compose containers always say update ready, ignore it"
+/>
+
+You should ignore the "_update ready_" on the Unraid WebUI and update when you receive the notification within the Immich WebUI.
+<img
+src={require('./img/unraid10.png').default}
+width="50%"
+alt="Immich update notification"
+/>
+
+1. Go to the "**Docker**" tab and scroll to the Compose section
+2. Next to Immich click the "**Update Stack**" button and Unraid will begin to update all Immmich related containers
+   > Note: **Do not** select Compose Down first, it is unecessary.
+3. Once complete you will see a "_Connection Closed_" message, select "**Done**".
+   <img
+   src={require('./img/unraid11.png').default}
+   width="50%"
+   alt="Wait for Connection Closed and click Done"
+   />
+4. Return back to the Immich WebUI and you will see the version has been updated to the latest
+   <img
+   src={require('./img/unraid12.png').default}
+   width="70%"
+   alt="Wait for Connection Closed and click Done"
+   />

docs/docs/installation/_category_.json

@@ -1,8 +0,0 @@
-{
-  "label": "Installation",
-  "position": 2,
-  "link": {
-    "type": "generated-index",
-    "description": "Installation methods of Immich"
-  }
-}

docs/docs/installation/requirements.md

@@ -1,31 +0,0 @@
----
-sidebar_position: 1
----
-
-
-# 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 on your end.
-:::
-
-## 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.
-
-## Installation methods
-
-There are a couple installation methods that you can use to install the application. You can choose the one that suits you the best.
-
-1. [One-step installation (Evaluation only)](/docs/installation/one-step-installation)
-2. **[Docker Compose with manual configuration (Recommended)](/docs/installation/recommended-installation)**
-3. [Portainer](/docs/installation/portainer-installation)
-4. [Unraid (Community contribution)](/docs/installation/unraid-installation)

docs/docs/installation/unraid-installation.md

@@ -1,15 +0,0 @@
----
-sidebar_position: 5
----
-
-# Unraid
-
-Install Immich on Unraid.
-
-:::info Community contribution
-Please follow [this community contributed article](https://mfaz.dev/posts/immich-unraid/) to install Immich on Unraid.
-:::
-
-:::tip
-For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
-:::

docs/docs/mobile-app-beta-program.md

@@ -1,12 +0,0 @@
----
-sidebar_position: 4
----
-
-
-# Mobile app Beta program
-
-Join the beta release channel to test the latest update of the app
-
-You can opt-in to join app beta release channel by following 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)

docs/docs/overview/_category_.json

@@ -1,8 +1,4 @@
 {
-  "label": "Getting Started",
-  "position": 1,
-  "link": {
-    "type": "generated-index",
-    "description": "Getting to know Immich"
-  }
+  "label": "Overview",
+  "position": 1
 }

docs/docs/overview/help.md

@@ -0,0 +1,16 @@
+---
+sidebar_position: 4
+---
+
+# Help Me!
+
+Running into an issue or have a question? Try the following:
+
+1. Check the [FAQs](/docs/FAQ.md).
+2. Read through the [Release Notes][github-releases].
+3. Search through existing [GitHub Issues][github-issues].
+4. Open a help ticket on [Discord][discord-link].
+
+[github-issues]: https://github.com/immich-app/immich/releases
+[github-releases]: https://github.com/immich-app/immich/releases
+[discord-link]: https://discord.com/invite/D8JsnBEuKb

docs/docs/overview/introduction.mdx

@@ -4,14 +4,12 @@ sidebar_position: 1
 
 # Introduction
 
+<img src={require('./img/feature-panel.png').default} alt='Immich' />
+
+## Welcome!
+
 Hello, I am glad you are here.
 
-<p style={{textAlign: 'center'}}>
-
-![Introduction Image](https://user-images.githubusercontent.com/27055614/182044984-2ee6d1ed-c4a7-4331-8a4b-64fcde77fe1f.png)
-
-</p>
-
 My name is Alex. I am an Electrical Engineer by schooling, then turned into a Software Engineer by trade and the pure love of problem solving.
 
 We were lying in bed with our newborn, and my wife said, "We are starting to accumulate a lot of photos and videos of our baby, and I don't want to pay for **_App-Which-Must-Not-Be-Named_** anymore. You always want to build something for me, so why don't you build me an app which can do that?"
@@ -22,4 +20,4 @@ Another motivation that pushed me to deliver my execution of the **_App-Which-Mu
 
 I'm proud to share this creation with you, which values privacy, memories, and the joy of looking back at those moments in an easy-to-use and friendly interface.
 
-If you like the application or it helps you in some way, please consider [supporting](./support-the-project.md) to the project. It will help me to continue to develop and maintain the application.
+If you like the application or it helps you in some way, please consider [supporting](./support-the-project.md) the project. It will help me to continue to develop and maintain the application.

docs/docs/overview/logo.md

@@ -2,11 +2,11 @@
 sidebar_position: 2
 ---
 
-# Logo meaning
+# Logo
 
 Why the colorful flower, you ask?
 
-I really like the Japanese culture, especially the books, history, and food. The current logo is a spin-off of [the Oda clan's symbol](https://en.wikipedia.org/wiki/Oda_clan). 
+I really like the Japanese culture, especially the books, history, and food. The current logo is a spin-off of [the Oda clan's symbol](https://en.wikipedia.org/wiki/Oda_clan).
 
 ![Oda_emblem](https://user-images.githubusercontent.com/27055614/182044504-a5ed33a8-5640-42de-b359-18fdbee9fb90.svg)
 

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

@@ -2,19 +2,26 @@
 sidebar_position: 3
 ---
 
-# Support the project
+# Support The Project
 
-I've committed to this project, and I will not stop. I will keep updating the docs, adding new features, and fixing bugs. But I can't do it alone, so I need your help to give me additional motivation to keep going.
+I am 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-which-must-not-be-named is a Hostile Actor'](https://selfhosted.show/79?t=1418) said, this is a massive undertaking that the team and I are doing. 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 see yourself using for a long time, please consider supporting the project with the options below.
+If you feel like this is the right cause and the app is something you see yourself using for a long time, please consider supporting the project with one of the options below.
 
 ## Donation
 
-* Monthly donation via [GitHub Sponsors](https://github.com/sponsors/alextran1502)
-* One-time donation via [Github Sponsors](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
+- Monthly donation via [GitHub Sponsors](https://github.com/sponsors/alextran1502)
+- One-time donation via [GitHub Sponsors](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502)
 
-## Contribution
+## Contributing
 
-If you are a programmer/developer and the app's [technology stack](./technology-stack.md) is something you are familiar with, please consider contributing to the project. The team and I are always looking for new contributors. You can refer to the [contribution guildelines](/docs/contribution-guidelines) to start leaving your mark on the project. 
+There are lots of non-monetary ways to contribute to Immich as well.
+
+1. Testing - Using Immich and reporting bugs is a great way to help support the project. Found a bug? [Open an issue on GitHub][github-issue].
+1. Translations - The Immich mobile app has been translated into [17 languages][github-langs] so far! To contribute with translations, email me at alex.tran1502@gmail.com or send me a message on discord.
+1. Development - If you are a programmer or developer, take a look at Immich's [technology stack](/docs/developer/architecture.md) and consider fixing bugs or building new features. The team and I are always looking for new contributors. For information about how to contribute as a developer, see the [Developer](/docs/developer/architecture.md) section.
+
+[github-issue]: https://github.com/immich-app/immich/issues/new/choose
+[github-langs]: https://github.com/immich-app/immich/tree/main/mobile/assets/i18n

docs/docs/overview/technology-stack.md

@@ -1,23 +0,0 @@
----
-sidebar_position: 4
----
-
-# Technology stack
-
-The app is built with the following technologies:
-
-## Frontend
-* [Flutter](https://flutter.dev/) for the mobile app
-  * [Riverpod](https://riverpod.dev/) as state management.
-* [SvelteKit](https://kit.svelte.dev/) for the Web.
-
-## Backend
-* [Nest.js](https://nestjs.com/) for the server.
-  * [TypeORM](https://typeorm.io/) for database management.
-* [PostgreSQL](https://www.postgresql.org/) for the database.
-* [Redis](https://redis.io/) for communication between the core server and the microservices.
-* [NGINX](https://www.nginx.com/) for internal communication between containers and load balancing when scaling.
-
-## High level architecture
-
-![Immich Architecture](./img/app-architecture.png)

docs/docs/partials/_mobile-app-backup.md

@@ -0,0 +1,9 @@
+Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.
+
+<img src={require('./img/backup-header.png').default} width='50%' title='Backup button' />
+
+You can select which album(s) you want to back up to the Immich server from the backup screen.
+
+<img src={require('./img/album-selection.png').default} width='50%' title='Backup button' />
+
+Scroll down to the bottom and press "**Start Backup**" to start the backup process.

docs/docs/partials/_mobile-app-download.md

@@ -0,0 +1,6 @@
+The mobile app can be downloaded from the following places:
+
+- [Google Play Store](https://play.google.com/store/apps/details?id=app.alextran.immich)
+- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
+- [F-Droid](https://f-droid.org/packages/app.alextran.immich)
+- [GitHub Releases (apk)](https://github.com/immich-app/immich/releases)

docs/docs/partials/_mobile-app-login.md

@@ -0,0 +1,3 @@
+Login to the mobile app with the server endpoint URL at `http://<machine-ip-address>:2283/api`
+
+<img src={require('./img/sign-in-phone.jpeg').default} width='50%' title='Mobile App Sign In' />

docs/docs/partials/_register-admin.md

@@ -0,0 +1,7 @@
+The first user to register will be the admin user. The admin user will be able to add other users to the application.
+
+To register for the admin user, access the web application at `http://<machine-ip-address>:2283` and click on the **Getting Started** button.
+
+<img src={require('./img/admin-registration-form.png').default} width="500" title="Admin Registration" />
+
+Follow the prompts to register as the admin user and log in to the application.

docs/docs/partials/_storage-template.md

@@ -0,0 +1,11 @@
+Immich allows the admin user to set the pattern of how the files are uploaded to the Immich would look like. Both in the directory and the filename level.
+
+The admin user can set the template by using the template builder in the `Administration -> Settings -> Storage Template`. Immich provides a set of variables that you can use in constructing the template, along with additional custom text.
+
+```bash title="Default template"
+Year/Year-Month-Day/Filename.Extension
+```
+
+<img src={require('./img/storage-template.png').default} width="100%" title="Storage Template Setting" />
+
+Immich also provides a mechanism to migrate between template so that if the template you set now doesn't work in the future, you can always migrate all the existing files to the new template. The mechanism is run as a job in the Job page.

docs/docs/partials/_user-create.md

@@ -0,0 +1,3 @@
+If you have friends or family members who want to use the application as well, you can create addition accounts. The default password is `password`, and the user can change their password after logging in to the application for the first time.
+
+<img src={require('./img/create-new-user.png').default} title='Admin Registration' />

docs/docs/usage/_category_.json

@@ -1,8 +0,0 @@
-{
-  "label": "How to use the application",
-  "position": 3,
-  "link": {
-    "type": "generated-index",
-    "description": "Quick start on how to use the app on mobile and the web"
-  }
-}

docs/docs/usage/oauth.md

@@ -1,76 +0,0 @@
----
-sidebar_position: 5
----
-
-# OAuth Authentication
-
-This page contains details about using OAuth 2 in Immich.
-
-## 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:
-
-  * All URLs that will be used to access the login page of the Immich web client (eg. `http://localhost:2283/auth/login`, `http://192.168.0.200:2283/auth/login`, `https://immich.example.com/auth/login`)
-  * Mobile app redirect URL `app.immich:/`
-  
-:::caution
-You **MUST** include `app.immich:/` as the redirect URI for iOS and Android mobile app to work properly. 
-
-**Authentik example**
-<img src={require('./img/authentik-redirect.png').default} title="Authentik Redirection URL" width="80%" />
-:::
-
-## Enable OAuth
-
-Once you have a new OAuth client application configured, Immich can be configured using the following environment variables:
-
-| Key                 | Type    | Default              | Description                                                               |
-| ------------------- | ------- | -------------------- | ------------------------------------------------------------------------- |
-| OAUTH_ENABLED       | boolean | false                | Enable/disable OAuth2                                                     |
-| OAUTH_ISSUER_URL    | URL     | (required)           | Required. Self-discovery URL for client (from previous step)              |
-| OAUTH_CLIENT_ID     | string  | (required)           | Required. Client ID (from previous step)                                  |
-| OAUTH_CLIENT_SECRET | string  | (required)           | Required. Client Secret (previous step                                    |
-| 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                                      |
-
-:::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.
-:::
-
-Here is an example of a valid configuration for setting up Immich to use OAuth with Authentik:
-
-```
-OAUTH_ENABLED=true
-OAUTH_ISSUER_URL=http://192.168.0.187:9000/application/o/immich
-OAUTH_CLIENT_ID=f08f9c5b4f77dcfd3916b1c032336b5544a7b368
-OAUTH_CLIENT_SECRET=6fe2e697644da6ff6aef73387a457d819018189086fa54b151a6067fbb884e75f7e5c90be16d3c688cf902c6974817a85eab93007d76675041eaead8c39cf5a2
-OAUTH_BUTTON_TEXT=Login with Authentik
-```
-
-[oidc]: https://openid.net/connect/

docs/docs/usage/post-installation.md

@@ -1,57 +0,0 @@
----
-sidebar_position: 1
----
-
-# Post Installation
-
-This page contains information about what to do after you have installed the application.
-
-## Step 1 - Download the mobile app
-
-The mobile app can be downloaded from
-
-- [Google Play Store](https://play.google.com/store/apps/details?id=app.alextran.immich)
-- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
-- [F-Droid](https://f-droid.org/packages/app.alextran.immich)
-
-## Step 2 - Register the admin user
-
-The first user to register will be the admin user. The admin user will be able to add other users to the application.
-
-To register for the admin user, access the web application at `http://<machine-ip-address>:2283` and click on the **Getting Started** button.
-
-<img src={require('./img/admin-registration-form.png').default} width="500" title="Admin Registration" />
-
-Follow the prompts to register as the admin user and log in to the application.
-
-## Step 3 - Create a new user (optional)
-
-If you have a family member who wants to use the application, you can create a new account. The default password is `password`, and the user can change their password after logging in to the application for the first time.
-
-<img src={require('./img/create-new-user.png').default} title="Admin Registration" />
-
-## Step 4 - Access the mobile app
-
-Login to the mobile app with the server endpoint URL at `http://<machine-ip-address>:2283/api`
-
-<img src={require('./img/sign-in-phone.jpeg').default} width="50%" title="Mobile App Sign In" />
-
-## Step 5 - Back up your photos and videos
-
-Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.
-
-<img src={require('./img/backup-header.png').default} width="50%" title="Backup button" />
-
-You can select which album(s) you want to back up to the Immich server from the backup screen.
-
-<img src={require('./img/album-selection.png').default} width="50%" title="Backup button" />
-
-Scroll down to the bottom and press "**Start Backup**" to start the backup process. 
-
-You can also enable auto foreground or background backup (only on Android). For more information about the app mechanism, please visit the next pages.
-
-
-:::tip Application Mechanism
-#### [Foreground and background backup](/docs/usage/automatic-backup)
-#### [Bulk upload (using the CLI)](/docs/usage/bulk-upload)
-:::

docs/docs/usage/update.md

@@ -1,11 +0,0 @@
----
-sidebar_position: 4
----
-
-# Update the application
-
-If you are using Docker Compose, update the application use the following commands in the directory where the `docker-compose.yml` file is located:
-
-```bash title="Update Immich"
-docker-compose pull && docker-compose up -d # Or `docker compose`
-```

docs/docusaurus.config.js

@@ -28,10 +28,23 @@ const config = {
     locales: ["en"],
   },
 
+  plugins: [
+    async function myPlugin(context, options) {
+      return {
+        name: "docusaurus-tailwindcss",
+        configurePostCss(postcssOptions) {
+          // Appends TailwindCSS and AutoPrefixer.
+          postcssOptions.plugins.push(require("tailwindcss"));
+          postcssOptions.plugins.push(require("autoprefixer"));
+          return postcssOptions;
+        },
+      };
+    },
+  ],
   presets: [
     [
-      "classic",
-      /** @type {import('@docusaurus/preset-classic').Options} */
+      "docusaurus-preset-openapi",
+      /** @type {import('docusaurus-preset-openapi').Options} */
       ({
         docs: {
           showLastUpdateAuthor: true,
@@ -42,6 +55,10 @@ const config = {
           // Remove this to remove the "edit this page" links.
           editUrl: "https://github.com/immich-app/immich/tree/main/docs/",
         },
+        api: {
+          path: "../server/immich-openapi-specs.json",
+          routeBasePath: "/docs/api",
+        },
         // blog: {
         //   showReadingTime: true,
         //   editUrl: "https://github.com/immich-app/immich/tree/main/docs/",
@@ -56,6 +73,9 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      colorMode: {
+        defaultMode: "dark",
+      },
       announcementBar: {
         id: "site_announcement_immich",
         content: `⚠️ The project is under <strong>very active</strong> development. Expect bugs and changes. Do not use it as <strong>the only way</strong> to store your photos and videos!`,
@@ -78,14 +98,23 @@ const config = {
           {
             to: "/docs/overview/introduction",
             position: "right",
-            label: "Documentation",
+            label: "Docs",
+          },
+          {
+            to: "/docs/api",
+            position: "right",
+            label: "API",
           },
-          // { to: "/blog", label: "Blog", position: "right" },
           {
             href: "https://github.com/immich-app/immich",
             label: "GitHub",
             position: "right",
           },
+          {
+            href: "https://github.com/orgs/immich-app/projects/1",
+            label: "Roadmap",
+            position: "right",
+          },
         ],
       },
       footer: {
@@ -100,7 +129,7 @@ const config = {
               },
               {
                 label: "Installation",
-                to: "/docs/installation/requirements",
+                to: "/docs/install/requirements",
               },
             ],
           },
@@ -114,16 +143,20 @@ const config = {
             ],
           },
           {
-            title: "More",
+            title: "Links",
             items: [
-              {
-                label: "Blog",
-                to: "/blog",
-              },
+              // {
+              //   label: "Blog",
+              //   to: "/blog",
+              // },
               {
                 label: "GitHub",
                 href: "https://github.com/immich-app/immich",
               },
+              {
+                label: "Roadmap",
+                href: "https://github.com/orgs/immich-app/projects/1",
+              },
             ],
           },
         ],
@@ -133,6 +166,7 @@ const config = {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
+      image: "overview/img/feature-panel.png",
     }),
 };