mirror of
https://github.com/inventree/InvenTree.git
synced 2026-07-05 06:32:55 +00:00
Docs refactor (#9545)
* Refactor / reognaize docs structure * Refactor plugin docs structure * More refactoring / cleanup * Update build images * Gallery updates * Order images * Update part docs * Settings images * Stock images * Reitntroduce gallery * Add custom icon macro * Update icons * Cleanup * Fix link * Fix internal links * Revert some page moves * Fix links * Fix links
This commit is contained in:
Oliver
GitHub
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: Companies
|
||||
---
|
||||
|
||||
|
||||
## Companies
|
||||
|
||||
External companies are represented by the *Company* database model. Each company may be classified into the following categories:
|
||||
|
||||
- [Customer](../sales/customer.md)
|
||||
- [Supplier](../purchasing/supplier.md)
|
||||
- [Manufacturer](../purchasing/manufacturer.md)
|
||||
|
||||
!!! tip "Multi Purpose"
|
||||
A company may be allocated to multiple categories, for example, a company may be both a supplier and a customer.
|
||||
|
||||
### Edit Company
|
||||
|
||||
To edit a company, click on the {{ icon("edit", color="blue", title="Edit Company") }} icon in the actions menu. Edit the company information, and then click on <span class='badge inventree confirm'>Submit</span>.
|
||||
|
||||
!!! warning "Permission Required"
|
||||
The edit button will not be available to users who do not have the required permissions to edit the company
|
||||
|
||||
### Disable Company
|
||||
|
||||
Rather than deleting a company, it is possible to disable it. This will prevent the company from being used in new orders, but will not remove it from the database. Additionally, any existing orders associated with the company (and other linked items such as supplier parts, for a supplier) will remain intact. Unless the company is re-enabled, it will not be available for selection in new orders.
|
||||
|
||||
It is recommended to disable a company rather than deleting it, as this will preserve the integrity of historical data.
|
||||
|
||||
To disable a company, simply edit the company details and set the `active` attribute to `False`:
|
||||
|
||||
{% with id="company_disable", url="order/company_disable.png", description="Disable Company" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
To re-enable a company, simply follow the same process and set the `active` attribute to `True`.
|
||||
|
||||
### Delete Company
|
||||
|
||||
To delete a company, click on the {{ icon("trash", color="red", title="Delete") }} icon under the actions menu. Confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>
|
||||
|
||||
!!! warning "Permission Required"
|
||||
The edit button will not be available to users who do not have the required permissions to delete the company
|
||||
|
||||
!!! danger "Take Care"
|
||||
Deleting a company instance will also remove any orders or supplied parts associated with that company!
|
||||
|
||||
### Contacts
|
||||
|
||||
Each company can have multiple assigned *Contacts*. A contact identifies an individual who is associated with the company, including information such as name, email address, phone number, etc.
|
||||
|
||||
The list of contacts associated with a particular company is available in the <span class='badge inventree nav main'>{{ icon("users") }} Contacts</span> navigation tab:
|
||||
|
||||
{% with id="contact_list", url="order/contact_list.png", description="Contact List" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
A *contact* can be assigned to orders, (such as [purchase orders](../purchasing/purchase_order.md) or [sales orders](../sales/sales_order.md)).
|
||||
|
||||
### Addresses
|
||||
|
||||
A company can have multiple registered addresses for use with all types of orders.
|
||||
An address is broken down to internationally recognised elements that are designed to allow for formatting an address according to user needs.
|
||||
Addresses are composed differently across the world, and InvenTree reflects this by splitting addresses into components:
|
||||
- Line 1: Main street address
|
||||
- Line 2: Extra street address line
|
||||
- Postal Code: Also known as ZIP code, this is normally a number 3-5 digits in length
|
||||
- City: The city/region tied to the postal code
|
||||
- Province: The larger region the address is located in. Also known as State in the US
|
||||
- Country: Country the address is located in, written in CAPS
|
||||
|
||||
Here are a couple of examples of how the address structure differs by country, but these components can construct a correctly formatted address for any given country.
|
||||
|
||||
UK address format:
|
||||
Recipient
|
||||
Line 1
|
||||
Line 2
|
||||
City
|
||||
Postal Code
|
||||
Country
|
||||
|
||||
US Address Format:
|
||||
Recipient
|
||||
Line 1
|
||||
Line 2
|
||||
City State Postal Code
|
||||
Country
|
||||
|
||||
|
||||
Addresses can be accessed by the <span class='badge inventree nav main'>{{ icon("map-2") }} Addresses</span> navigation tab.
|
||||
|
||||
#### Primary Address
|
||||
|
||||
Each company can have exactly one (1) primary address.
|
||||
This address is the default shown on the company profile, and the one that is automatically suggested when creating an order.
|
||||
Marking a new address as primary will remove the mark from the old primary address.
|
||||
@@ -50,11 +50,11 @@ While InvenTree can support any of the currencies defined in the ISO 3166 standa
|
||||
|
||||
### Exchange Rate Data
|
||||
|
||||
The exchange rate data is provided by a [currency plugin](../extend/plugins/currency.md) which fetches exchange rate data from an external source.
|
||||
The exchange rate data is provided by a [currency plugin](../plugins/mixins/currency.md) which fetches exchange rate data from an external source.
|
||||
|
||||
InvenTree includes a default currency plugin which fetches exchange rate data from the [frankfurter](https://frankfurter.dev/) API, which is an open source currency API made freely available.
|
||||
|
||||
However, the user can configure a custom currency plugin to fetch exchange rate data from a different source. If a different currency exchange backend is needed, or a custom implementation is desired, the currency exchange framework can be extended [via plugins](../extend/plugins/currency.md). Plugins which implement custom currency exchange frameworks can be easily integrated into the InvenTree framework.
|
||||
However, the user can configure a custom currency plugin to fetch exchange rate data from a different source. If a different currency exchange backend is needed, or a custom implementation is desired, the currency exchange framework can be extended [via plugins](../plugins/mixins/currency.md). Plugins which implement custom currency exchange frameworks can be easily integrated into the InvenTree framework.
|
||||
|
||||
### Exchange Rate Updates
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Project Codes
|
||||
---
|
||||
|
||||
## Project Codes
|
||||
|
||||
A project code is a unique identifier assigned to a specific project, which helps in tracking and organizing project-related activities and resources. It enables easy retrieval of project-related data and facilitates project management and reporting.
|
||||
|
||||
Individual orders (such as [Purchase Orders](../purchasing/purchase_order.md) or [Sales Orders](../sales/sales_order.md)) can be assigned a *Project Code* to allocate the order against a particular internal project.
|
||||
|
||||
### Managing Project Codes
|
||||
|
||||
Management of project codes (such as creating or editing codes) is accessed via the [settings page](../settings/global.md). Select the *Project Codes* tab to access project code configuration options:
|
||||
|
||||
{% with id="project_codes", url="settings/project_codes.png", description="Project Codes List" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Enable Project Code Support
|
||||
|
||||
By default, project code support is disabled. Select the *Enable Project Codes* option to enable support for this feature
|
||||
|
||||
## Assigning Project Codes
|
||||
|
||||
Project codes can be assigned to an order when the order is created, or at any later stage by simply editing the order. If project code support is enabled, a *Project Code* field is available in the order details form:
|
||||
|
||||
{% with id="assign_project_code", url="order/assign_project_code.png", description="Assign Project Code" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
## Filtering by Project Codes
|
||||
|
||||
The order tables can be easily filtered or sorted by project code:
|
||||
|
||||
{% with id="filter-by-project", url="order/filter_by_project.png", description="Filter by Project Code" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
@@ -1,7 +1,12 @@
|
||||
---
|
||||
title: Threat Model
|
||||
---
|
||||
|
||||
## Thread Model
|
||||
|
||||
Deploying InvenTree to production requires to knowledge of the security assumptions and threat model of the underlying system. This document outlines the security assumptions and threat model of InvenTree as a software. It is assumed that the system that InvenTree is deployed on top of is configured following best practices and is trusted.
|
||||
|
||||
## Assumed trust
|
||||
## Assumed Trust
|
||||
|
||||
1. The InvenTree server is only available to trusted networks and there are detection mechanisms in place to detect unauthorised access.
|
||||
|
||||
@@ -21,7 +26,7 @@ Deploying InvenTree to production requires to knowledge of the security assumpti
|
||||
4. Plugins can access the inventree database and all data in the database
|
||||
5. Plugins can access all environment variables that are accessible to the server and worker processes
|
||||
|
||||
## Possible attack vectors
|
||||
## Possible Attack Vectors
|
||||
|
||||
1. Malicious plugins or templates can overwrite or delete files on the server, bypass security checks, or leak sensitive information.
|
||||
2. Token phishing attacks can be used to impersonate users. Tokens are not scoped to specific IPs or devices. Limit their usage and use lowest possible user permissions.
|
||||
@@ -31,4 +36,4 @@ There are various checks to gate against common attack vectors but above vectors
|
||||
|
||||
## Secure Development Cycle
|
||||
|
||||
The InvenTree project is developed following best practices. Read more in the [project security guide](../project/security.md).
|
||||
The InvenTree project is developed following best practices. Read more in the [project security guide](../security.md).
|
||||
|
||||
@@ -53,11 +53,11 @@ Physical units are supported by the following InvenTree subsystems:
|
||||
|
||||
### Part
|
||||
|
||||
The [unit of measure](../part/part.md#units-of-measure) field for the [Part](../part/part.md) model uses real-world units.
|
||||
The [unit of measure](../part/index.md#units-of-measure) field for the [Part](../part/index.md) model uses real-world units.
|
||||
|
||||
### Supplier Part
|
||||
|
||||
The [supplier part](../part/part.md/#supplier-parts) model uses real-world units to convert between supplier part quantities and internal stock quantities. Unit conversion rules ensure that only compatible unit types can be supplied
|
||||
The [supplier part](../part/index.md/#supplier-parts) model uses real-world units to convert between supplier part quantities and internal stock quantities. Unit conversion rules ensure that only compatible unit types can be supplied
|
||||
|
||||
### Part Parameter
|
||||
|
||||
|
||||
Reference in New Issue
Block a user