inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-09-13 22:21:33 +00:00
Code Activity

Plugin external dir (#322)

Browse Source 
* Additional information on plugin configuration options

* Better information on plugin installation

* Update label printing docs

* Rearrange plugin menu

* More menu tweaks

* Fix links to app images
This commit is contained in:
Oliver
2022-07-23 22:40:05 +10:00
committed by GitHub
parent 2e99477478
commit 3def121be2
6 changed files with 81 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/extend/plugins.md
View File

@@ -104,25 +104,3 @@ Supported mixin classes are:
- [ScheduleMixin](./plugins/schedule.md)
- [SettingsMixin](./plugins/settings.md)
- [UrlsMixin](./plugins/urls.md)
## Installing a Plugin
Plugins can either be loaded from paths in the InvenTree install directory or as a plugin installed via pip. We recommend installation via pip as this enables hassle-free upgrades.
### Builtin Plugins
Built-In plugins ship in `src/InvenTree/plugin/builtin`. To achive full unit-testing for all mixins there are some sample implementations in `src/InvenTree/plugin/samples`. These are not loaded in production mode.
### Local Directory
Custom plugins can be placed in the `src/InvenTree/plugins/` directory, where they will be automatically discovered. This can be useful for developing and testing plugins, but can prove more difficult in production (e.g. when using Docker).
### Plugin Installation File (PIP)
Plugins installation can be simplified by providing a list of plugins in a plugin configuration file. This file (by default, 'plugins.txt' in the same directory as the server configuration file) contains a list of required plugin packages.
Plugins can be then installed from this file by simply running the command `invoke plugins`.
!!! success "Auto Update"
When the server installation is updated via the `invoke update` command, the plugins (as specified in *plugins.txt*) will also be updated automatically.