-
Notifications
You must be signed in to change notification settings - Fork 450
Fix plugin verification docs: replace removed CLI commands #1501
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -195,21 +195,17 @@ This command will generate `com.mattermost.demo-plugin-0.1.0.tar.gz.sig`, which | |||||||||||||
|
|
||||||||||||||
| ## Plugin verification | ||||||||||||||
|
|
||||||||||||||
| Mattermost server will verify plugin signatures downloaded from the Marketplace. To add custom public keys, run the following command on the Mattermost server: | ||||||||||||||
| Mattermost server will verify plugin signatures downloaded from the Marketplace. Plugins are verified against a hard-coded Mattermost public key, as well as any additional public keys configured on the server. | ||||||||||||||
|
|
||||||||||||||
| `mattermost plugin add key my-pub-key` | ||||||||||||||
| To add custom public keys for plugin signature verification, add the key file names to the `PluginSettings.SignaturePublicKeyFiles` setting in your `config.json`: | ||||||||||||||
|
|
||||||||||||||
| Multiple public keys can be added to the Mattermost server: | ||||||||||||||
|
|
||||||||||||||
| `mattermost plugin add key my-pk-file1 my-pk-file2` | ||||||||||||||
|
|
||||||||||||||
| To list the names of all public keys installed on your Mattermost server, use: | ||||||||||||||
|
|
||||||||||||||
| `mattermost plugin keys` | ||||||||||||||
|
|
||||||||||||||
| To delete public key(s) from your Mattermost server, use: | ||||||||||||||
| ```json | ||||||||||||||
| "PluginSettings": { | ||||||||||||||
| "SignaturePublicKeyFiles": ["my-pub-key-1", "my-pub-key-2"] | ||||||||||||||
|
Comment on lines
+203
to
+204
|
||||||||||||||
| "PluginSettings": { | |
| "SignaturePublicKeyFiles": ["my-pub-key-1", "my-pub-key-2"] | |
| { | |
| "PluginSettings": { | |
| "SignaturePublicKeyFiles": ["my-pub-key-1", "my-pub-key-2"] | |
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section describes verification keys as a “hard-coded Mattermost public key”, but earlier in the same document the terminology is “default certificate” / “public key certificate” (see around lines 105-107). To avoid confusion about whether this is a raw public key vs a certificate, align the wording here with the earlier terminology (or update both to use a single, consistent term).