From ca775ab3e946fd555285db655a1ae6472d704841 Mon Sep 17 00:00:00 2001
From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
Date: Fri, 9 Aug 2024 17:36:32 -0400
Subject: [PATCH] docs: Update docs + example.env for DB_PASSWORD (#11678)

---
 docker/example.env                   | 1 +
 docs/docs/install/docker-compose.mdx | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/docker/example.env b/docker/example.env
index 99b1a9bbd4..9ad3af3c0e 100644
--- a/docker/example.env
+++ b/docker/example.env
@@ -12,6 +12,7 @@ DB_DATA_LOCATION=./postgres
 IMMICH_VERSION=release
 
 # Connection secret for postgres. You should change it to a random password
+# Please use only the characters `A-Za-z0-9`, without special characters or spaces
 DB_PASSWORD=postgres
 
 # The values below this line do not need to be changed
diff --git a/docs/docs/install/docker-compose.mdx b/docs/docs/install/docker-compose.mdx
index 9045891fd8..0b69bd8639 100644
--- a/docs/docs/install/docker-compose.mdx
+++ b/docs/docs/install/docker-compose.mdx
@@ -56,7 +56,8 @@ Optionally, you can enable hardware acceleration for machine learning and transc
 
 - Populate custom database information if necessary.
 - Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
-- Consider changing `DB_PASSWORD` to something randomly generated
+- Consider changing `DB_PASSWORD` to a custom value. Postgres is not publically exposed, so this password is only used for local authentication.
+  To avoid issues with Docker parsing this value, it is best to use only the characters `A-Za-z0-9`.
 
 ### Step 3 - Start the containers