From 89b8dcda04d6cd421f798af6509329b7f3f232b3 Mon Sep 17 00:00:00 2001
From: CHAIR <95461636+RaneyDazed@users.noreply.github.com>
Date: Mon, 6 Nov 2023 15:38:38 -0600
Subject: [PATCH] Add-immich (#245)

* Add Immich documentation to sandbox apps

This commit adds a new file `immich.md` to the `sandbox/apps` directory. The file contains information about Immich, a self-hosted photo and video backup tool with various features including bulk upload, facial recognition, hardware transcoding, OAuth and/or password login, libraries, mobile app, partner sharing, reverse geocoding, smart search, and XMP sidecars. The commit also includes instructions for installation, accessing Immich through a specific URL, and setup details. Additionally, it provides a link to the Immich documentation.

* Add immich application to sandbox index

The immich application has been added to the sandbox index, with the associated tag `sandbox-immich`.

* Add Immich to the list of applications in mkdocs.yml

This change adds Immich to the list of applications in `mkdocs.yml`.
---
 docs/sandbox/apps/immich.md | 56 +++++++++++++++++++++++++++++++++++++
 docs/sandbox/index.md       |  1 +
 mkdocs.yml                  |  1 +
 3 files changed, 58 insertions(+)
 create mode 100644 docs/sandbox/apps/immich.md

diff --git a/docs/sandbox/apps/immich.md b/docs/sandbox/apps/immich.md
new file mode 100644
index 000000000..4aaaede6d
--- /dev/null
+++ b/docs/sandbox/apps/immich.md
@@ -0,0 +1,56 @@
+# Immich
+
+## What is it?
+
+[Immich](https://immich.app/) is a self-hosted photo and video backup tool, similar to google photos and apple photos.
+
+### Features
+
+- Bulk Upload (Using the CLI)
+- Facial Recognition
+- Hardware Transcoding (Experimental)
+- Oauth and/or password login
+- Libraries
+- Mobile App
+- Partner Sharing
+- Reverse Geocoding
+- Smart Search
+- XMP Sidecars
+
+!!!info
+    By default, Immich is NOT protected behind your Authelia/SSO middleware. You have to create a user with an email and password for Immich upon start up. Its recommended that you use the email and password you set up upon instalation for consistencies sake.
+
+| Details     |             |             |
+|-------------|-------------|-------------|
+| [:material-home: Project home](https://immich.app/){: .header-icons } | [:octicons-link-16: Docs](https://immich.app/docs/overview/introduction){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/immich-app/immich){: .header-icons }|
+
+### 1. Installation
+
+``` shell
+
+sb install sandbox-immich
+
+```
+
+### 2. URL
+
+- To access Immich, visit `https://immich._yourdomain.com_`
+
+### 3. Setup
+
+!!!info
+    📢 Again, no default user is configured until you run through the setup screen, so you would ideally run through setup as soon as immich is deployed to secure the site. It is not behind authelia by default.
+
+???tip
+    In Administration > Settings is a button to copy the current admin configuration to your clipboard. So you can just grab it from there, and paste it into a file.
+
+If you would like to have the config file available, create a new config file (e.g. immich.config, and the config format is `.json`) and map it in inventory; just keep in mind that this disallows you from configuring Immich admin settings from the web ui.
+
+``` yaml
+
+immich_docker_envs_custom:
+  IMMICH_CONFIG_FILE: "/config/immich.config"
+
+```
+
+- [:octicons-link-16: Documentation: Immich Docs](https://immich.app/docs/overview/introduction){: .header-icons }
diff --git a/docs/sandbox/index.md b/docs/sandbox/index.md
index 4cd3ce2dc..edafa2b4e 100644
--- a/docs/sandbox/index.md
+++ b/docs/sandbox/index.md
@@ -49,6 +49,7 @@
 - **[Homarr](../sandbox/apps/homarr.md)**  - tag - `sandbox-homarr`
 - **[homebox](../sandbox/apps/homebox.md)**  - tag - `sandbox-homebox`
 - **[homepage](../sandbox/apps/homepage.md)**  - tag - `sandbox-homepage`
+- **[immich](../sandbox/apps/immich.md)**  - tag - `sandbox-immich`
 - **[influxdb](../sandbox/apps/influxdb.md)**  - tag - `sandbox-influxdb`
 - **[invoiceninja](../sandbox/apps/invoiceninja.md)**  - tag - `sandbox-invoiceninja`
 - **[jdownloader2](../sandbox/apps/jdownloader2.md)**  - tag - `sandbox-jdownloader2`
diff --git a/mkdocs.yml b/mkdocs.yml
index 931ee28fb..c18555e84 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -152,6 +152,7 @@ nav:
           - Cherry: sandbox/apps/cherry.md
           - Firefox: sandbox/apps/firefox.md
           - Homebox: sandbox/apps/homebox.md
+          - Immich: sandbox/apps/immich.md
           - Joplin: sandbox/apps/joplin.md
           - Linkding: sandbox/apps/linkding.md
           - Miniflux: sandbox/apps/miniflux.md