UNOFFICAL/UNSUPPORTED: Docker Compose with Traefik and nginx

[fbelectronics]

Warning

This is NOT a solution supported by the developers, and if you have issues with it, please DO NOT ask them for support.
Ask for support on this discussion and I or someone else may be able to help.

On my server I had already traefik running as a reverse proxy, so I didn't want to use the bundled Caddy as such.
Since Caddy was also serving the static files it has been replaced with nginx. Please find the compose file for that setup below.

Changes/Tweaks to the official one:

• There is one line added to the .env to set the hostname for treafik called INVENTREE_HOSTNAME.
• in the compose file the container names are removed. This allows for easier multiple deployment on the same system, since you just have to change the COMPOSE_PROJECT_NAME in the .env file and can deploy again.
• Removed the port/expose tags for the DB. This is not needed for running since ports are accessible within the compose containers anyways. Comment it back in if you need database access from outside the compose file
• The traefik network is called traefik in my case. Make sure you have the traefik option --providers.docker.network=traefik set accordingly, to tell traefik which IP addresses to use for routing. Otherwise it might end up wanting to route to the inventree network IP address, which is not accessible.

compose.yaml

# Docker compose recipe for a production-ready InvenTree setup, with the following containers:
# - PostgreSQL as the database backend
# - gunicorn as the InvenTree web server
# - django-q as the InvenTree background worker process
# - Caddy as a reverse proxy
# - redis as the cache manager (optional, disabled by default)

# ---------------------
# READ BEFORE STARTING!
# ---------------------

# -----------------------------
# Setting environment variables
# -----------------------------
# Shared environment variables should be stored in the .env file
# Changes made to this file are reflected across all containers!
#
# IMPORTANT NOTE:
# You should not have to change *anything* within this docker-compose.yml file!
# Instead, make any changes in the .env file!

# ------------------------
# InvenTree Image Versions
# ------------------------
# By default, this docker-compose script targets the STABLE version of InvenTree,
# image: inventree/inventree:stable
#
# To run the LATEST (development) version of InvenTree,
# change the INVENTREE_TAG variable (in the .env file) to "latest"
#
# Alternatively, you could target a specific tagged release version with (for example):
# INVENTREE_TAG=0.7.5
#

services:
    # Database service
    # Use PostgreSQL as the database backend
    inventree-db:
        image: postgres:13
        # ports:
        #     - "5432:5432"
        # expose:
        #     - ${INVENTREE_DB_PORT:-5432}/tcp
        environment:
            - PGDATA=/var/lib/postgresql/data/pgdb
            - POSTGRES_USER=${INVENTREE_DB_USER:?You must provide the 'INVENTREE_DB_USER' variable in the .env file}
            - POSTGRES_PASSWORD=${INVENTREE_DB_PASSWORD:?You must provide the 'INVENTREE_DB_PASSWORD' variable in the .env file}
            - POSTGRES_DB=${INVENTREE_DB_NAME:?You must provide the 'INVENTREE_DB_NAME' variable in the .env file}
        volumes:
            # Map 'data' volume such that postgres database is stored externally
            - ${INVENTREE_EXT_VOLUME:?You must specify the 'INVENTREE_EXT_VOLUME' variable in the .env file!}:/var/lib/postgresql/data/:z
        restart: unless-stopped
        networks:
            - inventree

    # redis acts as database cache manager
