diff --git a/README.md b/README.md index c21c44d..1665fb8 100644 --- 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 new file mode 100644 index 0000000..cfd8849 Binary files /dev/null and b/images/gh.png differ