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

Add documentation for global settings and user settings

Browse Source
This commit is contained in:
Oliver 2022-01-08 15:29:35 +11:00
parent 455dbf5250
commit 64e4b9f214
2 changed files with 68 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/settings/global.md
View File

@ -17,7 +17,15 @@ Global settings are arranged in the following categories:
### Server Settings ### Server Settings
Configuration of basic server settings Configuration of basic server settings.
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| InvenTree Instance Name | String | String descriptor for the InvenTree server instance | InvenTree Server |
| Use Instance Name | Boolean | Use instance name in title bars | False |
| Base URL | String | Base URL for server instance | *blank* |
| Company Name | String | Company name | My compant name |
| Download from URL | Boolean | Allow downloading of images from remote URLs | False |
### Login Settings ### Login Settings
@ -38,14 +46,29 @@ Change how logins, password-forgot, signups are handled.
Configuration of barcode functionality Configuration of barcode functionality
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Barcode Support | Boolean | Enable barcode functionality in web interface | True |
### Currencies ### Currencies
Configuration of currency support Configuration of currency support
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Default Currency | Currency | Default currency | USD |
### Reporting ### Reporting
Configuration of report generation Configuration of report generation
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Enable Reports | Boolean | Enable report generation | False |
| Page Size | String | Default page size | A4 |
| Debug Mode | Boolean | Generate reports in debug mode (HTML output) | False |
| Test Reports | Boolean | Enable generation of test reports | False |
### Parts ### Parts
Configuration of Part options Configuration of Part options
@ -58,14 +81,36 @@ Configuration of Part Category options
Configuration of Stock Item options Configuration of Stock Item options
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Stock Expiry | Boolean | Enable stock expiry functionality | False |
| Stock Stale Time | Days | Number of days stock items are considered stale before expiring | 90 |
| Sell Expired Stock | Boolean | Allow sale of expired stock | False |
| Build Expired Stock | Boolean | Allow building with expired stock | False |
| Stock Ownership Control | Boolean | Enable ownership control functionality | False |
### Build Orders ### Build Orders
Options for build orders Options for build orders
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Reference Prefix | String | Prefix for build order reference | BO |
| Reference Regex | String | Regular expression pattern for build order reference | *blank* |
### Purchase Orders ### Purchase Orders
Options for purchase orders Options for purchase orders
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Reference Prefix | String | Prefix for purchase order reference | PO |
### Sales orders ### Sales orders
Options for sales orders Options for sales orders
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Reference Prefix | String | Prefix for sales order reference | SO |

25
docs/settings/user.md
View File

@ -10,24 +10,41 @@ User settings are arranged in the following categories:
### Account ### Account
User account configuration User account configuration, including:
- Account management
- Session management
- Authentication options
- Theme selection
- Language selection
### Home Page ### Home Page
Customize display of items on the InvenTree home page Customize display of items on the InvenTree home page
### Search ### Search
Customize settings for search results Customize settings for search results
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Search Preview Results | Integer | Number of results to show in search preview window | 10 |
| Search Show Stock | Boolean | Display stock levels in part search results | True |
| Hide Inactive Parts | Boolean | Hide inactive parts in search preview | False |
### Labels ### Labels
Settings for label printing Settings for label printing
| Setting | Type | Description | Default |
| --- | --- | --- | --- |
| Inline Label Display | Boolean | Display PDF labels in the browser | True |
### Reports ### Reports
Settings for report generation Settings for report generation
### Forms | Setting | Type | Description | Default |
| --- | --- | --- | --- |
Customize behavior of modal forms | Inline Report Display | Boolean | Display PDF reports in the browser | False |