How can we help?


Single Node: atmail suite installation

Shaun Alberts -

What is atmail suite

atmail suite is a browser-based email client and comprised the email client and JMAP API.  This can be integrated with atmail DAV to provide contacts and calendar as well.

Purpose of this guide

The atmail suite installation files can be used to set up webmail mode of atmail. This document will illustrate how to configure the webmail software from these files. 


If you are installing both mail server and atmail suit on the same node it please start with the installation of atmail suite first. 

Pre-installation notes

System requirements

Before you install the atmail suite, please make sure you meet the minimum system requirements.  After returning to this guide from the system requirements section, postfix should have been removed, a working MariaDB instance should be set up and OpenSSL should be installed.  If you have not performed all these steps please navigate back to system requirements.


If you have not already done so, please follow the firewalld guide in the configuration section as this will ensure that the correct ports are opened.  By default, all ports other than 22 will be closed.


First signup as an atmail evaluation user or login to your pre-existing atmail customer portal account. Download the atmail suite - webmail software package from within the atmail client portal.


Installation Notes

  1. Extract the atmail-suite-rpm.tar.gz package.
    # tar xvzf atmail-suite-rpm.tar.gz
  2. Enter the atmail-suite directory.
    # cd atmail-suite-[version]
    [root@localhost atmail-suite-[version]]#
  3. Use yum to install the atmail-common rpm.
    # yum install atmail-common-[version].el7.centos.x86_64.rpm -y
        Creating group atmail ..... [ OK ]
        Creating user atmail ..... [ OK ]
        Switching SELinux to permissive mode ..... [ OK ]
  4. Use yum to install the atmail-api rpm.
    # yum install atmail-api-[version].el7.centos.x86_64.rpm -y
    warning: /var/cache/yum/x86_64/7/epel/packages/nginx-1.10.2-1.el7.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID 352c64e5: NOKEY
    Public key for nginx-1.10.2-1.el7.x86_64.rpm is not installed
    Importing GPG key 0x352C64E5:
    Userid     : "Fedora EPEL (7) <>"
    Fingerprint: 91e9 7d7c 4a5e 96f1 7f3e 888f 6a2f aea2 352c 64e5 Package    : epel-release-7-9.noarch (@extras)
    From       : /etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-7
    Remove /etc/atmail/api/.master on slave nodes
  5. Configure the atmail API server. Please note that your browser will need to resolve the entry placed in the URL Hostname field. In the example below, your browser will try resolve https://atmail8test/webmail. If testing, the easiest way is to use the servers IP address.
    1. Enter DB Host [ localhost ] :
    2. Enter DB Port [ 3306 ] :
    3. Enter DB user that has create user/grant access [ root ] :
    4. Enter root password [  ] :
    5. Enter URL Hostname where atmail services will be found [ atmail8test ] :
    6. Will the API provision contacts/calendars [ yes ] :
      DAV provisioning has been enabled - you will need to update api.conf with details provided by dav install
    7. Enter your atmail ID :
    8. Enter you licence key :
    9. Configure NginX [ yes ] :
    10. Source the apiadmin profile:
      # source /etc/profile.d/
    11. Create an admin user by running the following.  (This will be needed when integrating with atmail suite).
      apiadmin user add <username> <passwd> --role=admin
  6. Restart API service
    # systemctl restart apiserver
  7. Check the status of apiserver and ensure it is active and running.
  8. # systemctl status apiserver
    ● apiserver.service - atmail-api - jmap api for atmail webmail
    Loaded: loaded (/usr/lib/systemd/system/apiserver.service; enabled; vendor preset: disabled)
    Active: active (running) since Fri 2019-11-08 10:10:30 AEST; 2s ago
  9. Use yum to install the atmail-webmail rpm.
    # yum install atmail-webmail-[version].el7.centos.x86_64.rpm -y
    1. Configure the atmail webmail
      1. Enter URL Hostname for atmail services [ localhost.localdomain ] :
      2. Enter brand name for webmail (will be shown in browser tab/title bar) [ ] :
      3. Configure NginX [ yes ] :
  10. OPTIONAL: Use yum to install the atmail-dav rpm.
    # yum install atmail-dav-[version].el7.centos.x86_64.rpm -y 
    Generating self-signed cert
    1. Configure the atmail DAV service
      1. Enter DB Host [ localhost ] :
      2. Enter DB Port [ 3306 ] :
      3. Enter DB user that has create user/grant access [ root ] :
      4. Enter root password [  ] :
      5. Configure NginX [ yes ] :
      6. Configure PHP-FPM [ yes ] :
      7. Would you like the api.conf updated to include dav DSN yes/no [ yes ] :
  11. Restart services.
    # systemctl restart php-fpm nginx apiserver
  12. atmail suite installation complete! Access your installation via your URL hostname slash webmail.

    This install uses self-signed certificates, the browser may warn you that the certificate is not trusted, please acknowledge the browser warning and proceed to the admin site.  To configure a new certificate use this guide as a reference.

Post-installation notes

Dav Integration

If installing atmail-dav for contacts and calendars, the invites for an out the box install will not work as the dav sender needs to be set in the dav confilg file.  Please follow this link to find the guide explaining how to do this.

Further documentation for api.conf and apiadmin can be found below:

It is recommend you visit the below for further configuration of your installation:

Have more questions? Submit a request


Contact our support team

+61 (7) 5357 6605