alvierahman90/gohookr
1
1
Fork 0
mirror of https://github.com/alvierahman90/gohookr.git synced 2024-11-22 10:49:52 +00:00
Code Issues 1 Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Akbar Rahman 2021-07-29 07:35:16 +01:00
parent c99a5943aa
commit a82726ca52
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
readme.md
View File

@ -5,3 +5,25 @@ A _really_ simple webhook receiver.
Check config.json for an example configuration. Check config.json for an example configuration.
Default config path is `/etc/ghookr.conf`, can be overriden with `CONFIG` environment variable. 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.