diff --git a/docs/faq.md b/docs/faq.md index f0d70fe..e8c6f9d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -34,4 +34,18 @@ pip3 install -U -r requirements.txt Most likely you are trying to run the InvenTree server from outside the context of the virtual environment where the required python libraries are installed. -Always activate the virtual environment before running server commands! \ No newline at end of file +Always activate the virtual environment before running server commands! + +### Background Worker "Not Running" + +The background worker process must be started separately to the web-server application. + +From the top-level source directory, run the following command from a separate terminal, while the server is already running: + +``` +invoke worker +``` + +!!! info "Supervisor" + +A better option is to manage the background worker process using a process manager such as supervisor. Refer to the [deployment guide](../start/deploy). diff --git a/docs/start/deploy.md b/docs/start/deploy.md index 360bc21..d50fb00 100644 --- a/docs/start/deploy.md +++ b/docs/start/deploy.md @@ -19,12 +19,6 @@ Install required system packages (as superuser). First, install required system packages as per the [OS requirements](../intro#os-requirements). -Then, install the supervisor process manager: - -``` -sudo apt-get install supervisor -``` - Next, install the system packages required for your particular database: ### MySQL @@ -134,6 +128,10 @@ Edit the configuration file at `/home/inventree/src/InvenTree/config.yaml`. !!! warning "Configure Database" Ensure database settings are correctly configured in `config.yaml` before proceeding to the next step! +## Create Database + +!!! todo "TODO" + # Development Server The InvenTree development server is useful for testing and configuration - and it may be wholly sufficient for a small-scale installation. @@ -159,6 +157,16 @@ inv server -a 192.168.120.1:8000 !!! warning "Not For Production" It should be noted that the *development server* provided with django / InvenTree is probably not suitable for your production environment. Instead, use a proper web-server (such as Gunicorn, below). +## Install Supervisor + +!!! todo "More details here" + +Install the supervisor process manager: + +``` +sudo apt-get install supervisor +``` + ## Gunicorn Following is a simple tutorial on serving InvenTree using [Gunicorn](https://gunicorn.org/). Gunicorn is a Python WSGI server which provides a multi-worker server which is well suited to handling multiple simultaneous requests. Gunicorn is a solid choice for a production server which is easy to configure and performs well in a multi-user environment. diff --git a/docs/start/install.md b/docs/start/install.md index 2e87ea1..c12f89a 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -36,11 +36,6 @@ Once the required packages are installed, the database configuration must be adj As part of the previous *install* step, a configuration file (**config.yaml**) is created. The configuration file provides administrators control over various setup options without digging into the Django *settings.py* script. The default setup uses a local sqlite database with *DEBUG* mode enabled. -For further information on installation configuration, refer to the [Configuration](../config) section. - -!!! warning "Configure Database" - Ensure database settings are correctly configured in `config.yaml` before proceeding to the next step! - ### Initialize Database Once install settings are correctly configured (in *config.yaml*) run the initial setup script: