Skip to content

Commit 0410a1a

Browse files
Improved documentation a bit.
1 parent dc7c9e2 commit 0410a1a

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,16 @@ You can configure what the application does by changing ``config.json``:
3838
:github_ips_only: Restrict application to be called only by GitHub IPs. IPs
3939
whitelist is obtained from
4040
`GitHub Meta <https://developer.github.com/v3/meta/>`_
41-
(`endpoint <https://api.github.com/meta>`_).
41+
(`endpoint <https://api.github.com/meta>`_). Default: ``true``.
4242
:enforce_secret: Enforce body signature with HTTP header ``X-Hub-Signature``.
4343
See ``secret`` at
4444
`GitHub WebHooks Documentation <https://developer.github.com/v3/repos/hooks/>`_.
45+
Default: ``''`` (do not enforce).
4546
:return_scripts_info: Return a JSON with the ``stdout``, ``stderr`` and exit
46-
code for each executed hook using the hook name as key.
47+
code for each executed hook using the hook name as key. If this option is set
48+
you will be able to see the result of your hooks from within your GitHub
49+
hooks configuration page (see "Recent Deliveries").
50+
Default: ``true``.
4751

4852

4953
Adding Hooks

0 commit comments

Comments
 (0)