#    inventree-cache:
#        image: redis:7.0
#        env_file:
#            - .env
#        expose:
#            - ${INVENTREE_CACHE_PORT:-6379}
#        restart: always
#        networks:
#            - inventree

    # InvenTree web server service
    # Uses gunicorn as the web server
    inventree-server:
        # If you wish to specify a particular InvenTree version, do so here
        image: inventree/inventree:${INVENTREE_TAG:-stable}
        # Only change this port if you understand the stack.
        #expose:
        #    - ${INVENTREE_SERVER_PORT}
        depends_on:
            - inventree-db
        env_file:
            - .env
        environment:
            - INVENTREE_DB_PASSWORD=${INVENTREE_DB_PASSWORD}
        volumes:
            # Data volume must map to /home/inventree/data
            - ${INVENTREE_EXT_VOLUME}:/home/inventree/data:z
        restart: unless-stopped
        labels:
            - traefik.enable=true
            - traefik.http.routers.inventree.entrypoints=websecure
            - traefik.http.routers.inventree.rule=Host(`${INVENTREE_HOSTNAME}`)
            - traefik.http.routers.inventree.tls=true
            - traefik.http.routers.inventree.tls.certresolver=home
            - traefik.http.services.inventree.loadbalancer.server.port=${INVENTREE_SERVER_PORT}
            - com.centurylinklabs.watchtower.enable=False
        networks:
            - inventree
            - traefik

    # Background worker process handles long-running or periodic tasks
    inventree-worker:
        # If you wish to specify a particular InvenTree version, do so here
        image: inventree/inventree:${INVENTREE_TAG:-stable}
        command: invoke worker
        depends_on:
            - inventree-server
        env_file:
            - .env
        environment:
            - INVENTREE_DB_PASSWORD=${INVENTREE_DB_PASSWORD}
        volumes:
            # Data volume must map to /home/inventree/data
            - ${INVENTREE_EXT_VOLUME}:/home/inventree/data:z
        labels:
            - com.centurylinklabs.watchtower.enable=False
        restart: unless-stopped
        networks:
            - inventree

    inventree-static-fileserver:
        image: nginx
        restart: always
        depends_on: 
            - inventree-server
        env_file:
            - .env
        volumes:
            - ${INVENTREE_EXT_VOLUME}/static:/var/www/static:z
            - ${INVENTREE_EXT_VOLUME}/media:/var/www/media:z
            - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro,z
        labels:
            - traefik.enable=true
            - traefik.http.routers.inventree-static.entrypoints=websecure
            - traefik.http.routers.inventree-static.rule=Host(`${INVENTREE_HOSTNAME}`) && PathPrefix(`/static`)
            - traefik.http.routers.inventree-static.tls=true
            - traefik.http.routers.inventree-static.tls.certresolver=home
            - traefik.http.routers.inventree-media.entrypoints=websecure
            - traefik.http.routers.inventree-media.rule=Host(`${INVENTREE_HOSTNAME}`) && PathPrefix(`/media`)
            - traefik.http.routers.inventree-media.tls=true
            - traefik.http.routers.inventree-media.middlewares=inventree-auth
            - traefik.http.routers.inventree-media.tls.certresolver=home
            - traefik.http.middlewares.inventree-auth.forwardauth.address=http://inventree-server:${INVENTREE_SERVER_PORT}/auth/
            - com.centurylinklabs.watchtower.enable=False
        networks:
            - inventree
            - traefik

networks:
    inventree:
    traefik:
        name: traefik
        external: true

.env

# InvenTree environment variables for docker compose deployment

# Specify the location of the external data volume
# By default, placed in local directory 'inventree-data'
INVENTREE_EXT_VOLUME=/home/user/docker/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=Your_Secure_Password

# Redis cache setup (disabled by default)
# Un-comment the following lines to enable Redis cache
# Note that you will also have to run docker-compose with the --profile redis command
# 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

# Site URL - update this to match your host
INVENTREE_SITE_URL="https://inventree.yourdomain.com"
INVENTREE_HOSTNAME="inventree.yourdomain.com" # Same as INVENTREE_SITE_URL but without the http/https
INVENTREE_WEB_PORT=80
INVENTREE_SERVER_PORT=8000

COMPOSE_PROJECT_NAME=inventree

nginx.conf

# An example configuration file for running InvenTree container behind an nginx proxy
# While suitable for a simple installation, this file will likely require some modification
# if you are running a more complex setup (e.g behind another proxy, or with HTTPS)

server {

    # Listen for connection on (internal) port 80
    # If you are exposing this server to the internet, you should use HTTPS!
    # In which case, you should also set up a redirect from HTTP to HTTPS, and listen on port 443
    # See the Nginx documentation for more details
    listen 80;

    real_ip_header proxy_protocol;

    location / {
        alias /var/www;
    }

    # Redirect any requests for static files
    location /static/ {
        alias /var/www/static/;
        autoindex on;

        # Caching settings
        expires 30d;
        add_header Pragma public;
        add_header Cache-Control "public";
    }

    # Redirect any requests for media files
    location /media/ {
        alias /var/www/media/;

        # Media files require user authentication
        # auth_request /auth;

        # Content header to force download
        add_header Content-disposition "attachment";
    }
}