Merge pull request #138 from bastelfreak/docs

document webhook configuration
voxpupuli · Jul 21, 2020 · c4c3f12 · c4c3f12
2 parents fd2cb3a + 0a0fdf6
commit c4c3f12
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -167,3 +167,16 @@ Default: []
 type: Boolean
 description: Allow uppercase within the name of the module or environment passed to the API.
 default: true
+
+### Configure the webhook
+
+This API provides two endpoints that need to be called:
+
+* `/api/v1/r10k/module` for every module
+* `api/v1/r10k/environment` for the control repository
+
+In GitHub, set setup looks like this:
+
+!![GitHub Webook configuration](images/gh.png)
+
+If you configured basic authentication, you need to add the username and password to the URL.
diff --git a/images/gh.png b/images/gh.png