From 7d41e4ee64afaf3b674f6b7618f361d99c80a3b0 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Sun, 18 Oct 2020 20:42:31 +1100 Subject: [PATCH] Update installation instructions with OS specific requirements --- docs/start/install.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/docs/start/install.md b/docs/start/install.md index b7e55ff..61d9f7f 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -22,29 +22,52 @@ Database selection should be determined by your particular installation requirem 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](https://gunicorn.org/). For more information see the [deployment documentation](start/deploy). -## Setup +## 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. -!!! warning "Windows" - If you are using the Windows operating system, it is recommended that you use the WSL (Windows Subsystem for Linux) framework +Installing and running InvenTree should be possible on most operating systems, as it requires only cross-platform Python libraries. -### Requirements +### Linux -To install InvenTree you will need python3 (>3.6) installed, as well as PIP (the Python package manager). - -Install these required programs (e.g. using apt or similar) before running the setup scripts. - -For example: +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 python3-pip +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) 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 +``` + +## Python Setup + +To install InvenTree you will need python3 (>3.6) installed, as well as PIP (the Python package manager), and the Invoke tool. + ### 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.