diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..36479c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +gohookr diff --git a/readme.md b/readme.md index 54a69cc..f45063c 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,6 @@ A _really_ simple webhook receiver, which listens at `/webhooks/`. -Default config path is `/etc/gohookr.conf` and can be overriden by setting environment variable -`CONFIG`. - -Check below for an example configuration. - ## Installation After you [install go](https://golang.org/doc/install): @@ -15,7 +10,17 @@ After you [install go](https://golang.org/doc/install): make ``` -## Signature Verification +## Configuration + +Default config path is `/etc/gohookr.json`. +It can be overriden by setting environment variable `CONFIG`. + +Check below for an example configuration, which should tell you most of the things you need to know +to configure gohookr. + +Currently gohookr must be restarted after config changes. + +### Signature Verification Signature verificaiton is done using SHA256 HMACs. You **must** set which HTTP header gohookr will receive a signature from using the `SignatureHeader` @@ -25,20 +30,20 @@ You should also specify a shared secret in the `Secret` key. You may also need to specify a `SignaturePrefix`. For GitHub it would be `sha256=`. -### Disable Signature Verification +#### Disable Signature Verification You can disable signature verification by setting `DisableSignatureVerification` for a service to `true`. You can disable signature verification for all services by setting environment variable `NO_SIGNATURE_VERIFICATION` to `true`. -## Writing Commands +### Writing Commands gohookr doesn't care what the command is as long as the `Program` is executable. You can specify extra arguments with the `Arguments` field. You can ask it to put the payload as the last argument by setting `AppendPayload` to true. -## Writing Tests +### Writing Tests gohookr can run test before running your script. Tests must be in the form of bash scripts. @@ -48,7 +53,7 @@ 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 in this section before the tests. -## Example Config +### Example Config Required config keys are `ListenAddress` and `Services`.