diff options
Diffstat (limited to 'doc/administration')
| -rw-r--r-- | doc/administration/configuration.rst | 14 | ||||
| -rw-r--r-- | doc/administration/installation.rst | 31 |
2 files changed, 28 insertions, 17 deletions
diff --git a/doc/administration/configuration.rst b/doc/administration/configuration.rst index 24c5fdb..98f3592 100644 --- a/doc/administration/configuration.rst +++ b/doc/administration/configuration.rst @@ -221,15 +221,12 @@ true``. This will cause the tiles to be loaded directly by the client. 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``. +Fietsboek can use hittekaart_ to generate heat maps for users. -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. +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. By default, ``hittekaart`` will use as many threads as CPU cores are available. This leads to the fastest heatmap generation, but might be undesired on shared @@ -253,7 +250,6 @@ An example configuration excerpt can look like this: .. code-block:: ini - hittekaart.bin = /usr/local/bin/hittekaart hittekaart.autogenerate = heatmap tilehunter hittekaart.threads = 2 diff --git a/doc/administration/installation.rst b/doc/administration/installation.rst index b207784..13e03b5 100644 --- a/doc/administration/installation.rst +++ b/doc/administration/installation.rst @@ -6,14 +6,17 @@ This document will outline the installation process of Fietsboek, step-by-step. Requirements ------------ -Fietsboek has the following requirements (apart from the Python modules, which -will be installed by ``pip``): +Fietsboek has the following requirements: -* Python 3.10 or later -* A `redis <https://redis.com/>`__ server, used for caching and temporary data -* (Optionally) an SQL database server like `PostgreSQL - <https://www.postgresql.org/>`__ or `MariaDB <https://mariadb.org/>`__ (if - SQLite is not enough) +* A Linux system +* Python 3.11 or later +* A `redis <https://redis.com/>`__ server +* (Optionally) an SQL database server: + + * `PostgreSQL <https://www.postgresql.org/>`__ + +Other systems (such as BSD as operating system, or MariaDB as SQL server) might +work, but are not tested. In addition, if you run on a different interpreter than CPython, you might need a working Rust toolchain (``rustc`` and ``cargo``) installed. This is because @@ -97,6 +100,18 @@ parser to process the GPX files: .. _issue #7: https://gitlab.com/dunj3/fietsboek/-/issues/7 +Optional: Install Database Drivers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you decide to use a database other than SQLite, you must install the +required drivers: + +**PostgreSQL**: + +.. code:: bash + + .venv/bin/pip install psycopg2 + Configuring Fietsboek --------------------- @@ -119,7 +134,7 @@ other update tasks. You can use it to set up the initial database schema: instead of a specific version, you must also run ``.venv/bin/alembic -c production.ini upgrade head``. - See :doc:`../developer/updater` ("Furhter notes") for more information. + See :doc:`../developer/updater` ("Further notes") for more information. Adding an Administrator User ---------------------------- |