Skip to content

Plugins

Disclaimer

Plugins are created and maintained by the community and are not associated with the stashapp team.

Plugins add features that Stash does not provide by default.

Managing plugins

Plugins can be installed and managed from the Settings > Plugins page.

Plugins are installed using the Available Plugins section. The Community (stable) source is configured by default.

Installed plugins can be updated or uninstalled from the Installed Plugins section.

Adding sources

To add a new source go to Settings > Plugins page and under Available Plugins click Add Source.

Installing plugins manually

By default Stash reads plugin configuration files from the plugins sub-directory located where the stash config.yml is read. Typical locations:

  • Windows: %USERPROFILE%\.stash\plugins
  • Unix: /root/.stash/plugins
  • Or: current working directory (cwd)

Plugins are added by adding configuration YAML files (format: pluginName.yml) to the plugins directory.

Loaded plugins can be viewed in the Settings > Plugins page. After plugins are added, removed or edited while Stash is running, they can be reloaded by clicking Reload plugins button.

Plugin sources

Stash comes preconfigured with stashapp/CommunityScripts source maintained by stashapp community.