summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlouiz’ <louiz@louiz.org>2017-12-16 15:42:22 +0100
committerlouiz’ <louiz@louiz.org>2017-12-16 15:42:22 +0100
commit8a12b547e8aed2c6880a7ac4b7a6031f5d077368 (patch)
tree45ba146c5092e103d97dfed61ef802d412226a6c
parenta557718bf2f16c440313e5d5409b23dcefa45ab9 (diff)
downloadbiboumi-8a12b547e8aed2c6880a7ac4b7a6031f5d077368.tar.gz
biboumi-8a12b547e8aed2c6880a7ac4b7a6031f5d077368.tar.bz2
biboumi-8a12b547e8aed2c6880a7ac4b7a6031f5d077368.tar.xz
biboumi-8a12b547e8aed2c6880a7ac4b7a6031f5d077368.zip
Document the db_name option (with postgresql support)
-rw-r--r--doc/biboumi.1.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst
index 354080a..89f8627 100644
--- a/doc/biboumi.1.rst
+++ b/doc/biboumi.1.rst
@@ -77,6 +77,20 @@ port
The TCP port to use to connect to the local XMPP component. The default
value is 5347.
+db_name
+-------
+
+The name of the database to use. This option can only be used if biboumi
+has been compiled with a database support (Sqlite3 and/or PostgreSQL). If
+the value begins with the postgresql scheme, “postgresql://” or
+“postgres://”, then biboumi will try to connect to the PostgreSQL database
+specified by the URI. See
+https://www.postgresql.org/docs/current/static/libpq-connect.html#idm46428693970032
+for all possible values. For example the value could be
+“postgresql://user:secret@localhost”. If the value does not start with the
+postgresql scheme, then it specifies a filename that will be opened with
+Sqlite3. For example the value could be “/var/lib/biboumi/biboumi.sqlite”.
+
admin
-----