From 8a12b547e8aed2c6880a7ac4b7a6031f5d077368 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Sat, 16 Dec 2017 15:42:22 +0100 Subject: Document the db_name option (with postgresql support) --- doc/biboumi.1.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc') 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 ----- -- cgit v1.2.3