From 59056b9cab1ef95a634db44021d86ccac8894fb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferdinand=20M=C3=BCtsch?= Date: Sat, 2 Oct 2021 16:47:39 +0200 Subject: [PATCH] docs: update readme [ci skip] --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a77ad4b..9dbaf0d 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ uses [LookupIP](https://pkg.go.dev/net?utm_source=godoc#LookupIP) internally). ## Usage ``` -remote_host [forwarded] +remote_host [forwarded] [nocache] ``` -Accepts valid host names. If the first argument is `forwarded`, then the first IP in the `X-Forwarded-For` request +Accepts valid host names. If `forwarded` is given as an argument, then the first IP in the `X-Forwarded-For` request header, if present, will be preferred as the reference IP, rather than the immediate peer's IP, which is the default. +If `nocache` is given as an argument, this module will not cache DNS responses and instead resolve the given hosts' for +every request. By default, responses are cached for 60 seconds, regardless of the DNS record's time-to-live (TTL). Multiple `remote_host` matchers will be OR'ed together.