inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00
Code

Merge remote-tracking branch 'inventree/master'

Browse Source
This commit is contained in:
Oliver Walters 2020-10-18 21:35:10 +11:00
commit 1034884425
4 changed files with 53 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/contribute.md
View File

@ -31,8 +31,13 @@ Documenting a large software project is a challenging and ongoing effort. If you
### Donate ### Donate
{% if 'readthedocs.org' in config.docs_dir %}
{% set assets = '/en/latest/assets' %}
{% else %}
{% set assets = '/assets' %}
{% endif %}
If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development. If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development.
[ Donate :material-emoticon-cool: ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE&currency_code=AUD){: .md-button .md-button--primary } [ Donate <!-- :material-emoticon-cool: --> ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE&currency_code=AUD){: .md-button .md-button--primary }
<img src="/assets/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 102px; length:225px; vertical-align:middle;"> <img src="{{ assets }}/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 136px; length:300px; vertical-align:middle; padding-left: 20px">

16
docs/index.md
View File

@ -20,44 +20,44 @@ InvenTree is designed to allow for a flexible installation. You could run the In
Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs.
[Read more...](part/part) [Read more...](/part/part)
### Manage Suppliers ### Manage Suppliers
InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory. InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory.
[Read more...](buy/supplier) [Read more...](/buy/supplier)
### Instant Stock Knowledge ### Instant Stock Knowledge
Instantly view current stock for a certain part, in a particular location, or required for an individual build. Stock items are organized in cascading locations and sub-locations, allowing flexible inspection of stock under any location. Stock items can be serialized for tracking of individual items, and test results can be stored against a serialized stock item for the purpose of acceptance testing and commissioning. Instantly view current stock for a certain part, in a particular location, or required for an individual build. Stock items are organized in cascading locations and sub-locations, allowing flexible inspection of stock under any location. Stock items can be serialized for tracking of individual items, and test results can be stored against a serialized stock item for the purpose of acceptance testing and commissioning.
[Read more...](stock/stock) [Read more...](/stock/stock)
### BOM Management ### BOM Management
Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part. Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part.
InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database. InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database.
[Read more...](build/bom) [Read more...](/build/bom)
### Build Parts ### Build Parts
Inventree features a build management system to help you track the progress of your builds. Inventree features a build management system to help you track the progress of your builds.
Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory. Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory.
[Read more...](build/build) [Read more...](/build/build)
### Report ### Report
Generate a wide range of reports using custom templates. [Read more...](docs/report/report) Generate a wide range of reports using custom templates. [Read more...](/report/report)
### Extend and Customize ### Extend and Customize
InvenTree is designed to be highly extensible. If the core InvenTree functionality does not meet your particular need, InvenTree provides a RESTful API, a native Python library, and a powerful plugin system. InvenTree is designed to be highly extensible. If the core InvenTree functionality does not meet your particular need, InvenTree provides a RESTful API, a native Python library, and a powerful plugin system.
[Read more...](extend/api) [Read more...](/extend/api)
## Getting Started ## Getting Started
Refer to the [installation guide](start/install) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed. Refer to the [installation guide](/start/install) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed.

49
docs/start/install.md
View File

@ -20,31 +20,54 @@ Database selection should be determined by your particular installation requirem
### Serving Data ### 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](https://gunicorn.org/). For more information see the [deployment documentation](start/deploy). 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. 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" Installing and running InvenTree should be possible on most operating systems, as it requires only cross-platform Python libraries.
If you are using the Windows operating system, it is recommended that you use the <a href='https://docs.microsoft.com/en-us/windows/wsl/install-win10'>WSL (Windows Subsystem for Linux) framework</a>
### Requirements ### Linux
To install InvenTree you will need python3 (>3.6) installed, as well as PIP (the Python package manager). 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:
Install these required programs (e.g. using apt or similar) before running the setup scripts.
For example:
``` ```
sudo apt-get update 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" !!! 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 `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 <a href="https://docs.microsoft.com/en-us/windows/wsl/install-win10">WSL (Windows Subsystem for Linux)</a> 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 ### 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. 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.
@ -122,7 +145,7 @@ Once the required packages are installed, the database configuration must be adj
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. 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](start/config) section. For further information on installation configuration, refer to the [Configuration](/start/config) section.
!!! warning "Configure Database" !!! warning "Configure Database"
Ensure database settings are correctly configured in `config.yaml` before proceeding to the next step! Ensure database settings are correctly configured in `config.yaml` before proceeding to the next step!
@ -167,4 +190,4 @@ This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For oth
### Run Production Server ### Run Production Server
For a production install, refer to [deployment instructions](start/deploy). For a production install, refer to [deployment instructions](/start/deploy).

2
docs/start/migrate.md
View File

@ -19,7 +19,7 @@ This will export all data (including user information) to a json data file.
### Initialize New Database ### Initialize New Database
Configure the new database using the normal processes (see [Configuration](start/config)) Configure the new database using the normal processes (see [Configuration](/start/config))
Then, ensure that the database schema are correctly initialized in the new database: Then, ensure that the database schema are correctly initialized in the new database: