From 50ba592fc01d702f91b4662212a6fa5865267614 Mon Sep 17 00:00:00 2001
From: drebs <drebs@riseup.net>
Date: Wed, 8 Nov 2017 09:19:35 -0200
Subject: [pkg] add man page for user db creation script

Closes: #8895
---
 debian/control                       |  8 ++++-
 debian/manpages                      |  1 +
 debian/rules                         |  5 +++
 docs/man/soledad-create-userdb.1.rst | 67 ++++++++++++++++++++++++++++++++++++
 4 files changed, 80 insertions(+), 1 deletion(-)
 create mode 100644 debian/manpages
 create mode 100644 docs/man/soledad-create-userdb.1.rst

diff --git a/debian/control b/debian/control
index 38322a88..7f48acb8 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,13 @@ Section: python
 Priority: optional
 Maintainer: Micah Anderson <micah@debian.org>
 Uploaders: LEAP automated build <sysdev@leap.se>
-Build-Depends: python-setuptools (>= 0.6b3), python-all (>= 2.6.6-3), python-wheel, debhelper (>= 9), dh-python, dh-systemd
+Build-Depends: python-setuptools (>= 0.6b3)
+             , python-all (>= 2.6.6-3)
+             , python-wheel
+             , debhelper (>= 9)
+             , dh-python
+             , dh-systemd
+             , python-docutils
 Standards-Version: 4.1.1
 
 Package: soledad-server
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 00000000..42fb695f
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+docs/man/soledad-create-userdb.1
diff --git a/debian/rules b/debian/rules
index 36bb6748..e78a8c31 100755
--- a/debian/rules
+++ b/debian/rules
@@ -13,6 +13,10 @@ NAME=soledad-server
 %:
 	dh $@ --with python2 --namespace=leap.soledad --buildsystem=pybuild --with=systemd
 
+override_dh_prep:
+	rst2man docs/man/soledad-create-userdb.1.rst docs/man/soledad-create-userdb.1
+	dh_prep
+
 override_dh_installinit:
 	dh_systemd_enable -p${NAME} --name=${NAME} ${NAME}.service
 	dh_installinit -p${NAME} --no-start --noscripts
@@ -21,3 +25,4 @@ override_dh_auto_clean:
 	dh_auto_clean
 	find . -name "*.pyc" -exec rm -rf {} \;
 	find . -name ".tox" -exec rm -rf {} \;
+	rm -f docs/man/soledad-create-userdb.1
diff --git a/docs/man/soledad-create-userdb.1.rst b/docs/man/soledad-create-userdb.1.rst
new file mode 100644
index 00000000..3f3d1758
--- /dev/null
+++ b/docs/man/soledad-create-userdb.1.rst
@@ -0,0 +1,67 @@
+=====================
+soledad-create-userdb
+=====================
+
+------------------------------------------------------------------------
+Create a user database for use with Soledad Server in the LEAP Platform.
+------------------------------------------------------------------------
+
+:Author: The LEAP Encryption Access Project https://leap.se
+:Copyright: GPLv3+
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+``soledad-create-userdb`` [-h] `dbname`
+
+DESCRIPTION
+===========
+
+``soledad-create-userdb`` is a command used by Soledad Server to create user
+databases for use with the LEAP Platform.
+
+The current database backend used by the LEAP Platform is CouchDB. This command
+will parse the Soledad Server configuration file to find the path for a netrc
+file with the administrative CouchDB credentials. See the **FILES** section
+below for more information on this. 
+
+This command is meant to be run by the `soledad` user in the system, which
+should have special privileges so it can read the CouchDB administrative
+credentials from the netrc file pointed by the Soledad Server configuration
+file.
+
+OPTIONS
+=======
+
+`dbname`
+  The name of the database to be created.
+
+-h, --help
+  Print a help message and exit.
+
+FILES
+=====
+
+/etc/soledad/soledad-server.conf
+  The Soledad Server configuration file. The path to a netrc file with CouchDB
+  administrative credentials should be set in this file with the option
+  ``admin_netrc`` under the section ``[soledad-server]``.
+
+ENVIRONMENT
+===========
+
+SOLEDAD_SERVER_CONFIG_FILE
+  If set, the command will parse the configuration file pointed by this variable
+  instead of the default one in */etc/soledad/soledad-server.conf*.
+
+SOLEDAD_BYPASS_AUTH
+  If set, the command will not try to load the CouchDB administrative
+  credentials and URI from a configuration file. Instead, it will use
+  ``http://127.0.0.1:5984/`` as URI (without username and password).
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code/projects/report-issues
-- 
cgit v1.2.3