inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-12 10:15:33 +00:00
Code Activity

More docs

Browse Source 
(cherry picked from commit 6386f69213)
This commit is contained in:
Oliver Walters
2021-03-24 22:23:59 +11:00
parent bb99884d68
commit 3fddd8d2da
3 changed files with 68 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/start/install.md
View File

@ -30,24 +30,6 @@ To display a list of the available configuration scripts, run the following comm
inv --list
```
## Installation
Now that the source code is downloaded (and optionally you have configured a Python virtual environment), the Python packages required to run InvenTree can be installed. InvenTree is a Python/Django application and relies on the pip package manager. All packages required to develop and test InvenTree are installed via pip. Package requirements can be found in ``requirements.txt``.
To setup the InvenTree environment, run the following commands (from the InvenTree source directory):
```
inv install
```
This installs all required Python packages using pip package manager. It also creates a (default) database configuration file which needs to be edited to meet user needs before proceeding (see next step below).
Additionally, this step creates a *SECRET_KEY* file which is used for the django authentication framework.
!!! warning "Keep it secret, keep it safe"
The SECRET_KEY file should never be shared or made public.
### Database Configuration
Once the required packages are installed, the database configuration must be adjusted to suit your particular needs. InvenTree provides a simple default setup which should work *out of the box* for testing and debug purposes.