doc: document hittekaart configuration options

1 files changed, 34 insertions, 0 deletions

diff --git a/doc/administration/configuration.rst b/doc/administration/configuration.rst
index e77e3cc..d272234 100644
--- a/doc/administration/configuration.rst
+++ b/doc/administration/configuration.rst
@@ -213,3 +213,37 @@ true``. This will cause the tiles to be loaded directly by the client.
     In addition, depending on the jurisdiction, you might be required to tell
     your users that third party content is included in your site, and that
     their IP will be accessible to the third party.
+
+Hittekaart Integration
+----------------------
+
+Fietsboek can use hittekaart_ to generate heat maps for users. For that, you
+can set ``hittekaart.bin`` to the path to the ``hittekaart`` binary. If unset,
+it is assumed that the binary can be found in your ``$PATH``.
+
+In addition, you can set ``hittekaart.autogenerate`` to the list of overlay
+maps you want to automatically generate and update. By default, this list is
+empty, which means that Fietsboek will not generate any overlays on its own.
+You can add ``heatmap`` and/or ``tilehunter`` to generate those maps
+automatically.
+
+.. note::
+
+    The ``hittekaart.autogenerate`` has no effect on the ``fietsctl
+    hittekaart`` command. You can always use ``fietsctl`` to generate heat maps
+    for specific users!
+
+.. warning::
+
+    Depending on the geospatial area that a user covers with their tracks, an
+    overlay map can get relatively large (~100 MiB for mine). Keep that in mind
+    when hosting a larger number of users.
+
+An example configuration excerpt can look like this:
+
+.. code-block:: ini
+
+    hittekaart.bin = /usr/local/bin/hittekaart
+    hittekaart.autogenerate = heatmap tilehunter
+
+.. _hittekaart: https://gitlab.com/dunj3/hittekaart