Unverified Commit a5561aad authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Document geoip_lock and proxy variables

parent e5dca31c

bin/hafas-m

+4 −0
Original line number Diff line number Diff line
@@ -819,6 +819,10 @@ Note that requesting an invalid/unsupported language may lead to garbage output. 
List known HAFAS instances and exit. Use B<-s>|B<--service> to select a

service from this list for a HAFAS request.



Instances marked with an exclamation mark (C<< ! >>) are behind a GeoIP filter

and may need a proxy to work. See the documentation of get_active_service in

Travel::Status::DE::HAFAS(3pm) for details.



=item B<-m>, B<--mot> I<motlist> (monitor)



By default, B<hafas-m> shows all modes of transport arriving/departing at the

lib/Travel/Status/DE/HAFAS.pm

+8 −0
Original line number Diff line number Diff line
@@ -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.