add docs about overpass configuration

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/administration/configuration.rst b/doc/administration/configuration.rst
index 98f3592..99ce4d1 100644
--- a/doc/administration/configuration.rst
+++ b/doc/administration/configuration.rst
@@ -218,6 +218,35 @@ true``. This will cause the tiles to be loaded directly by the client.
     your users that third party content is included in your site, and that
     their IP will be accessible to the third party.
 
+Overpass API
+------------
+
+Fietsboek uses Overpass_ to name climbs. You can set custom Overpass instances
+in the config:
+
+.. code:: ini
+
+    overpass.url = https://overpass.example.com/api/interpreter
+    # HTTP Basic auth, if needed:
+    overpass.basic_auth.username = fietsboek
+    overpass.basic_auth.password = super5ecre7
+
+By default, Fietsboek uses the API instance at
+https://maps.mail.ru/osm/tools/overpass/api/interpreter, however, it is often
+overloaded and will respond with timeouts.
+
+.. note::
+
+    The URL needs to include the whole path to the interpreter script, so
+    usually it ends with ``/api/interpreter``.
+
+.. note::
+
+    Overpass has no standard way to do authentication. Commonly, the API key is
+    included in the URL. Fietsboek also has support for HTTP Basic auth.
+
+.. _Overpass: https://wiki.openstreetmap.org/wiki/Overpass_API
+
 Hittekaart Integration
 ----------------------