docs: add MkDocs Material site with GitHub Pages deployment

- Split 786-line README into 20 semantic docs pages
- Add MkDocs Material theme with dark mode, search, code copy, Mermaid
- Add GitHub Actions workflow for auto-deploy on push to main
- Replace plain-text hints with GitHub Alerts (NOTE/WARNING/TIP/IMPORTANT/CAUTION)
- Inline 28 UI button/icon images from assets/images/ into instruction text
- Add IP-Replacer JS feature: users enter Unraid IP once, all placeholders
  update across the site, persisted via localStorage (browser-only, no data sent)
- Shorten README to landing page linking to full docs site
- Use mkdocs-callouts plugin for GitHub Alert ↔ MkDocs admonition compatibility

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: rorar

.github/workflows/deploy-docs.yml

@@ -0,0 +1,25 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1 @@
+site/

README.md

@@ -0,0 +1 @@
+../assets

docs/assets

@@ -0,0 +1,30 @@
+# Step 3: Choose Your GPU Platform
+
+Before downloading templates, determine which GPU acceleration you want to use. This affects which **server** template (for video transcoding) and which **machine learning** template (for face recognition and image search) you need.
+
+```mermaid
+graph TD
+    A[What GPU do you have?] --> B{NVIDIA?}
+    A --> C{Intel iGPU?}
+    A --> D{AMD?}
+    A --> E{No GPU / CPU only}
+
+    B --> B1[Server: immich-server-nvenc]
+    B --> B2[ML: immich-machine-learning-cuda]
+
+    C --> C1[Server: immich-server-qsv-vaapi]
+    C --> C2[ML: immich-machine-learning-openvino]
+
+    D --> D1[Server: immich-server-qsv-vaapi]
+    D --> D2[ML: immich-machine-learning-rocm]
+
+    E --> E1[Server: immich-server]
+    E --> E2[ML: immich-machine-learning]
+```
+
+| GPU | Server Template (Transcoding) | ML Template (Inference) |
+|-----|-------------------------------|------------------------|
+| **None / CPU only** | `immich-server` | `immich-machine-learning` |
+| **Intel iGPU** (N100, UHD, Iris) | `immich-server-qsv-vaapi` | `immich-machine-learning-openvino` |
+| **AMD** (Polaris+) | `immich-server-qsv-vaapi` | `immich-machine-learning-rocm` |
+| **NVIDIA** (Pascal+) | `immich-server-nvenc` | `immich-machine-learning-cuda` |

docs/choose-gpu-platform.md

@@ -0,0 +1,13 @@
+# Cleanup After Migration
+
+## Cleanup Files
+After you have successfully downloaded and extracted your photos from Google Takeout, you can clean up the Firefox container by deleting it and any temporary files in `/mnt/user/immich/Takeout/` that were created during the download process.
+
+## Cleanup API Keys
+Remove your Immich API Key in your Account Settings-->API_KEY Keys that you created for the PhotoMigrator in the Immich web UI to ensure that there are no security risks from having an unused API key lying around.
+
+## Cleanup Google Photos
+If you have verified that all your photos have been successfully migrated to Immich and you no longer need your Google Photos library, you can choose to delete your Google Photos library to free up space and ensure that you are no longer relying on Google Photos for your photo storage.
+
+> [!CAUTION]
+> Make sure to double-check that everything is working correctly in Immich and that you have backups of your photos before deleting your Google Photos library.

docs/cleanup-after-migration.md

@@ -0,0 +1,26 @@
+# Step 9: Container Start Order with FolderView3
+
+Immich containers must start in the correct order. If the server starts before the database is ready, it will fail.
+
+To manage this on Unraid, install **FolderView3** from Community Applications:
+1. Go to **Apps** → search for **FolderView3** → Install
+2. Go to the **Docker** tab
+3. Scroll down and click ![Add Folder](assets/images/Unraid%20-%20Docker%20Tab%20-%20Button%20Add-Folder%20%28FolderView3%29.png){: .inline-button }
+4. **Name:** `Immich`
+5. **Icon (use the following URL):**
+```
+https://raw.githubusercontent.com/immich-app/immich/refs/heads/main/mobile/packages/ui/showcase/web/icons/apple-icon-180.png )
+```
+6. **Folder WebUI:** On
+7. **WebUI URL:** `http://<your-unraid-ip>:2283` (this will be the URL of the Immich server container)
+8. Edit `Preview` section to your liking (optional)
+9. Drag all four Immich containers into in the **Correct start order and set the toogles next to them to "ON"**
+  1. `immich-vectorchord-db` (PostgreSQL)
+  2. `immich-valkey` (Valkey)
+  3. `immich-machine-learning` (ML)
+  4. `immich-server` (Server — depends on all above)
+10. Click ![Submit](assets/images/Unraid%20-%20FolderView%203%20-%20Button%20Submit.png){: .inline-button } to save the folder configuration
+11. Back in **Docker** tab, click on the Immich folder and if the Containers weren't running before, click ![Start](assets/images/Unraid%20-%20Docker%20Tab%20-%20Dropdown-Menu%20Dropdown-Context%20-%20Button%20Start.png){: .inline-button }
+12. Optionally set Autostart to "ON" for the folder.
+
+FolderView3 will now start Immich and its dependent containers in sequence when you click on the folder and hit "Start".

docs/container-start-order-folderview3.md

