Skip to content

Commit 50338db

Browse files
committed
GitHub: improve doc for Webhook Secret
Fixes #345
1 parent c760f5b commit 50338db

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/CONFIGURING.SourceGithub.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,13 @@ configured in a given MantisBT instance.
7676
- Paste the OAuth app's _Client ID_ and _Client Secret_ in the
7777
GitHub Application Client ID and Secret fields
7878
- The _GitHub Webhook Secret_ is not mandatory, but provides additional
79-
security as it will allows the plugin to validate the payload received
80-
from the GitHub Webhook to ensure it's legit
79+
security as it will allow the plugin to validate the payload received
80+
from the GitHub Webhook to ensure it's legit.
81+
This field's value must match that of the _Secret_ field in the GitHub
82+
Webhook's definition, as shown in the screenshot below.
83+
If the Webhook is generated with the _Create Webhook_ button, this field
84+
will automatically be set to the value stored in the Repository definition.
85+
![Github Webhook secret screenshot](github_webhook_secret.png)
8186
- By default, the *Primary Branches* is set to `master`, but you can specify
8287
another branch or additional ones (comma-separated), or use `*` for all
8388
branches

docs/github_webhook_secret.png

51.6 KB
Loading

0 commit comments

Comments
 (0)