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
 
@@ -608,24 +608,55 @@ In order to deploy the test site, the following steps would normally be taken:
 
   ``ws01.example.com`` is meant to run *Debian 9 Stretch* (althogh, Debian
 
   Jessie should function as well).
 

	
 
10. Add the SSH host fingerprints to your ``known_hosts`` file (don't forget to
 
    remove old entries if you are redoing the process). You can easily obtain all
 
    the necessary fingerprints with command (don't forget to modify domain if you
 
    need to):
 

	
 
    .. code-block:: shell
 

	
 
      ssh-keyscan -t ed25519 mail.example.com ldap.example.com xmpp.example.com web.example.com backup.example.com ws01.example.com $(resolveip -s mail.example.com) $(resolveip -s ldap.example.com) $(resolveip -s xmpp.example.com) $(resolveip -s web.example.com) $(resolveip -s backup.example.com) $(resolveip -s ws01.example.com)
 

	
 
11. Invoke the ``bootstrap.yml`` playbook in order to set-up some basic
 
    environment for Ansible runs on all servers:
 

	
 
    .. code-block:: shell
 

	
 
       ansible-playbook playbooks/bootstrap.yml
 

	
 
12. Finally, apply configuration on all servers:
 

	
 
    .. 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)