From a2fac2373beb7554247f04321b2dc2dcf17c7981 Mon Sep 17 00:00:00 2001 From: Adnan Hajdarevic Date: Sat, 14 Mar 2015 13:02:41 +0100 Subject: [PATCH] updated readme to include https --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3118c08..d03b6af 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,9 @@ By performing a simple HTTP GET or POST request to that endpoint, your specified However, hook defined like that could pose a security threat to your system, because anyone who knows your endpoint, can send a request and execute your command. To prevent that, you can use the `"trigger-rule"` property for your hook, to specify the exact circumstances under which the hook would be triggered. For example, you can use them to add a secret that you must supply as a parameter in order to successfully trigger the hook. Please check out the [Hook rules page](https://github.com/adnanh/webhook/wiki/Hook-Rules) for detailed list of available rules and their usage. +# Using HTTPS +If you want webhook to serve secure content using https, you can use the `-secure` flag while starting webhook. Files containing a certificate and matching private key for the server must be provided using the `-cert /path/to/cert.pem` and `-key /path/to/key.pem` flags. If the certificate is signed by a certificate authority, the cert file should be the concatenation of the server's certificate followed by the CA's certificate. + # Examples Check out [Hook examples page](https://github.com/adnanh/webhook/wiki/Hook-Examples) for more complex examples of hooks.