mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-06-14 11:15:31 +00:00
Merge branch 'master' of https://github.com/inventree/inventree-docs into new-plugin
This commit is contained in:
Matthias Mair
19
docs/settings/MFA.md
Normal file
19
docs/settings/MFA.md
Normal file
@ -0,0 +1,19 @@
|
||||
---
|
||||
title: InvenTree Multi Factor Authentication
|
||||
---
|
||||
|
||||
## Multi Factor Authentication
|
||||
|
||||
InvenTree gives the option to use TOTP or statically generated backup tokens as an additional factor to password or SSO authentication. This is a widely adopted security feature on enterprise web services. We highly encourage to enable it if you expose your instance to the public internet.
|
||||
|
||||
As TOTP is an [open standard](https://datatracker.ietf.org/doc/html/rfc6238) there are a lot of different ways to hold your key and generate the time based tokens needed for authentication. That ranges from physical devices to password managers and mobile apps. We do not advertise any method but recommend to keep password and token generator seperate from each other.
|
||||
|
||||
### Configuration
|
||||
|
||||
To make MFA mandatory for all users:
|
||||
|
||||
1. Enable it in the [global settings](../settings/global.md).
|
||||
|
||||
### Security Consideration
|
||||
|
||||
A user can lock themself out if they lose access to both the device with their TOTP app and their backup tokens. An admin can delete their tokens from the admin pages (they exsist under the 'TOTP devices' / 'static devices' models) . This should be a last resort and only done by people knowledgeable about the [admin pages](../settings/admin.md) as changes there might circumvent InvneTrees buisness and security logic.
|
||||
@ -17,7 +17,15 @@ Global settings are arranged in the following categories:
|
||||
|
||||
### 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
|
||||
|
||||
@ -29,6 +37,7 @@ Change how logins, password-forgot, signups are handled.
|
||||
| Enable SSO | Boolean | Enable SSO on the login-pages | False |
|
||||
| Enable password forgot | Boolean | Enable password forgot function on the login-pages.<br><br>This will let users reset their passwords on their own. For this feature to work you need to configure E-mail | True |
|
||||
| E-Mail required | Boolean | Require user to supply e-mail on signup.<br><br>Without a way (e-mail) to contact the user notifications and security features might not work! | False |
|
||||
| Enforce MFA | Boolean | Users must use multifactor security.<br><br>This forces each user to setup MFA and use it on each autentication | False |
|
||||
| Mail twice | Boolean | On signup ask users twice for their mail | False |
|
||||
| Password twice | Boolean | On signup ask users twice for their password | True |
|
||||
| Auto-fill SSO users | Boolean | Automatically fill out user-details from SSO account-data.<br><br>If this feature is enabled the user is only asked for their username, first- and surname if those values can not be gathered from their SSO profile. This might lead to unwanted usernames bleading over. | True |
|
||||
@ -37,14 +46,29 @@ Change how logins, password-forgot, signups are handled.
|
||||
|
||||
Configuration of barcode functionality
|
||||
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Barcode Support | Boolean | Enable barcode functionality in web interface | True |
|
||||
|
||||
### Currencies
|
||||
|
||||
Configuration of currency support
|
||||
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Default Currency | Currency | Default currency | USD |
|
||||
|
||||
### Reporting
|
||||
|
||||
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
|
||||
|
||||
Configuration of Part options
|
||||
@ -57,18 +81,39 @@ Configuration of Part Category 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
|
||||
|
||||
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
|
||||
|
||||
Options for purchase orders
|
||||
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Reference Prefix | String | Prefix for purchase order reference | PO |
|
||||
|
||||
### Sales orders
|
||||
|
||||
Options for sales orders
|
||||
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Reference Prefix | String | Prefix for sales order reference | SO |
|
||||
|
||||
### Plugin Settings
|
||||
|
||||
Change into what parts plugins can integrate into.
|
||||
@ -78,4 +123,4 @@ Change into what parts plugins can integrate into.
|
||||
| Enable URL integration | Boolean | Enable plugins to add URL routes | False |
|
||||
| Enable navigation integration | Boolean | Enable plugins to integrate into navigation | False |
|
||||
| Enable setting integration | Boolean | Enable plugins to integrate into inventree settings | False |
|
||||
| Enable app integration | Boolean | Enable plugins to add apps | False |
|
||||
| Enable app integration | Boolean | Enable plugins to add apps | False |
|
||||
|
||||
@ -10,24 +10,41 @@ User settings are arranged in the following categories:
|
||||
|
||||
### Account
|
||||
|
||||
User account configuration
|
||||
User account configuration, including:
|
||||
|
||||
- Account management
|
||||
- Session management
|
||||
- Authentication options
|
||||
- Theme selection
|
||||
- Language selection
|
||||
|
||||
### Home Page
|
||||
|
||||
Customize display of items on the InvenTree home page
|
||||
|
||||
|
||||
### Search
|
||||
|
||||
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
|
||||
|
||||
Settings for label printing
|
||||
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Inline Label Display | Boolean | Display PDF labels in the browser | True |
|
||||
|
||||
### Reports
|
||||
|
||||
Settings for report generation
|
||||
|
||||
### Forms
|
||||
|
||||
Customize behavior of modal forms
|
||||
| Setting | Type | Description | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| Inline Report Display | Boolean | Display PDF reports in the browser | False |
|
||||
|
||||
Reference in New Issue
Block a user