Changeset - 606af1737c84
[Not reviewed]
0 1 0
Branko Majic (branko) - 6 years ago 2018-06-28 23:34:31
branko@majic.rs
MAR-129: Added information about test tools to development documentation:

- Document use of mcabber/mutt configuration files for trying out the
XMPP/mail server.
1 file changed with 31 insertions and 0 deletions:
0 comments (0 inline, 0 general)
docs/development.rst
Show inline comments
 
@@ -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
0 comments (0 inline, 0 general)