Merge branch 'master' into matmair/issue6281

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

contrib/container/Caddyfile

@@ -4,14 +4,18 @@
 # - INVENTREE_SERVER: The internal URL of the InvenTree container (default: http://inventree-server:8000)
 #
 # Note that while this file is a good starting point, it may need to be modified to suit your specific requirements
+#
+# Ref to the Caddyfile documentation: https://caddyserver.com/docs/caddyfile
 
 
+# Logging configuration for Caddy
 (log_common) {
 	log {
 		output file /var/log/caddy/{args[0]}.access.log
 	}
 }
 
+# CORS headers control (used for static and media files)
 (cors-headers) {
 	header Allow GET,HEAD,OPTIONS
 	header Access-Control-Allow-Origin *
@@ -25,8 +29,10 @@
 	}
 }
 
-# Change the host to your domain (this will serve at inventree.localhost)
-{$INVENTREE_SITE_URL:inventree.localhost} {
+# The default server address is configured in the .env file
+# If not specified, the default address is used - http://inventree.localhost
+# If you need to listen on multiple addresses, or use a different port, you can modify this section directly
+{$INVENTREE_SITE_URL:http://inventree.localhost} {
 	import log_common inventree
 
 	encode gzip
@@ -35,6 +41,7 @@
 		max_size 100MB
 	}
 
+	# Handle static request files
 	handle_path /static/* {
 		import cors-headers static
 
@@ -42,18 +49,31 @@
 		file_server
 	}
 
+	# Handle media request files
 	handle_path /media/* {
 		import cors-headers media
 
 		root * /var/www/media
 		file_server
 
+		# Force download of media files (for security)
+		# Comment out this line if you do not want to force download
 		header Content-Disposition attachment
 
+		# Authentication is handled by the forward_auth directive
+		# This is required to ensure that media files are only accessible to authenticated users
 		forward_auth {$INVENTREE_SERVER:"http://inventree-server:8000"} {
 			uri /auth/
 		}
 	}
 
-	reverse_proxy {$INVENTREE_SERVER:"http://inventree-server:8000"}
+	# All other requests are proxied to the InvenTree server
+	reverse_proxy {$INVENTREE_SERVER:"http://inventree-server:8000"} {
+
+		# If you are running behind another proxy, you may need to specify 'trusted_proxies'
+		trusted_proxies {
+			# enter your trusted proxy IP addresses here
+		}
+
+	}
 }