FAQ

Frequently Asked Questions¶

Below is a list of frequently asked questions. If you are having issues with InvenTree please consult this list first!

Installation Issues¶

Installing on Windows¶

InvenTree installation is not officially supported natively on Windows. However you can run on a Windows platform using docker.

Command 'invoke' not found¶

If the invoke command does not work, it means that the invoke python library has not been correctly installed.

Update the installed python packages with PIP:

pip3 install -U -r requirements.txt

Invoke Version¶

If the installed version of invoke is too old, users may see error messages during the installation procedure, such as:

'update' did not receive all required positional arguments!
Function has keyword-only arguments or annotations

As per the invoke guide, the minimum required version of Invoke is 2.0.0.

To determine the version of invoke you have installed, run either:

invoke --version

python -m invoke --version

If you are running an older version of invoke, ensure it is updated to the latest version:

pip install -U invoke

No module named 'django'¶

During the install or update process, you may be presented with an error like:

ModuleNotFoundError: No module named 'django'

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!

'str' object has no attribute 'removeSuffix'¶

This error occurs because your installed python version is not up to date. We require Python 3.9 or newer

You (or your system administrator) needs to update python to meet the minimum requirements for InvenTree.

Update Issues¶

Sometimes, users may encounter unexpected error messages when updating their InvenTree installation to a newer version.

The most common problem here is that the correct sequenct of steps has not been followed:

Ensure that the InvenTree web server and background worker processes are halted
Update the InvenTree software (e.g. using git or docker, depending on installation method)
Run the invoke update command
Restart the web server and background worker processes

For more information, refer to the installation guides:

Invoke Update

You must ensure that the invoke update command is performed every time you update InvenTree

Feature x does not work after update¶

If a particular menu / item is not visible after updating InvenTree, or a certain function no longer seems to work, it may be due to your internet browser caching old versions of CSS and JavaScript files.

Before raising an issue, try hard-refreshing the browser cache:

Ctrl + Shift + R

or

Ctrl + F5

A Refreshing Solution

Performing a hard page refresh will remove old javascript files from your browser's cache

Background Worker Issues¶

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

Supervisor

A better option is to manage the background worker process using a process manager such as supervisor. Refer to the production server guide.

Docker Issues¶

File Sync Issues - Docker¶

When installing under Docker, sometimes issues may arise keeping persistent data in sync. Refer to the common issues section in the docker setup guide for further details.

Permission denied for mkdir: /home/inventree¶

If you see an error message like this:

Permission denied for mkdir: /home/inventree/data/static

It means that the user running the InvenTree server does not have permission to create the required directories.

Ensure that the user running the InvenTree server has permission to create the required directories. For example, if running the server as the inventree user, ensure that the inventree user has permission to create the required directories.

If you are using Docker to run the InvenTree server, ensure that the user that runs the docker daemon has permission to create the required directories in the volume.

Failed to mount local volume¶

If, when running InvenTree setup using docker, you see an error message like this:

Error response from daemon: failed to mount local volume:

This means that either:

The specified directory does not exist on your local machine
The docker user does not have write permission to the specified directory

In either case, ensure that the directory is available on your local machine and the user account has the required permissions.