Merge branch 'master' of https://github.com/inventree/inventree-docs

_includes/config.yaml

@@ -107,13 +107,6 @@ static_root: '../inventree_static'
 # If unspecified, the local user's temp directory will be used
 #backup_dir: '/home/inventree/backup/'
 
-# Sentry.io integration
-# If you have a sentry.io account, it can be used to log server errors
-# Ensure sentry_sdk is installed by running 'pip install sentry-sdk'
-sentry:
-  enabled: False
-  # dsn: add-your-sentry-dsn-here
-
 # LaTeX report rendering
 # InvenTree uses the django-tex plugin to enable LaTeX report rendering
 # Ref: https://pypi.org/project/django-tex/

docs/admin/permissions.md

@@ -26,8 +26,10 @@ A *role* is a set of distinct permissions linked to a given subset of InvenTree
 InvenTree functionality is split into a number of distinct roles. A group will have a set of permissions assigned to each of the following roles:
 
 - **Admin** - The *admin* role is related to assigning user permissions.
+- **Part Category** - The *part category* role is related to accessing Part Category data
 - **Part** - The *part* role is related to accessing Part data
-- **Stock** - The *stock* role is related to accessing Stock data
+- **Stock Location** - The *stock location* role is related to accessing Stock Location data
+- **Stock Item** - The *stock item* role is related to accessing Stock Item data
 - **Build** - The *build* role is related to accessing Build Order and Bill of Materials data
 - **Purchase** - The *purchase* role is related to accessing Purchase Order data
 - **Sales** - The *sales* role is related to accessing Sales Order data

docs/releases/0.1.5.md

@@ -4,10 +4,7 @@ title: v0.1.5
 
 ## Release 0.1.5
 
