From a82726ca52b5850f4c6b72bb7fd0ab526a72b3e4 Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Thu, 29 Jul 2021 07:35:16 +0100 Subject: [PATCH] Update readme.md --- readme.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/readme.md b/readme.md index 53f39e6..3afbbad 100644 --- a/readme.md +++ b/readme.md @@ -5,3 +5,25 @@ A _really_ simple webhook receiver. Check config.json for an example configuration. Default config path is `/etc/ghookr.conf`, can be overriden with `CONFIG` environment variable. + +## Signature Verification + +Signature verificaiton is done using SHA256 HMACs. +You can set which header gohookr will receive a signature from using the `SignatureHeader` key for +each service. +You can also specify a shared secret in the `Secret` key. + +### Disable Signature Verification + +You can disable signature verification altogether by setting environment variable `NO_SIGNATURE_VERIFICATION` +to `true`. + +## Tests + +gohookr can run test before running your script. +Tests must be in the form of bash scripts. +A non-zero return code is considered a fail and gohookr will run no further tests and will not +deploy. + +Tests are run in the order they're listed so any actions that need to be done before +tests are run can simply be put before the tests.