@@ -0,0 +1,13 @@
+# Step 2: Create Docker Network
+
+All Immich containers need to communicate with each other by container name. We create a dedicated Docker network for this.
+
+1. Open the Unraid web interface `http://<your-unraid-ip>`
+2. Open the Unraid terminal (click the ![Terminal](assets/images/Unraid%20-%20Top%20Menu%20-%20Button%20Start%20Webterminal.png){: .inline-button } icon in the top right corner of the navigation bar)
+3. Run the following command to create the network:
+```bash
+docker network create immich_internal
+```
+4. When setting up each container below, select `immich_internal` as the network in the template settings.
+
+**Why a custom network?** Containers on the default `bridge` network communicate via host port mappings (NAT overhead). On a custom network, containers resolve each other by name directly — faster and more secure since database/cache ports don't need to be exposed to the host.

docs/create-docker-network.md

@@ -0,0 +1,15 @@
+# Kudos and Credits
+
+## This a polished guide from Starbuckstech @starbuck93
+Many thanks for sharing your knowledge and experience with the community!
+Link: https://blog.starbuckstech.com/articles/how-to-install-and-optimize-immich-on-unraid-for-faster-timeline-loading/
+Link Archive.org: https://web.archive.org/web/20260416192528/https://blog.starbuckstech.com/articles/how-to-install-and-optimize-immich-on-unraid-for-faster-timeline-loading/
+Gist: https://gist.github.com/starbuck93/5ce522b007f67267869afbf13d071f40
+
+## Immich Team
+Immich is an incredible open-source project that has been developed and maintained by a dedicated team of developers. Immich has quickly become one of the most popular self-hosted photo and video management applications, and it's all thanks to the hard work and dedication of the Immich team. If you find Immich useful, consider supporting the project by donating or contributing to the codebase.
+Link: https://immich.app/
+
+## PhotoMigrator Team
+PhotoMigrator is a fantastic tool that has been developed to help users migrate their photos from various services to Immich. The team behind PhotoMigrator has done an amazing job creating a user-friendly and efficient tool that simplifies the migration process for users. If you find PhotoMigrator useful, consider supporting the project by donating or contributing to the codebase.
+Link: https://github.com/jaimetur/PhotoMigrator/

docs/credits.md

@@ -0,0 +1,79 @@
+# Step 4: Download Docker Templates
+
+Open the Unraid web interface and open the terminal (click the ![Terminal](assets/images/Unraid%20-%20Top%20Menu%20-%20Button%20Start%20Webterminal.png){: .inline-button } icon in the top right corner of the navigation bar). Then download the templates you need.
+
+> [!NOTE]
+> `wget` downloads files from the web. The `-P` flag sets the download directory. Templates are saved to Unraid's Docker Manager template directory.
+
+## PostgreSQL
+Choose between stability and latest features:
+
+| Option | Image | VectorChord | pgvector | Status |
+|--------|-------|-------------|----------|--------|
+| **Stable** | `ghcr.io/immich-app/postgres:18-vectorchord0.5.3-pgvector0.8.1` | 0.5.3 | 0.8.1 | Tested by Immich team |
+| Experimental | `tensorchord/vchord-postgres:pg18-v1.1.1` | 1.1.1 | 0.8.2 | Latest, less tested |
+
+> [!NOTE]
+> You COULD use VectorChord 1.0.0+ (See [#23845](https://github.com/immich-app/immich/pull/23845)) or 1.1.1 (See [this discussion](https://github.com/immich-app/immich/discussions/23830#discussioncomment-15956803)). The 0.5.3 version is more stable and tested extensively with Immich. If you want to try the latest, use the experimental template.
+
+### **PostgreSQL database by Immich** — RECOMMENDED (stable, tested by Immich team):
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-postgres-official.xml
+```
+
+### **PostgreSQL database by VectorChord** — EXPERIMENTAL (latest VectorChord 1.1.1, less tested with Immich):
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-vectorchord-db.xml
+```
+
+## **Valkey** (cache/message broker):
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-valkey.xml
+```
+
+## Machine Learning template (choose one based on your GPU):
+
+### **CPU only** — no GPU acceleration:
+*CPU inference is possible but will be much slower for tasks like face recognition and CLIP-based search. Only recommended if you have a powerful CPU and a small library. Will work but expect slower performance and high load on the CPU.*
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-machine-learning.xml
+```
+
+### **NVIDIA CUDA:**
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-machine-learning-cuda.xml
+```
+
+### **Intel OpenVINO:**
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-machine-learning-openvino.xml
+```
+
+### **AMD ROCm:**
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-machine-learning-rocm.xml
+```
+
+## Server template (choose one based on your GPU):
+*These templates are for video transcoding. If you don't have a GPU or don't want to use it for transcoding, choose the CPU-only template.*
+
+### **CPU only** — no GPU transcoding:
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-server.xml
+```
+
+### **Intel QSV / AMD VAAPI** — uses `/dev/dri`:
+*You can also use your Intel iGPU ("inbuilt graphics card" in your CPU) for transcoding with Quick Sync Video (QSV) or your AMD GPU with VAAPI. Both use the same template since they both leverage `/dev/dri` for hardware acceleration.*
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-server-qsv-vaapi.xml
+```
+
+### **NVIDIA NVENC** — uses `--runtime=nvidia`:
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/immich-server-nvenc.xml
+```
+
+## **PhotoMigrator** (for Google Takeout migration):
+```bash
+wget -P /boot/config/plugins/dockerMan/templates-user/ https://raw.githubusercontent.com/rorar/unraid-templates/main/templates/photomigrator.xml
+```