Skip to content

Commit

Permalink
Add hint to using CLI to install plugins (#2569)
Browse files Browse the repository at this point in the history
* Add hint to using CLI to install plugins

* database list -> plugins list

* move plugin install doc
  • Loading branch information
caioaao authored Oct 3, 2022
1 parent dde4ce7 commit 0e78509
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
18 changes: 17 additions & 1 deletion docs/admin-guide/administration/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ The `plugin` command contains all of the logic for dealing with Dispatch's plugi
The `list` command lists all currently available plugins. This command is useful in determining which plugins are available to be used via configuration variables.

```bash
> dispatch database list
> dispatch plugins list
Title Slug Version Type Author Description
-------------------------------- ------------------------------ ---------- ----------------- ------------- ---------------------------------------------------------
Dispatch - Document Resolver dispatch-document-resolver 0.1.0 document-resolver Kevin Glisson Uses dispatch itself to resolve incident documents.
Expand All @@ -229,3 +229,19 @@ Google Docs - Document google-docs-document 0.1.0 do
Google Group - Participant Group google-group-participant-group 0.1.0 participant_group Kevin Glisson Uses Google Groups to help manage participant membership.
...
```

### Install

The `install` command will try installing all available plugins.

```bash
> dispatch plugins install
INFO:dispatch.common.utils.cli:Attempting to load plugin: dispatch_basic_auth
INFO:dispatch.common.utils.cli:Successfully loaded plugin: dispatch_basic_auth
INFO:dispatch.common.utils.cli:Attempting to load plugin: dispatch_contact
INFO:dispatch.common.utils.cli:Successfully loaded plugin: dispatch_contact
INFO:dispatch.common.utils.cli:Attempting to load plugin: dispatch_document_resolver
...
```

Keep in mind that this will only make plugins available. To enable them [create and configure the plugin instance](./plugins/README.md)
4 changes: 3 additions & 1 deletion docs/admin-guide/administration/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Plugin Configurations

# Plugins

Much of Dispatch's functionality comes from its plugins. The current Dispatch web UI is limited to enabling and disabling plugins on a per-project basis. To make modifications to how plugins behave or are configured, changes must be deployed via the server configuration file. See the [server](../server.md) configuration documentation for more infomation.
Before being able to configure and use the plugins, refer to the [CLI](../cli.md#plugins) documentation about installing plugins.

Much of Dispatch's functionality comes from its plugins. The current Dispatch web UI is limited to enabling and disabling plugins on a per-project basis. To make modifications to how plugins behave or are configured, changes must be deployed via the server configuration file. See the [server](../server.md) configuration documentation for more information.

By default, no plugins are _required_ to create an incident. As you enable plugins, they will be additive to the incident process (e.g., creating slack channels, google docs, etc.)

Expand Down

0 comments on commit 0e78509

Please sign in to comment.