Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reorganize FAQ section (#4872)

Browse Source
This commit is contained in:
Oliver 2023-05-22 20:02:42 +10:00 committed by GitHub
parent 59cbf17b02
commit f76059b2b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 52 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
docs/docs/faq.md
View File

@ -4,7 +4,54 @@ title: FAQ
## Frequently Asked Questions
### Errors during InvenTree update
Below is a list of frequently asked questions. If you are having issues with InvenTree please consult this list first!
## Installation Isues
### Installing on Windows
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.
### 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!
## Update Issues
Sometimes, users may encounter unexpected error messages when updating their InvenTree installation to a newer version.
@ -38,42 +85,7 @@ or
!!! tip "A Refreshing Solution"
Performing a hard page refresh will remove old javascript files from your browser's cache
### Problems installing on Windows
InvenTree installation is not officially supported natively on Windows. Install using the WSL framework.
### 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.
### 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!
## Background Worker Issues
### Background Worker "Not Running"
@ -88,6 +100,8 @@ 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/production.md).
## 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.
@ -106,7 +120,7 @@ Ensure that the user running the InvenTree server has permission to create the r
If you are using Docker to run the InvenTree server, ensure that the user that runs the docker deamon has permission to create the required directories in the volume.
### docker - failed to mount local volume
### Failed to mount local volume
If, when running InvenTree setup using docker, you see an error message like this: