Backup_Repos/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-07 08:54:10 +01:00
Code Issues Projects Releases Wiki Activity

Document plugin settings

Browse source
This commit is contained in:
WithoutPants 2024-02-28 11:07:31 +11:00
parent 33857122b8
commit 2e00cb6c5a
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ui/v2.5/src/docs/en/Manual/Plugins.md
View file

@ -99,6 +99,16 @@ ui:
connect-src: connect-src:
- http://alloweddomain.com - http://alloweddomain.com
# map of setting names to be displayed in the plugins page in the UI
settings:
# internal name
foo:
# name to display in the UI
displayName: Foo
# type of the attribute to show in the UI
# can be BOOLEAN, NUMBER, or STRING
type: BOOLEAN
# the following are used for plugin tasks only # the following are used for plugin tasks only
exec: exec:
- ... - ...
@ -112,6 +122,8 @@ The `name`, `description`, `version` and `url` fields are displayed on the plugi
The `exec`, `interface`, `errLog` and `tasks` fields are used only for plugins with tasks. The `exec`, `interface`, `errLog` and `tasks` fields are used only for plugins with tasks.
The `settings` field is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutation `configurePlugin` - the settings set this way do _not_ need to be specified in the `settings` field unless they are to be displayed in the stock plugin settings UI.
## UI Configuration ## UI Configuration
The `css` and `javascript` field values may be relative paths to the plugin configuration file, or The `css` and `javascript` field values may be relative paths to the plugin configuration file, or