inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-12 18:25:27 +00:00
Code Activity

Improvements to installation instructions

Browse Source
This commit is contained in:
Oliver
2021-11-05 10:33:50 +11:00
parent 229af4b093
commit c5bac2d5d4
10 changed files with 69 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/start/install.md
View File

@ -63,6 +63,9 @@ Download InvenTree source code, into the `./src` directory:
git clone https://github.com/inventree/inventree src
```
!!! info "Main Branch = Development"
The "main" branch of the InvenTree code base represents the "latest" (development) code. If you would like to use most recent "stable" release, target the `stable` branch.
### Create Virtual Environment
Create a python virtual environment for installing required Python packages and binaries:
@ -89,24 +92,6 @@ This installs all required Python packages using pip package manager. It also cr
As part of the initial setup, an empty database needs to be created. Follow the instructions below particular to your database engine of choice:
### SQLite
SQLite uses a simple portable database file which is easy to use for debug and testing purposes.
Install required packages as follows:
!!! info "Sudo Actions"
Perform sudo actions from a separate shell, as 'inventree' user does not have sudo access
```
sudo apt-get install sqlite3
```
A `.sqlite3` database file will be automatically created, at the location specified in the configuration options. No further steps necessary.
!!! warning "SQLite Case Sensitivity"
SQLite has a known [string matching limitation](https://docs.djangoproject.com/en/dev/ref/databases/#substring-matching-and-case-sensitivity) for non ASCII characters. If you are using non ASCII characters (e.g. Cyrillic text), it is recommended that you do not use SQLite, as search functionality will not work correctly.
### PostgreSQL
#### Install PostgreSQL
@ -205,6 +190,24 @@ mysql> EXIT;
!!! info "Username / Password"
You should change the username and password from the values specified above. This username and password will also be for the InvenTree database connection configuration.
### SQLite
SQLite uses a simple portable database file which is easy to use for debug and testing purposes.
Install required packages as follows:
!!! info "Sudo Actions"
Perform sudo actions from a separate shell, as 'inventree' user does not have sudo access
```
sudo apt-get install sqlite3
```
A `.sqlite3` database file will be automatically created, at the location specified in the configuration options. No further steps necessary.
!!! warning "SQLite Case Sensitivity"
SQLite has a known [string matching limitation](https://docs.djangoproject.com/en/dev/ref/databases/#substring-matching-and-case-sensitivity) for non ASCII characters. If you are using non ASCII characters (e.g. Cyrillic text), it is recommended that you do not use SQLite, as search functionality will not work correctly.
## Configure InvenTree Options
Once the required software packages are installed and the database has been created, the InvenTree server options must be configured.