From 323ee32de632be8052abed29a2d90e1d308b19f1 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 20 Apr 2022 23:09:31 +1000 Subject: [PATCH] Simplify top-level docker page --- docs/start/docker.md | 31 +++---------------------------- 1 file changed, 3 insertions(+), 28 deletions(-) diff --git a/docs/start/docker.md b/docs/start/docker.md index afa7441..31212e9 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -30,35 +30,11 @@ InvenTree provides sample docker-compose files to get you up and running. ### Environment Variables -InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables. +InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables. Using environment variables simplifies setup and improves portability. -The following environment variables for InvenTree server configuration are specified as part of the docker image, and can be overridden if required: +### Persistent Data -| Variable | Description | Default Value | -| --- | --- | --- | -| INVENTREE_LOG_LEVEL | InvenTree logging verbosity level |INFO | -| INVENTREE_CONFIG_FILE | Location (within the docker image) of the InvenTree configuration file | /home/inventree/data/config.yaml | -| INVENTREE_SECRET_KEY_FILE | Location (within the docker image) of the InvenTree sercret key file | /home/inventree/data/secret_key.txt | -| INVENTREE_WEB_PORT | Internal container port on which the InvenTree web server is hosted | 8000 | - -The following environment variables are explicitly **not configured** and *must* be passed to the container instance: - -| Variable | Description | -| --- | --- | -| INVENTREE_DB_ENGINE | Database engine (e.g. 'postgresql') | -| INVENTREE_DB_NAME | Database name (e.g. 'inventree') | -| INVENTREE_DB_HOST | Database server host (e.g. 'inventree-server' if using default docker-compose script) | -| INVENTREE_DB_PORT | Database server port (e.g. '5432') | -| INVENTREE_DB_USER | Database user name (e.g. 'pguser') | -| INVENTREE_DB_PASSWORD | Database user password (e.g. 'pgpassword') | - -### Data Directory - -Persistent data (e.g. uploaded media files) should be stored outside the container instance. - -InvenTree data are stored inside the container at `/home/inventree/data`. - -This directory should be mounted as a volume which points to a directory on your local machine. +Persistent data (e.g. uploaded media files) is stored outside the container instance. This directory should be mounted as a volume which the InvenTree docker container can access. ### Configuration File @@ -79,7 +55,6 @@ By default, the InvenTree container expects the `INVENTREE_SECRET_KEY_FILE` to e !!! warning "Same Key" Each InvenTree container instance must use the same secret key value, otherwise unexpected behavior will occur. - ## Docker Setup Guides With these basics in mind, refer to the following installation guides: