aboutsummaryrefslogtreecommitdiff
path: root/doc/administration/configuration.rst
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2022-07-18 18:55:40 +0200
committerDaniel Schadt <kingdread@gmx.de>2022-07-18 18:55:40 +0200
commitf8c198709120cf94d9e7263d5979c4cf0dc95b67 (patch)
tree3d7ce3937a3219f5bad92ebaf4def6254b861eb5 /doc/administration/configuration.rst
parent5a2057560a5703a59408009e40b51de5a0c18600 (diff)
downloadfietsboek-f8c198709120cf94d9e7263d5979c4cf0dc95b67.tar.gz
fietsboek-f8c198709120cf94d9e7263d5979c4cf0dc95b67.tar.bz2
fietsboek-f8c198709120cf94d9e7263d5979c4cf0dc95b67.zip
update documentation with new data dir
Diffstat (limited to 'doc/administration/configuration.rst')
-rw-r--r--doc/administration/configuration.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/administration/configuration.rst b/doc/administration/configuration.rst
index 48afde1..3927540 100644
--- a/doc/administration/configuration.rst
+++ b/doc/administration/configuration.rst
@@ -35,6 +35,7 @@ Most of the configuration is in the ``[app:main]`` category and looks like this:
session_key = <EDIT THIS>
sqlalchemy.url = sqlite:///%(here)s/fietsboek.sqlite
+ fietsboek.data_dir = %(here)s/data
retry.attempts = 3
@@ -51,6 +52,15 @@ Most of the configuration is in the ``[app:main]`` category and looks like this:
creation of new accounts via the web interface, for example if you want to
have a private instance. New accounts can always be created using the CLI
management tool.
+* ``session_key`` should be set to a random string of characters. This is the
+ key used to sign session data, so it should not get into wrong hands!
+* ``sqlalchemy.url`` is the URL to the database. See the `SQLAlchemy
+ documentation
+ <https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls>`__ for
+ more information.
+* ``fietsboek.data_dir`` sets the directory for data uploads. This directory
+ must be writable by the Fietsboek process, as Fietsboek will save track
+ images in there.
* ``email.from`` sets the sender of emails, for example for account verifications.
* ``email.smtp_url`` sets the URL of the SMTP server. The following formats are accepted: