From a5561aad701836484a1e93ef7fc950add9bd2487 Mon Sep 17 00:00:00 2001
From: Birte Kristina Friesel <derf@finalrewind.org>
Date: Sun, 9 Feb 2025 14:33:55 +0100
Subject: Document geoip_lock and proxy variables

---
 lib/Travel/Status/DE/HAFAS.pm | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'lib')

diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm
index da2d1c2..d99270e 100644
--- a/lib/Travel/Status/DE/HAFAS.pm
+++ b/lib/Travel/Status/DE/HAFAS.pm
@@ -1156,6 +1156,14 @@ a (nearly) complete list of departures and real-time data. The hashref contains
 two optional keys: B<area> (GeoJSON) and B<regions> (list of strings, e.g. "DE"
 or "CH-BE").
 
+=item B<geoip_lock> => I<proxy_id>
+
+If present: the service filters requests based on the estimated location of the
+requesting IP address, and may return errors or time out when the requesting IP
+address does not satisfy its requirements. Set the B<HAFAS_PROXY_>I<proxy_id>
+environment variable to a proxy string (e.g. C<< socks://localhost:12345 >>) if
+needed to work around this.
+
 =item B<homepage> => I<string>
 
 Homepage URL of the service provider.
-- 
cgit v1.2.3