aboutsummaryrefslogtreecommitdiff
path: root/doc/administration/configuration.rst
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:08 +0200
committerDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:45 +0200
commit4f96b9c3f39213a5f6ae631c7c820f63fc2219d5 (patch)
tree002a30ecabab225d77e3df0e89fdb3584a04cc6b /doc/administration/configuration.rst
parent6ee21f6c078891e4453415cbebd6b7d591185c5f (diff)
downloadfietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.gz
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.bz2
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.zip
documentation improvements
Diffstat (limited to 'doc/administration/configuration.rst')
-rw-r--r--doc/administration/configuration.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/administration/configuration.rst b/doc/administration/configuration.rst
index 4d33b7f..24c5fdb 100644
--- a/doc/administration/configuration.rst
+++ b/doc/administration/configuration.rst
@@ -2,7 +2,7 @@ Configuration
=============
The main configuration of Fietsboek is done via ``.ini``-files. By default,
-three such files exist:
+three such files exist, and one will be loaded at a time:
* ``production.ini`` contains the configuration for the production environment.
It turns off debugging features (as they are a security risk!) and should
@@ -93,8 +93,8 @@ Database Settings
Fietsboek uses three different databases:
A SQL database for persistent data (like user accounts), a file storage on the
-disk for big files (like images), and a redis server for ephemeral data (like
-cached tiles).
+disk for big files (like GPX files and images), and a redis server for
+ephemeral data (like cached tiles).
Set ``sqlalchemy.url`` to the URL of the SQL database. See the `SQLAlchemy
documentation
@@ -103,8 +103,8 @@ information on available URL formats. Make sure to install the driver necessary
to communicate with your database (e.g. ``psycopg2`` for PostreSQL)!
Set ``fietsboek.data_dir`` to the directory for data uploads. This directory
-must be writable by the Fietsboek process, as Fietsboek will save track images
-in there.
+must be writable by the Fietsboek process, as Fietsboek will save track data in
+there.
Set ``redis.url`` to the URL of the redis instance. See the `redis module
documentation
@@ -133,7 +133,7 @@ accepted:
standard output. Should not be used in production, as no emails would ever
arrive.
* ``smtp://host:port`` use the given SMTP server (without transport encryption!)
-* ``smtp+ssl://host:port`` use the given SMTP server over a SSL connection
+* ``smtp+ssl://host:port`` use the given SMTP server over a SSL connection.
* ``smtp+starttls://host:port`` use the given SMTP server and the STARTTLS
command to start an encrypted channel.
@@ -192,11 +192,11 @@ You can add custom tile layers in the following way:
# public
fietsboek.tile_layer.ID.access = public
-``ID`` must be an alphanumerical identifier.
+``ID`` must be an alphanumerical identifier of your choosing.
By default, Fietsboek will proxy all tile requests through the Fietsboek
-instance. While this can slow down the user experience, it has the following
-benefits:
+instance. While this can slow down the user experience and increase the load on
+your server, it has the following benefits:
* Your users' IPs stay private and protected, as no third party is contacted.
The tile servers will only see the IP from the Fietsboek server.
@@ -239,15 +239,15 @@ default behavior.
.. note::
- The ``hittekaart.autogenerate`` has no effect on the ``fietsctl
+ The ``hittekaart.autogenerate`` setting has no effect on the ``fietsctl
hittekaart`` command. You can always use ``fietsctl`` to generate heat maps
- for specific users!
+ manually!
.. 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.
+ overlay map can get relatively large (in my case ~100 MiB). Keep that in
+ mind when hosting a larger number of users.
An example configuration excerpt can look like this: