inventree-docs/docs/start/install.md

title

title
Install InvenTree

Introduction

The InvenTree server application communicates with a backend database, and serves data to the user(s) via a web framework and an API. Before users can interact with the InvenTree system, the server must be installed and properly configured, and then the server process must be started (at a network location which is accessible to the users).

Supported Databases

InvenTree can be used by any database backend which is supported by the Django framework:

• SQLite
• PostgreSQL
• MariaDB
• MySQL
• Oracle

Database selection should be determined by your particular installation requirements. By default, InvenTree uses SQLite which provides a simple file-based database that allows a quick setup for development and testing.

Serving Data

Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as Gunicorn. For more information see the deployment documentation.

OS Requirements

To install a complete development environment for InvenTree, follow the steps presented below. A production environment will require further work as per the particular application requirements.

Installing and running InvenTree should be possible on most operating systems, as it requires only cross-platform Python libraries.

On some systems, the dependencies for the weasyprint package might not be installed. Consider running through the weasyprint installation steps before moving forward.

Linux

The InvenTree documentation assumes that the operating system is a Linux variant. To install the required python packages to get started on a Linux system, run the following commands:

sudo apt-get update
sudo apt-get install python3 python3-dev
sudo apt-get install python3-pip python3-invoke

!!! warning "Sudo" apt-get commands will (most likely) be required to run under sudo. Take care not to run the installation scripts under sudo, as this may alter the system python path and cause the InvenTree installation to not work correctly

Windows

InvenTree can be installed and run from the Windows command line, assuming the following binaries are available in the system PATH:

• python3
• pip3
• invoke

!!! info "WSL"

Alternatively, if you are running under the Windows operating system you can install and run InvenTree using the [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) framework. Running under WSL provides a Linux compatible layer which simplifies InvenTree installation.

FreeBSD

If you are running the FreeBSD operating system, run the following commands to install the required Python packages:

pkg install python
pkg install py37-pip
pkg install py37-wheel
pkg install py37-invoke

Download Source Code

Download the InvenTree source code to a local directory. It is recommended to perform this step using git, as this allows the InvenTree installation to be easily updated to the latest version.

git clone https://github.com/inventree/inventree/

Alternatively, the source can be downloaded as a .zip archive.

Once the source is downloaded, cd into the source directory:

cd /path/to/inventree/

(substitute /path/to/inventree/ with the directory where you have downloaded the source code).

Python Setup

To install InvenTree you will need python3 (>3.6) installed, as well as PIP (the Python package manager), and the Invoke tool.

!!! warning "Python Version" InvenTree requrires Python 3.6 (or newer). If your system has an older version of Python installed, you will need to follow the update instructions for your OS.

Python Virtual Environment

Installing the required Python packages inside a virtual environment allows a local install separate to the system-wide Python installation. While not strictly necessary, using a virtual environment is highly recommended as it prevents conflicts between the different Python installations.

You can read more about Python virtual environments here.

To configure Inventree inside a virtual environment, cd into the inventree base directory and run the following commands:

sudo apt-get install python3-venv
python3 -m venv inventree-env
source inventree-env/bin/activate

!!! note "Activate Virtual Environment" if source inventree-env/bin/activate is not working try . inventree-env/bin/activate

!!! note "Virtual Environment on Windows" To create and activate a virtual environment in Windows, run the following commands: py -m venv inventree-env .\inventree-env\Scripts\activate

Refer to the [official Python documentation](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) to setup a virtual environment on Windows.

This will place the current shell session inside a virtual environment - the terminal should display the (inventree-env) prefix.

!!! warning "Activate virtual environment" Remember to activate the virtual environment when starting each shell session, before running Inventree commands. This will ensure that the correct environment is being used.

Invoke

InvenTree setup is performed using the invoke Python build tool. Various useful scripts are defined in the tasks.py file.

Install invoke as follows:

pip3 install invoke

!!! warning "Invoke Version" InvenTree requires invoke version 1.4.0 or newer. Some platforms may be shipped with older versions of invoke!

To display a list of the available configuration scripts, run the following command:

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.

As part of the previous install step, a configuration file (config.yaml) is created. The configuration file provides administrators control over various setup options without digging into the Django settings.py script. The default setup uses a local sqlite database with DEBUG mode enabled.

For further information on installation configuration, refer to the Configuration section.

!!! warning "Configure Database" Ensure database settings are correctly configured in config.yaml before proceeding to the next step!

Initialize Database

Once install settings are correctly configured (in config.yaml) run the initial setup script:

inv migrate

This performs the initial database migrations, creating the required tables, etc.

The database should now be installed!

Create Admin Account

Create an initial superuser (administrator) account for the InvenTree instance:

inv superuser

!!! warning "Solving Cairo Errors" In the case the above command returns errors with the Cairo package, it implies that dependencies for the weasyprint package are not installed on the system. To solve them, run through the weasyprint installation steps then re-run inv install and inv superuser.

Run Development Server

The InvenTree database is now setup and ready to run. A simple development server can be launched from the command line.

To launch the development server, run the following commands:

inv server

For more server options, run:

inv server -h

This will launch the InvenTree web interface at http://127.0.0.1:8000. For other options refer to the django docs

Run Production Server

For a production install, refer to deployment instructions.