From 74cd0b9aed1a6e8c381c7e5022b4b61869d9dae0 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Tue, 31 Dec 2024 14:44:34 +1100
Subject: [PATCH] Update .env file (#8799)

* Update .env file

- No functional changes
- Improved file comments

* Update .env

Improved comment
---
 contrib/container/.env | 67 +++++++++++++++++++++++-------------------
 1 file changed, 36 insertions(+), 31 deletions(-)

diff --git a/contrib/container/.env b/contrib/container/.env
index 7124be1938..121b6e7fd2 100644
--- a/contrib/container/.env
+++ b/contrib/container/.env
@@ -1,48 +1,53 @@
 # InvenTree environment variables for docker compose deployment
+# For a full list of the available configuration options, refer to the InvenTree documentation:
+# https://docs.inventree.org/en/stable/start/config/
+
+# Specify the name of the docker-compose project
+COMPOSE_PROJECT_NAME=inventree
+
+# InvenTree version tag (e.g. 'stable' / 'latest' / 'x.x.x')
+INVENTREE_TAG=stable
+
+# InvenTree server URL - update this to match your host
+INVENTREE_SITE_URL="http://inventree.localhost"
 
 # Specify the location of the external data volume
 # By default, placed in local directory 'inventree-data'
 INVENTREE_EXT_VOLUME=./inventree-data
 
 # Ensure debug is false for a production setup
-INVENTREE_DEBUG=False
 INVENTREE_LOG_LEVEL=WARNING
 
-# InvenTree admin account details
-# Un-comment (and complete) these lines to auto-create an admin acount
-#INVENTREE_ADMIN_USER=
-#INVENTREE_ADMIN_PASSWORD=
-#INVENTREE_ADMIN_EMAIL=
-
-# Database configuration options
-INVENTREE_DB_ENGINE=postgresql
-INVENTREE_DB_NAME=inventree
-INVENTREE_DB_HOST=inventree-db
-INVENTREE_DB_PORT=5432
-
-# Database credentials - These should be changed from the default values!
-INVENTREE_DB_USER=pguser
-INVENTREE_DB_PASSWORD=pgpassword
-
-# Redis cache setup
-# Refer to settings.py for other cache options
-INVENTREE_CACHE_ENABLED=True
-INVENTREE_CACHE_HOST=inventree-cache
-INVENTREE_CACHE_PORT=6379
-
-# Options for gunicorn server
-INVENTREE_GUNICORN_TIMEOUT=90
-
 # Enable custom plugins?
 INVENTREE_PLUGINS_ENABLED=True
 
 # Run migrations automatically?
 INVENTREE_AUTO_UPDATE=True
 
-# Image tag that should be used
-INVENTREE_TAG=stable
+# InvenTree superuser account details
+# Un-comment (and complete) these lines to auto-create an admin acount
+#INVENTREE_ADMIN_USER=
+#INVENTREE_ADMIN_PASSWORD=
+#INVENTREE_ADMIN_EMAIL=
 
-# Site URL - update this to match your host
-INVENTREE_SITE_URL="http://inventree.localhost"
+# Database configuration options
+# DO NOT CHANGE THESE SETTINGS (unless you really know what you are doing)
+INVENTREE_DB_ENGINE=postgresql
+INVENTREE_DB_NAME=inventree
+INVENTREE_DB_HOST=inventree-db
+INVENTREE_DB_PORT=5432
 
-COMPOSE_PROJECT_NAME=inventree
+# Database credentials - These should be changed from the default values!
+# Note: These are *NOT* the InvenTree server login credentials,
+#       they are the credentials for the PostgreSQL database
+INVENTREE_DB_USER=pguser
+INVENTREE_DB_PASSWORD=pgpassword
+
+# Redis cache setup
+# Refer to the documentation for other cache options
+INVENTREE_CACHE_ENABLED=True
+INVENTREE_CACHE_HOST=inventree-cache
+INVENTREE_CACHE_PORT=6379
+
+# Options for gunicorn server
+INVENTREE_GUNICORN_TIMEOUT=90