From 33e39f0b4092c8750e5360e595875162e2b3d81e Mon Sep 17 00:00:00 2001 From: finga Date: Fri, 19 Nov 2021 14:32:18 +0100 Subject: [PATCH] Improve readme and fix typos Improve wording and fix typos in readme. --- README.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5689753..2464c09 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Webhookey Webhookey is a web server listening for requests as for example sent by -gitea's webhooks. Further, Webhookey allows you to specify rules +Gitea's webhooks. Further, Webhookey allows you to specify rules which are matched against the data received to trigger certain actions. @@ -62,7 +62,10 @@ Whereas `` depends on the platform: #### Metrics A metrics page can optionally enabled to query stats of the currently running webhookey instance. Note that stats are lost between restarts -of webhookey as those are not stored persistently. +of webhookey as those are not stored persistently. The `metrics` +structure is optional as well as the `ip_filter`. The `ip_filter` +supports either `allow` or `deny` containing a list of IPv4 and IPv6 +addresses and networks. Example: ```yaml @@ -127,25 +130,28 @@ Use values from header fields sent with the HTTP request. Example: `{{ header X-Gitea-Event }}`. -##### Allow and Deny -To allow or deny specific network ranges source is an optional -configuration parameter which either contains an allow or a deny field -with sequences containing networks. Note that IPv6 addresses have to -be put in single quotes due to the colons. +##### IP Filter +Specific IPv4 and IPv6 addresses and/or ranges ranges can be allowed +or denied. The `ip_filter` is optional and has to contain either an +`allow` or a `deny` field which contains a sequence of IPv4 or IPv6 +addresses or CIDR network ranges. Note that IPv6 addresses have to be +quoted due to the colons. Example: ```yaml -allow: - - 127.0.0.1 - - 127.0.0.1/31 - - "::1" +ip_filter: + allow: + - 127.0.0.1 + - 127.0.0.1/31 + - "::1" ``` ```yaml -deny: - - 127.0.0.1 - - 127.0.0.1/31 - - "::1" +ip_filter: + deny: + - 127.0.0.1 + - 127.0.0.1/31 + - "::1" ``` ##### Signature @@ -175,7 +181,7 @@ Conjunction filters contain lists of other filters. received http(s) request header. - `field`: The header field which should be matched. - - `regeq`: Regular expression which has to match the specified + - `regex`: Regular expression which has to match the specified header field. - `json`: