From 9235c46b9e510b8f8e9c69b684c28c67ff71258c Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 11 Jan 2022 14:13:41 +1100 Subject: [PATCH] Enable plugins for CI testing --- _includes/config.yaml | 9 +++++---- docs/extend/plugins.md | 9 +++++++-- docs/start/config.md | 1 + 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/_includes/config.yaml b/_includes/config.yaml index 3472a37..d8f780b 100644 --- a/_includes/config.yaml +++ b/_includes/config.yaml @@ -14,18 +14,15 @@ database: # --- Available options: --- # ENGINE: Database engine. Selection from: - # - sqlite3 # - mysql # - postgresql + # - sqlite3 # NAME: Database name # USER: Database username (if required) # PASSWORD: Database password (if required) # HOST: Database host address (if required) # PORT: Database host port (if required) - # --- Example Configuration - sqlite3 --- - # ENGINE: sqlite3 - # NAME: '/home/inventree/database.sqlite3' # --- Example Configuration - MySQL --- #ENGINE: mysql @@ -42,6 +39,10 @@ database: #PASSWORD: inventree_password #HOST: 'localhost' #PORT: '5432' + + # --- Example Configuration - sqlite3 --- + # ENGINE: sqlite3 + # NAME: '/home/inventree/database.sqlite3' # Select default system language (default is 'en-us') language: en-us diff --git a/docs/extend/plugins.md b/docs/extend/plugins.md index 63588be..eff912b 100644 --- a/docs/extend/plugins.md +++ b/docs/extend/plugins.md @@ -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. -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 added from multiple sources: +- 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. +!!! info "Enable Plugin Support" + To enable custom plugins, plugin support must be activated in the [server configuration](../start/config.md). + Multiple plugins are supported: - [Reporting plugins](./plugins/report.md) diff --git a/docs/start/config.md b/docs/start/config.md index dc9f0ee..b0a6557 100644 --- a/docs/start/config.md +++ b/docs/start/config.md @@ -46,6 +46,7 @@ The following basic options are available: | --- | --- | --- | --- | | INVENTREE_DEBUG | debug | Enable debug mode | True | | INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal | WARNING | +| INVENTREE_PLUGINS_ENABLED | plugins_enabled | Enable plugin support | False | ## Secret Key