2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-14 11:05:41 +00:00
Files
InvenTree/docs/docs/app/settings.md
Oliver 11ab0203b1 [plugin] Auto issue orders (#9565)
* Add builtin plugin for auto-issuing orders

* Add plugin to auto-issue orders

* Add placeholder documentation

* Fix typo

* Adds image macro

- To replace img.html
- includes checking if file exists

* Fix tooltips

* More docs

* Adjust plugin settings filters

* docs

* More docs

* More docs

* Updates

* Less restrictive URL checking

* Refactor build order page

* Fix typo

* Allow 429

* Debug output

* More debug

* Construct assets dir

* Cleanup

* Update docs README

* Refactoring more pages

* Fix image link

* Fix SSO settings

* Add hook to check for missing settings

- Ensure that all settings are documented!

* Add missing user settings

* Update docstring

* Tweak SSO.md

* Image updates

* More updates

* Tweaks

* Exclude orders without a target_date

* Fix for issuing build orders

* Further refactoring

* Fixes

* Image refactoring

* More refactoring

* More refactoring

* Refactor app images

* Fix pathing issues

* Suppress some openapidocs warnings in logs

(much easier to debug docs build issues)

* Fix image reference

* Reduce error messages

* Fix image links

* Fix image links

* Reduce docs log output

* Ensure settings are loaded before displaying them

* Fix for UI test

* Fix unit test

* Test tweaks
2025-06-03 17:07:12 +10:00

3.0 KiB

title
title
App Settings

Settings

The Settings view provides access to user configurable settings, in addition to information about the app itself.

The main settings view is shown below, and provides the following options:

Option Description
Server Select server profile and configure settings
App Settings Configure app settings
Barcode Settings Configure barcode scanning settings
Home Screen Configure home screen options
Part Configure part management options
About Display app version information

{{ image("app/settings.png", "Settings view") }}

App Settings

The App Settings view provides configuration options for the InvenTree app:

{{ image("app/app_settings.png", "App settings") }}

App Settings

Option Description
Dark Mode Enable "dark mode" display for the app.
Screen Orientation Select screen orientation mode
Use Strict HTTPS Enforce strict checking of HTTPs certificates. Enabling this option may prevent you from connecting to the server if there are certificate issues.
Language Select app language. By default, will use the system language of the device the app is installed on.
Upload Error Reports Enable uploading of anonymous error / crash reports. These reports are used to improve the quality of the app.

Screen Orientation

By default, the screen orientation follows your system preference. However if desired, the screen orientation can be locked in either portrait or landscape mode.

Sounds

Configure audible app notifications:

Option Description
Server Error Play an audible tone when a server error occurs
Barcode Tones Play audible tones when scanning barcodes

Barcode Settings

The Barcode Settings view allows you to configure options relating to barcode scanning:

{{ image("app/barcode_settings.png", "Barcode settings") }}

Option Description
Scanner Input Select barcode capture mode
Barcode Scan Delay Delay between successive scans

Home Screen

The Home Screen view allows you to configure display options for the app 'home screen':

{{ image("app/home_settings.png", "Home screen settings") }}

Option Description
Subscribed Parts Show a list of subscribed parts on the home page
Show Purchase Orders Display a link to purchase orders on the home page
Show Suppliers Display a link to suppliers on the home page

Part Settings

The Part Settings view allows you to configure various options governing what part features are available:

Option Description
Parameters Enable display of part parameters in the part detail view
BOM Enable bill of materials display in the part detail view
Stock History Enable display of stock history in the stock detail view
Test Results Enable display of test results in the stock detail view