InvenTree/docs/docs/faq.md

143 lines
5.2 KiB
Markdown
Raw Normal View History

---
title: FAQ
---
## Frequently Asked Questions
2023-05-22 10:02:42 +00:00
Below is a list of frequently asked questions. If you are having issues with InvenTree please consult this list first!
## Installation Issues
2023-05-22 10:02:42 +00:00
### Installing on Windows
2023-05-22 10:02:42 +00:00
InvenTree installation is not officially supported natively on Windows. However you can run on a Windows platform using [docker](./start/docker.md).
### Command 'invoke' not found
If the `invoke` command does not work, it means that the [invoke](https://pypi.org/project/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!"* (or similar).
As per the [invoke guide](./start/intro.md#invoke), the minimum required version of Invoke is `1.4.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.
2023-05-22 10:02:42 +00:00
### 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 v3.9 or newer](./start/intro.md#python-requirements)
You (or your system administrator) needs to update python to meet the minimum requirements for InvenTree.
2023-05-22 10:02:42 +00:00
## 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:
1. Ensure that the InvenTree web server and background worker processes are *halted*
1. Update the InvenTree software (e.g. using git or docker, depending on installation method)
1. Run the `invoke update` command
1. Restart the web server and background worker processes
For more information, refer to the installation guides:
- [Docker Installation](./start/docker_prod.md#updating-inventree)
- [Bare Metal Installation](./start/install.md#updating-inventree)
!!! warning "Invoke Update"
You must ensure that the `invoke update` command is performed *every time* you update InvenTree
2023-05-22 10:02:42 +00:00
### 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](https://github.com/inventree/inventree/issues), try hard-refreshing the browser cache:
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>R</kbd>
or
<kbd>Ctrl</kbd> + <kbd>F5</kbd>
!!! tip "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
```
!!! info "Supervisor"
A better option is to manage the background worker process using a process manager such as supervisor. Refer to the [production server guide](./start/bare_prod.md).
2023-05-22 10:02:42 +00:00
## Docker Issues
### File Sync Issues - Docker
When installing under [Docker](./start/docker.md), sometimes issues may arise keeping [persistent data](./start/docker.md#persistent-data) in sync. Refer to the [common issues](./start/docker_prod.md#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.
Faq docker (#4871) * Remove stat context variables * Revert "Remove stat context variables" This reverts commit 0989c308d0cea9b9405a1338d257b542c6d33d73. * Allow longer timeout for image download tests * updated translation base * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * docs: Update FAQ section - Add note regarding permissions for docker directories --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-05-22 07:17:59 +00:00
2023-05-22 10:02:42 +00:00
### Failed to mount local volume
Faq docker (#4871) * Remove stat context variables * Revert "Remove stat context variables" This reverts commit 0989c308d0cea9b9405a1338d257b542c6d33d73. * Allow longer timeout for image download tests * updated translation base * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * Fix: New translations django.po from Crowdin * docs: Update FAQ section - Add note regarding permissions for docker directories --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-05-22 07:17:59 +00:00
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.