mirrors/webhook
1
0
Fork 0
mirror of https://github.com/adnanh/webhook.git synced 2025-05-16 10:30:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs for TLS version and cipher suite options

Browse source
This commit is contained in:
Cameron Moore 2019-12-03 21:36:14 -06:00
parent f1003560f1
commit 13d5630e80
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -83,6 +83,8 @@ However, hook defined like that could pose a security threat to your system, bec
## Using HTTPS
[webhook][w] by default serves hooks using http. If you want [webhook][w] to serve secure content using https, you can use the `-secure` flag while starting [webhook][w]. 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.
TLS version and cipher suite selection flags are available from the command line. To list available cipher suites, use the `-list-cipher-suites` flag. The `-tls-min-version` flag can be used with `-list-cipher-suites`.
## CORS Headers
If you want to set CORS headers, you can use the `-header name=value` flag while starting [webhook][w] to set the appropriate CORS headers that will be returned with each response.

6
docs/Webhook-Parameters.md
View file

@ -3,6 +3,8 @@
Usage of webhook:
-cert string
path to the HTTPS certificate pem file (default "cert.pem")
-cipher-suites string
comma-separated list of supported TLS cipher suites
-header value
response header to return, specified in format name=value, use multiple times to set multiple headers
-hooks value
@ -13,6 +15,8 @@ Usage of webhook:
ip the webhook should serve hooks on (default "0.0.0.0")
-key string
path to the HTTPS certificate private key pem file (default "key.pem")
-list-cipher-suites
list available TLS cipher suites
-nopanic
do not panic if hooks cannot be loaded when webhook is not running in verbose mode
-port int
@ -21,6 +25,8 @@ Usage of webhook:
use HTTPS instead of HTTP
-template
parse hooks file as a Go template
-tls-min-version string
minimum TLS version (1.0, 1.1, 1.2, 1.3) (default "1.2")
-urlprefix string
url prefix to use for served hooks (protocol://yourserver:port/PREFIX/:hook-id) (default "hooks")
-verbose