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

Merge pull request #227 from inventree/plugins-enable

Browse Source 
Document "plugin enable" setting
This commit is contained in:
Oliver 2022-01-11 14:23:44 +11:00 committed by GitHub
commit 3a7d45fb13
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
_includes/config.yaml
View File

@ -14,18 +14,15 @@ database:
# --- Available options: --- # --- Available options: ---
# ENGINE: Database engine. Selection from: # ENGINE: Database engine. Selection from:
# - sqlite3
# - mysql # - mysql
# - postgresql # - postgresql
# - sqlite3
# NAME: Database name # NAME: Database name
# USER: Database username (if required) # USER: Database username (if required)
# PASSWORD: Database password (if required) # PASSWORD: Database password (if required)
# HOST: Database host address (if required) # HOST: Database host address (if required)
# PORT: Database host port (if required) # PORT: Database host port (if required)
# --- Example Configuration - sqlite3 ---
# ENGINE: sqlite3
# NAME: '/home/inventree/database.sqlite3'
# --- Example Configuration - MySQL --- # --- Example Configuration - MySQL ---
#ENGINE: mysql #ENGINE: mysql
@ -43,6 +40,10 @@ database:
#HOST: 'localhost' #HOST: 'localhost'
#PORT: '5432' #PORT: '5432'
# --- Example Configuration - sqlite3 ---
# ENGINE: sqlite3
# NAME: '/home/inventree/database.sqlite3'
# Select default system language (default is 'en-us') # Select default system language (default is 'en-us')
language: en-us language: en-us

9
docs/extend/plugins.md
View File

@ -6,11 +6,16 @@ title: Plugins
The InvenTree server code supports an extensible plugin architecture, allowing custom plugins to be integrated directly into the database server. This allows development of complex behaviours which are decoupled from core InvenTree code. The InvenTree server code supports an extensible plugin architecture, allowing custom plugins to be integrated directly into the database server. This allows development of complex behaviours which are decoupled from core InvenTree code.
InvenTree built-in plugins are located in the directory `./InvenTree/plugin/builtin`. Plugins can be added from multiple sources:
Custom plugins should be placed in the directory `./InvenTree/plugins`. - InvenTree built-in plugins are located in the directory `./InvenTree/plugin/builtin`.
- Custom plugins should be placed in the directory `./InvenTree/plugins`.
- Plugins can be installed via PIP (python package manager)
Plugins are discovered and loaded when the server is started. Plugins are discovered and loaded when the server is started.
!!! info "Enable Plugin Support"
To enable custom plugins, plugin support must be activated in the [server configuration](../start/config.md).
Multiple plugins are supported: Multiple plugins are supported:
- [Reporting plugins](./plugins/report.md) - [Reporting plugins](./plugins/report.md)

1
docs/start/config.md
View File

@ -46,6 +46,7 @@ The following basic options are available:
| --- | --- | --- | --- | | --- | --- | --- | --- |
| INVENTREE_DEBUG | debug | Enable debug mode | True | | INVENTREE_DEBUG | debug | Enable debug mode | True |
| INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal | WARNING | | INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal | WARNING |
| INVENTREE_PLUGINS_ENABLED | plugins_enabled | Enable plugin support | False |
## Secret Key ## Secret Key