From 606af1737c8405bd74f697d078e7e5b94e22055c 2018-06-28 23:34:31
From: Branko Majic <branko@majic.rs>
Date: 2018-06-28 23:34:31
Subject: [PATCH] MAR-129: Added information about test tools to development documentation:

- Document use of mcabber/mutt configuration files for trying out the
  XMPP/mail server.

---

diff --git a/docs/development.rst b/docs/development.rst
index 846823333d5212cfa6b9b60e1f47ca533dc20b24..79b5d4a5aebda3a64bea2a86a33ec1b37001588d 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -629,3 +629,34 @@ In order to deploy the test site, the following steps would normally be taken:
     .. code-block:: shell
 
        ansible-playbook playbooks/site.yml
+
+
+Trying the test site out
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The test site ships with configuration files for a number of CLI-based
+tools/applications that can be easily used for trying the services out
+(you can otherwise set-up your own).
+
+Configuration files assume the default domain (``example.com``) is
+used.
+
+The following tools come with out-of-the-box configuration:
+
+- `mcabber <https://mcabber.com/>`_ (for XMPP)
+- `mutt <http://www.mutt.org/>`_ (for IMAP/SMTP)
+
+In order to use the configuration files, make sure that you are
+running all tools from within the ``testsite/`` directory.
+
+To start the XMPP CLI client (*mcabber*) with provided configuration,
+run (take note it is lower-caser ``f``)::
+
+  mcabber -f mcabber/john.doe
+  mcabber -f mcabber/jane.doe
+
+To start the IMAP/SMTP CLI client (*Mutt*) with provided
+configuration, run (take note it is upper-case ``F``)::
+
+  mutt -F mutt/john.doe
+  mutt -F mutt/jane.doe