Merge remote-tracking branch 'origin/master' into email-docs

# Conflicts:
#	docs/start/config.md

_includes/config.yaml

@@ -7,11 +7,9 @@
 #       with the prefix INVENTREE_DB_
 #       e.g INVENTREE_DB_NAME / INVENTREE_DB_USER / INVENTREE_DB_PASSWORD
 database:
-  # Default configuration - sqlite filesystem database
-  ENGINE: sqlite3
-  NAME: '../inventree_default_db.sqlite3' 
-  
-  # For more complex database installations, further parameters are required
+  # Uncomment (and edit) one of the database configurations below,
+  # or specify database options using environment variables
+
   # Refer to the django documentation for full list of options
   
   # --- Available options: ---
@@ -27,14 +25,22 @@ database:
 
   # --- Example Configuration - sqlite3 ---
   # ENGINE: sqlite3
-  # NAME: '/path/to/database.sqlite3'
+  # NAME: '/home/inventree/database.sqlite3'
 
   # --- Example Configuration - MySQL ---
-  #ENGINE: django.db.backends.mysql
+  #ENGINE: mysql
   #NAME: inventree
-  #USER: inventree_username
+  #USER: inventree
   #PASSWORD: inventree_password
-  #HOST: '127.0.0.1'
+  #HOST: 'localhost'
+  #PORT: '3306'
+
+  # --- Example Configuration - Postgresql ---
+  #ENGINE: postgresql
+  #NAME: inventree
+  #USER: inventree
+  #PASSWORD: inventree_password
+  #HOST: 'localhost'
   #PORT: '5432'
 
 # Select default system language (default is 'en-us')
@@ -43,6 +49,7 @@ language: en-us
 # System time-zone (default is UTC)
 # Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 # Select an option from the "TZ database name" column
+# Use the environment variable INVENTREE_TIMEZONE
 timezone: UTC
 
 # List of currencies supported by default.
@@ -80,6 +87,7 @@ email:
   ssl: False
 
 # Set debug to False to run in production mode
+# Use the environment variable INVENTREE_DEBUG
 debug: True
 
 # Set debug_toolbar to True to enable a debugging toolbar for InvenTree
@@ -88,6 +96,7 @@ debug: True
 debug_toolbar: False
 
 # Configure the system logging level
+# Use environment variable INVENTREE_LOG_LEVEL
 # Options: DEBUG / INFO / WARNING / ERROR / CRITICAL
 log_level: WARNING
 
@@ -109,13 +118,14 @@ cors:
   # - https://sub.example.com
 
 # MEDIA_ROOT is the local filesystem location for storing uploaded files
-# By default, it is stored in a directory named 'inventree_media' local to the InvenTree directory
-# This should be changed for a production installation
-media_root: '../inventree_media'
+# By default, it is stored under /home/inventree
+# Use environment variable INVENTREE_MEDIA_ROOT
+media_root: '/home/inventree/media'
 
 # STATIC_ROOT is the local filesystem location for storing static files
-# By default it is stored in a directory named 'inventree_static' local to the InvenTree directory
-static_root: '../inventree_static'
+# By default, it is stored under /home/inventree
+# Use environment variable INVENTREE_STATIC_ROOT
+static_root: '/home/inventree/static'
 
 # Optional URL schemes to allow in URL fields
 # By default, only the following schemes are allowed: ['http', 'https', 'ftp', 'ftps']
@@ -128,7 +138,8 @@ static_root: '../inventree_static'
 # Backup options
 # Set the backup_dir parameter to store backup files in a specific location
 # If unspecified, the local user's temp directory will be used
-#backup_dir: '/home/inventree/backup/'
+# Use environment variable INVENTREE_BACKUP_DIR
+backup_dir: '/home/inventree/backup/'
 
 # Permit custom authentication backends
 #authentication_backends:

_includes/docker-compose.yml

@@ -0,0 +1,100 @@
+version: "3.8"
+
+# Docker compose recipe for InvenTree
+# - Runs PostgreSQL as the database backend
+# - Runs Gunicorn as the web server
+# - Runs nginx as a reverse proxy
+# - Runs the background worker process
+
+# ---------------------------------
+# IMPORTANT - READ BEFORE STARTING!
+# ---------------------------------
+# Before running, ensure that you change the "/path/to/data" directory,
+# specified in the "volumes" section at the end of this file.
+# This path determines where the InvenTree data will be stored!
+
+services:
+    # Database service
+    # Use PostgreSQL as the database backend
+    # Note: this can be changed to a different backend,
+    #       just make sure that you change the INVENTREE_DB_xxx vars below
+    db:
+        image: postgres
+        container_name: inventree_db
+        ports:
+            - 5432/tcp
+        environment:
+            - PGDATA=/var/lib/postgresql/data/pgdb
+            - POSTGRES_USER=pguser
+            - POSTGRES_PASSWORD=pgpassword
+        volumes:
+            - data:/var/lib/postgresql/data/
+        restart: unless-stopped
+
+    # InvenTree web server services
+    # Uses gunicorn as the web server
+    inventree:
+        image: inventree/inventree:latest
+        container_name: inventree_server
+        expose:
+            - 8080
+        depends_on:
+            - db
+        volumes:
+            - data:/home/inventree/data
+            - static:/home/inventree/static
+        environment:
+            - INVENTREE_DB_ENGINE=postgresql
+            - INVENTREE_DB_NAME=inventree
+            - INVENTREE_DB_USER=pguser
+            - INVENTREE_DB_PASSWORD=pgpassword
+            - INVENTREE_DB_PORT=5432
+            - INVENTREE_DB_HOST=db
+        restart: unless-stopped
+
+    # nginx acts as a reverse proxy
+    # static files are served by nginx
+    # web requests are redirected to gunicorn
+    nginx:
+        image: inventree/nginx:latest
+        container_name: inventree_proxy
+        depends_on:
+            - inventree
+        ports:
+            # Change "1337" to the port where you want InvenTree web server to be available
+            - 1337:80
+        volumes:
+            - static:/home/inventree/static
+
+    # background worker process handles long-running or periodic tasks
+    worker:
+        entrypoint: ./start_worker.sh
+        image: inventree/inventree:latest
+        container_name: inventree_worker
+        depends_on:
+            - db
+            - inventree
+        volumes:
+            - data:/home/inventree/data
+            - static:/home/inventree/static
+        environment:
+            - INVENTREE_DB_ENGINE=postgresql
+            - INVENTREE_DB_NAME=inventree
+            - INVENTREE_DB_USER=pguser
+            - INVENTREE_DB_PASSWORD=pgpassword
+            - INVENTREE_DB_PORT=5432
+            - INVENTREE_DB_HOST=db
+        restart: unless-stopped
+
+volumes:
+    # Static files, shared between containers
+    static:
+    # Persistent data, stored externally
+    data:
+        driver: local
+        driver_opts:
+            type: none
+            o: bind
+            # This directory specified where InvenTree data are stored "outside" the docker containers
+            # Change this path to a local system path where you want InvenTree data stored
+            device: /path/to/data