-!!! info "Development Version"
-    v0.1.5 is currently in development and has not yet been released
-
-[Release 0.1.5](https://github.com/inventree/InvenTree/releases/tag/0.1.5) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes:
+[Release 0.1.5](https://github.com/inventree/InvenTree/releases/tag/0.1.5) (January 2021) provides a number of major new features and improvements, as well as some crucial bug fixes:
 
 ## New Features
 
@@ -29,6 +26,11 @@ Refer to the [build documentation](../../build/build/#overdue-builds) for more i
 
 [#1202](https://github.com/inventree/InvenTree/pull/1202) introduces the concept of an *Expiry Date* for Stock Items. For further information, refer to the [expiry documentation](../../stock/expiry).
 
+### Stock Ownership
+
+[#1155](https://github.com/inventree/InvenTree/pull/1155) adds ownership to stock locations and items. Ownership allows control over which user group or individual user can edit and manage specific stock locations and items.
+For further information, refer to the [ownership documentation](../../stock/owner).
+
 ### Calendar Views
 
 [#1208](https://github.com/inventree/InvenTree/pull/1208) adds interactive calendar displays to assist with order scheduling. Calendar displays are available for:
@@ -41,6 +43,10 @@ Refer to the [build documentation](../../build/build/#overdue-builds) for more i
 
 [#1212](https://github.com/inventree/InvenTree/pull/1212) significantly improves the existing label printing functionality. Documentation for the new label printing system [can be found here](../../report/labels).
 
+### Improved Report Printing
+
+[#1242](https://github.com/inventree/InvenTree/pull/1242) significantly improves the existing report printing functionality, allowing multiple reports to be generated into a single PDF.
+
 ### Improved Permission System
 
 [#1221](https://github.com/inventree/InvenTree/pull/1221) adds new permission roles as follows:
@@ -48,7 +54,6 @@ Refer to the [build documentation](../../build/build/#overdue-builds) for more i
 - **Part** role split into *Part* and *Part Category* roles
 - **Stock** role spit into *Stock Item* and *Stock Location* roles 
 
-
 ## Major Bug Fixes
 
 | PR | Description |

docs/releases/new.md

@@ -8,5 +8,6 @@ For information on the latest and greatest InvenTree features, refer to the rele
 
 | Release | Date |
 | ------- | ---- |
+| [0.1.5](../0.1.5) | January 2021 |
 | [0.1.4](../0.1.4) | November 2020 |
 

docs/start/config.md

@@ -21,12 +21,65 @@ The default configuration file launches a *DEBUG* configuration with a simple SQ
 {% include 'config.yaml' %}
 ```
 
+### Environment Variables
+
+In addition to specifying InvenTree options via the `config.yaml` file, these options can also be specified via environment variables. This can be usful for system administrators who want the flexibility of altering settings without editing the configuration file.
+
+- Environment variable settings use the `INVENTREE_` prefix, and are all uppercase.
+- Config file settings do not use this prefix, and are all lowercase
+
+!!! info Priotity
+    Configuration options set via environment variables will take priority over the values set in the `config.yaml` file.
+
+!!! warning Available Variables
+    Some configuration options cannot be set via environment variables. Refer to the documentation below.
+
+### Basic Options
+
+The following basic options are available:
+
+| Environment Variable | Settings File | Description |
+| --- | --- | --- |
+| INVENTREE_DEBUG | debug | Enable debug mode |
+| INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal |
+
+### Secret Key
+
+InvenTree requires a secret key for providing cryptographic signing - this should be a secret (and unpredictable) value.
+
+The secret key can be provided in multiple ways, with the following (descending) priorities:
+
+**Pass Secret Key via Environment Variable**
+
+A secret key string can be passed directly using the environment variable `INVENTREE_SECRET_KEY`
+
+**Pass Secret Key File via Environment Variable**
+
+A file containing the secret key can be passed via the environment variable `INVENTREE_SECRET_KEY_FILE`
+
+**Fallback to Default Secret Key File**
+
+If not specified via environment variables, the fallback secret_key file (automatically generated as part of InvenTree installation) will be used.
+
 ### Database Options
 
 InvenTree provides support for multiple database backends - any backend supported natively by Django can be used. 
 
 Database options are specified under the *database* heading in the configuration file. Any option available in the Django documentation can be used here - it is passed through transparently to the management scripts.
 
+The following database options can be configured:
+
+| Environment Variable | Settings File | Description |
+| --- | --- | --- |
+| INVENTREE_DB_ENGINE | database.ENGINE | Database backend |
+| INVENTREE_DB_NAME | database.NAME | Database name |
+| INVENTREE_DB_USER | database.USER | Database username (if required) |
+| INVENTREE_DB_PASSWORD | database.PASSWORD | Database password (if required) |
+| INVENTREE_DB_HOST | database.HOST | Database host address (if required) |
+| INVENTREE_DB_PORT | database.PORT | Database host port (if required) |
+
+Instructions for particular database backends are provided below:
+
 #### SQLite
 By default, InvenTree uses an sqlite database file : `inventree_db.sqlite3`. This provides a simple, portable database file that is easy to use for debug and testing purposes. 
 
@@ -79,19 +132,21 @@ For further information, refer to the following documentation:
 
 ### Static File Storage
 
-By default, static files are stored in the local directory `./inventree_media`. This directory should be changed in the config file based on the particular installation requirements.
+By default, static files are stored in the local directory `./inventree_media`. This directory should be changed by specifying the `static_root` option in the config file based on the particular installation requirements.
+
+Alternatively this location can be specified with the `INVENTREE_STATIC_ROOT` environment variable.
 
 ### Uploaded File Storage
 
-By default, uploaded media files are stored in the local directory `./inventree_media`. This directory should be changed in the config file based on the particular installation requirements.
+By default, uploaded media files are stored in the local directory `./inventree_media`. This directory should be changed by specifying the `media_root` option in the config file based on the particular installation requirements.
+
+Alternatively this location can be specified with the `INVENTREE_MEDIA_ROOT` environment variable.
 
 ### Backup Location
 
-The default behaviour of the database backup is to generate backup files for database tables and media files to the user's temporary directory. The target directory can be overridden by setting the *backup_dir* parameter in the config file.
+The default behaviour of the database backup is to generate backup files for database tables and media files to the user's temporary directory. The target directory can be overridden by setting the `backup_dir` parameter in the config file.
 
-### Sentry.io Integration
-
-InvenTree supports [sentry.io](https://sentry.io) integration using the native django/sentry bindings. If you have a sentry.io account, create a new dsn and provide this in the `config.yaml` file.
+Alternatively this location can be specified with the `INVENTREE_BACKUP_DIR` environment variable.
 
 ### LaTeX Support
 

docs/start/install.md

@@ -70,6 +70,9 @@ pkg install py37-invoke
 
 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.
@@ -84,7 +87,7 @@ python3 -m venv inventree-env
 source inventree-env/bin/activate
 ```
 
-??? note "Virtual Environment on Windows"
+!!! note "Virtual Environment on Windows"
 	To create and activate a virtual environment in Windows, run the following commands:
 	```
 	py -m venv inventree-env

docs/stock/expiry.md

@@ -13,7 +13,7 @@ The stock expiry feature is disabled by default, and must be enabled via the set
 {% endwith %}
 
 !!! info "Non Expiring Stock"
-    If a Stock Item is not expected to expire, 
+    If a Stock Item is not expected to expire, leave the expiry date field blank, or zero
 
 ### Add Expiry Date
 

docs/stock/owner.md

@@ -0,0 +1,63 @@
+---
+title: Stock Ownership
+---
+
+## Stock Ownership
+
+InvenTree supports stock ownership, which allows to set groups and users as "owners" of stock locations and items. The owners would be the only users who can edit and manage those stock locations and items.
+
+The stock ownership feature is disabled by default, and must be enabled via the settings menu:
+
+{% with id="stock_owner", url="stock/enable_stock_owner.png", description="Enable stock ownership feature" %}
+{% include 'img.html' %}
+{% endwith %}
+
+!!! warning "Existing Stock Locations and Items"
+	Enabling the ownership feature will automatically remove the edit permissions to all users for stock locations and items which **do not have** any owner set. Only a user with admin permissions will be able to set the owner for those locations and items.
+
+### Owner: Group vs User
+
+There are two types of owners in InvenTree: [groups](../../admin/permissions/#group) and [users](../../admin/permissions/#user).
+
+* If a group is selected as owner, **all** users linked to the specified group will be able to edit the stock location or item.
+* If a user is selected as owner, only the specified user will be able to edit the stock location or item.
+
+When selecting an owner, in the drop-down list, groups are annotated with the `(group)` tag and users are annotated with the `(user)` tag:
+
+{% with id="stock_owner_type", url="stock/stock_owner_type.png", description="Display stock owner type" %}
+{% include 'img.html' %}
+{% endwith %}
+
+### Set Stock Location Owner
+
+To specify the owner of a stock location, navigate to the stock location detail page. Click on the <span class='fas fa-sitemap'></span> icon under the location's name then click on "Edit Location".
+
+!!! warning
+	If you cannot see the <span class='fas fa-sitemap'></span> icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation](../../admin/permissions/#roles) and/or contact your InvenTree administrator.
+
+In the "Edit Stock Location" form, select the owner and click the "Submit" button:
+
+{% with id="stock_location_owner", url="stock/stock_location_owner.png", description="Set stock location owner" %}
+{% include 'img.html' %}
+{% endwith %}
+
+Setting the owner of stock location will automatically:
+
+* Set the owner of all children locations to the same owner.
+* Set the owner of all stock items at this location to the same owner.
+
+!!! note
+	If the owner of a children location or a stock item is a subset of the specified owner (eg. a user linked to the specified group), the owner won't be updated.
+
+### Set Stock Item Owner
+
+To specify the owner of a stock item, navigate to the stock item detail page. Click on the <span class='fas fa-tools'></span> icon under the item's name then click on "Edit stock item".
+
+!!! warning
+	If you cannot see the <span class='fas fa-tools'></span> icon, it means that you do **not** have permissions to edit stock items. Refer to [the permissions documentation](../../admin/permissions/#roles) and/or contact your InvenTree administrator.
+
+In the "Edit Stock Item" form, select the owner and click the "Save" button:
+
+{% with id="stock_item_owner", url="stock/stock_item_owner.png", description="Set stock item owner" %}
+{% include 'img.html' %}
+{% endwith %}

mkdocs.yml

@@ -58,6 +58,7 @@ nav:
     - Adjusting Stock: stock/adjust.md
     - Stocktake: stock/stocktake.md
     - Stock Expiry: stock/expiry.md
+    - Stock Ownership: stock/owner.md
     - Test Results: stock/test.md
   - Build:
     - Build Parts: build/build.md