diff options
| author | Daniel Schadt <kingdread@gmx.de> | 2025-06-10 21:12:25 +0200 |
|---|---|---|
| committer | Daniel Schadt <kingdread@gmx.de> | 2025-06-10 21:12:25 +0200 |
| commit | 483a471028de448ba5eb805d0bc9603943ead63b (patch) | |
| tree | 53690e589476caf2a19f6735d3b2d1e9ebeec6c8 | |
| parent | c781fdfd19b5c975ebf52821ab12f0a569ba7a4e (diff) | |
| download | fietsboek-483a471028de448ba5eb805d0bc9603943ead63b.tar.gz fietsboek-483a471028de448ba5eb805d0bc9603943ead63b.tar.bz2 fietsboek-483a471028de448ba5eb805d0bc9603943ead63b.zip | |
update docs for Postgres
| -rw-r--r-- | doc/administration/installation.rst | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/doc/administration/installation.rst b/doc/administration/installation.rst index b207784..a7c5c27 100644 --- a/doc/administration/installation.rst +++ b/doc/administration/installation.rst @@ -6,14 +6,16 @@ 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: +* A Linux system * 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 `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 it is 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 +99,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 +133,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 ---------------------------- |