docs: details for windows users how to change docker volume (#12551)

* details for windows users * Update requirements.md
2024-09-24 10:38:13 -04:00
parent b85d8943e7
commit af8f3774d0
3 changed files with 38 additions and 23 deletions
@@ -23,7 +23,33 @@ Immich requires the command `docker compose` - the similarly named `docker-compo
 - **RAM**: Minimum 4GB, recommended 6GB.
 - **CPU**: Minimum 2 cores, recommended 4 cores.
 - **Storage**: Recommended Unix-compatible filesystem (EXT4, ZFS, APFS, etc.) with support for user/group ownership and permissions.
-  - This can present an issue for Windows users. See [here](/docs/install/environment-variables#supported-filesystems)
-    for more details and alternatives.
+  - This can present an issue for Windows users. See below for details and an alternative setup.
  - The generation of thumbnails and transcoded video can increase the size of the photo library by 10-20% on average.
-  - Network shares are supported for the storage of image and video assets only.
+  - Network shares are supported for the storage of image and video assets only. It is not recommended to use a network share for your database location due to performance and possible data loss issues.
+
+### Special requirements for Windows users
+
+<details>
+<summary>Database storage on Windows systems</summary>
+  
+The Immich Postgres database (`DB_DATA_LOCATION`) must be located on a filesystem that supports user/group
+ownership and permissions (EXT2/3/4, ZFS, APFS, BTRFS, XFS, etc.). It will not work on any filesystem formatted in NTFS or ex/FAT/32.
+It will not work in WSL (Windows Subsystem for Linux) when using a mounted host directory (commonly under `/mnt`).
+If this is an issue, you can change the bind mount to a Docker volume instead as follows:
+
+Make the following change to `.env`:
+
+```diff
+- DB_DATA_LOCATION=./postgres
+ DB_DATA_LOCATION=pgdata
+```
+
+Add the following line to the bottom of `docker-compose.yml`:
+
+```diff
+volumes:
+  model-cache:
+ pgdata:
+```
+
+</details>