aboutsummaryrefslogtreecommitdiff
path: root/doc/administration/installation.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/administration/installation.rst')
-rw-r--r--doc/administration/installation.rst46
1 files changed, 39 insertions, 7 deletions
diff --git a/doc/administration/installation.rst b/doc/administration/installation.rst
index fd0def5..cf8e83a 100644
--- a/doc/administration/installation.rst
+++ b/doc/administration/installation.rst
@@ -50,17 +50,41 @@ Installing the Python Modules
-----------------------------
The Python package manager takes care of installing all dependencies, all you
-need to do is tell it to install Fietsboek:
+need to do is tell it to install Fietsboek. How exactly depends on your way of
+acquiring Fietsboek.
+
+Via PIP
+^^^^^^^
+
+Fietsboek is available in the Python Package Index as `fietsboek
+<https://pypi.org/project/fietsboek/>`__ and can be installed directly via
+``pip``:
.. code:: bash
- # Assuming that we are in the Fietsboek folder
- .venv/bin/pip install .
- # Alternatively
- .venv/bin/pip path/to/fietsboek/repository
+ .venv/bin/pip install fietsboek
+
+Via Git
+^^^^^^^
+
+If you prefer to work with the source version (e.g. for development purposes),
+you should use Git to clone the repository from one of its mirrors:
-Optionally, you can install ``lxml``, which provides a faster XML parser to
-process the GPX files:
+* Main on Gitlab: https://gitlab.com/dunj3/fietsboek
+* Mirror on Codeberg: https://codeberg.org/dunj3/fietsboek
+
+.. code:: bash
+
+ git clone https://gitlab.com/dunj3/fietsboek
+ .venv/bin/pip install ./fietsboek
+ # For development, you can use -e for an editable installation:
+ .venv/bin/pip install -e ./fietsboek
+
+Optional: Install lxml
+^^^^^^^^^^^^^^^^^^^^^^
+
+In any case, you can optionally install ``lxml``, which provides a faster XML
+parser to process the GPX files:
.. code:: bash
@@ -89,6 +113,14 @@ other update tasks. You can use it to set up the initial database schema:
.venv/bin/fietsupdate update -c production.ini
+.. note::
+
+ If you install Fietsboek via Git, and you stick to the ``master`` branch
+ 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.
+
Adding an Administrator User
----------------------------