Ansible role squirrelmail

An Ansible role which sets up squirrelmail on servers that run RedHat. Specifically, the responsibilities of this role are to:

• Install necessary packages
• Manage configuration
• Manage SELinux, when it is enabled

When the installation is completed, the homepage of squirrelmail can be seen on your hostmachine by following the link IP address of your local machine/squirrelmail

Requirements

Ports required to be opened on the firewall (if you decide to use bertvv.rhbase):

  rhbase_firewall_allow_services:
    - pop3s
    - imaps
    - httpd

Users can be created using the following syntax (if you decide to use bertvv.rhbase). The shell parameter creates users that can login on the squirrelmail web interface but not into the Linux machine.

  rhbase_users:
    - name: johndoe
      password: '$6$WIFkXf07Kn3kALDp$fHbqRKztuufS895easdT [...]'
      shell: /sbin/nologin

The following tasks need to be declared in the site.yml file under post_tasks. These tasks install various plugins and add a line to the DNS file in /etc/hosts so you can properly use Squirrelmail:

post_tasks:
  - name: Add imap host to /etc/hosts
    lineinfile:
      dest: /etc/hosts
      line: "172.16.128.135 mail.green.local"
  - seboolean:
      name: httpd_can_sendmail
      state: yes
      persistent: yes
  - name: Download compatibility plugin
    get_url:
      url: http://www.squirrelmail.org/plugins/compatibility-2.0.16-1.0.tar.gz
      dest: $HOME/
  - name: Download empty_trash plugin
    get_url:
      url: http://www.squirrelmail.org/plugins/empty_trash-2.0-1.2.2.tar.gz
      dest: $HOME/
  - name: Download secure_login plugin
    get_url:
      url: http://www.squirrelmail.org/plugins/secure_login-1.4-1.2.8.tar.gz
      dest: $HOME/
  - name: Extract compatibility plugin
    unarchive:
      src: $HOME/compatibility-2.0.16-1.0.tar.gz
      dest: /usr/share/squirrelmail/plugins
      remote_src: yes
  - name: Exctract empty_trash plugin
    unarchive:
      src: $HOME/empty_trash-2.0-1.2.2.tar.gz
      dest: /usr/share/squirrelmail/plugins
      remote_src: yes
  - name: Extract secure_login plugin
    unarchive:
      src: $HOME/secure_login-1.4-1.2.8.tar.gz
      dest: /usr/share/squirrelmail/plugins
      remote_src: yes
  - name: Packages clean up
    file:
      state: absent
      path: $HOME/*.tar.gz

Role Variables

Dependencies

• bertvv.httpd provides PHP support for Squirrelmail.

• bertvv.mailserver provides dovecot and postfix services required for Squirrelmail to work if Dovecot and Postfix are used. It is possible to use this role with another IMAP provider, which include: bincimap, courier, cyrus, dovecot, exchange, hmailserver, macosx, mercury32, uw, gmail, other. These services must be defined in the YML file the way they are written here.

• bertvv.rhbase can be used to open the necessary firewall ports and to create users for the mail server.

Example Playbook

See the test playbooks in either the Vagrant or Docker test environment. See the section Testing for details.

Testing

There are two types of test environments available. One powered by Vagrant, another by Docker. The latter is suitable for running automated tests on Travis-CI. Test code is kept in separate orphan branches. For details of how to set up these test environments on your own machine, see the README files in the respective branches:

• Vagrant: vagrant-tests
• Docker: docker-tests

Contributing

Issues, feature requests, ideas are appreciated and can be posted in the Issues section.

Pull requests are also very welcome. The best way to submit a PR is by first creating a fork of this Github project, then creating a topic branch for the suggested change and pushing that branch to your own fork. Github can then easily create a PR based on that branch. Don't forget to add your name to the contributor list below!

License

2-clause BSD license, see LICENSE.md

Contributors

• Bert Van Vreckem (maintainer)
• Robin Roelandt
• Florian Van Steen
• Jolan van Impe