From 1935b88d13deba35f21d2104ac1dca65ad20ec4c Mon Sep 17 00:00:00 2001 From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> Date: Fri, 22 Nov 2024 00:53:47 -0500 Subject: [PATCH] docs: clarify/strengthen wording of PG deployment requirements (#14294) * clarify/strengthen PG wording * 2 * oops * Update requirements.md --------- Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com> --- docs/docs/install/requirements.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index f3f4d2c23d..74c4a2f831 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -23,15 +23,21 @@ 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 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. It is not recommended to use a network share for your database location due to performance and possible data loss issues. + +:::tip +Good performance and a stable connection to the Postgres database is critical to a smooth Immich experience. +The Postgres database files are typically between 1-3 GB in size. +For this reason, the Postgres database (`DB_DATA_LOCATION`) should ideally use local SSD storage, and never a network share of any kind. +Additionally, if Docker resource limits are used, the Postgres database requires at least 2GB of RAM. +Windows users may run into issues with non-Unix-compatible filesystems, see below for more details. +::: ### Special requirements for Windows users
Database storage on Windows systems - + 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`).