Mirrors/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-17 04:14:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document "# requires" in the plugin config

Browse Source
This commit is contained in:
DogmaDragon
2025-11-22 23:19:18 +02:00
parent 58b6833380
commit 19d6f5543d
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
ui/v2.5/src/docs/en/Manual/Plugins.md
View File

@@ -65,8 +65,11 @@ Plugins provide tasks which can be run from the Tasks page.
The basic structure of a plugin configuration file is as follows: The basic structure of a plugin configuration file is as follows:
``` ```yaml
name: <plugin name> name: <plugin name>
# optional list of dependancies to be included
# "#" is is part of the config - do not remove
# requires: <plugin ID>
description: <optional description of the plugin> description: <optional description of the plugin>
version: <optional version tag> version: <optional version tag>
url: <optional url> url: <optional url>
@@ -121,6 +124,8 @@ tasks:
The `name`, `description`, `version` and `url` fields are displayed on the plugins page. The `name`, `description`, `version` and `url` fields are displayed on the plugins page.
`# requires` will make the plugin manager select plugins matching the specified IDs to be automatically installed as dependencies. Only works with plugins within the same index.
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. 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.