How can we help?


atmail suite installation and upgrade guide

Stewart -


How can I install the atmail suite onto my own server?


  • atmail suite


Installation requirement.


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

Pre-installation notes

System requirements

Before you install the atmail suite, please make sure you meet the minimum system requirements.


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 and Upgrade Notes

The following instructions are equally applicable to a new installation and upgrade.

  1. If an upgrade, update to the latest base packages supplied by CentOS to ensure all the latest security and stability packages are applied:
  2. [root@localhost tmp]# yum update -y mariadb mariadb-server openssl openssl-libs exim nginx php php-fpm
    If you are using redis (optional):
  3. [root@localhost tmp]# yum update -y redis
  4. Extract the atmail-suite-rpm.tar.gz package.
    [root@localhost tmp]# tar xvzf atmail-suite-rpm.tar.gz
  5. Enter the atmail-suite directory.
    [root@localhost tmp]# cd atmail-suite-[version]
    [root@localhost atmail-suite-[version]]#
  6. Use yum to install the atmail-common rpm.
    [root@localhost atmail-suite[version]]# yum install atmail-common[version].el7.centos.x86_64.rpm -y -q
        Creating group atmail ..... [ OK ]
        Creating user atmail ..... [ OK ]
        Switching SELinux to permissive mode ..... [ OK ]
  7. Use yum to install the atmail-api rpm.
    [root@localhost atmail-suite[version]]# yum install atmail-api[version].el7.centos.x86_64.rpm -y -q
    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
  8. If a new new installation, 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.
      apiadmin user add <username> <passwd> --role=admin
  9. If this is an upgrade, stop the API server and perform a database schema update like so:
    [root@localhost atmail-suite[version]]# systemctl stop apiserver
    [root@localhost atmail-suite[version]]# apiserver -config /etc/atmail/api/api.conf --updatedb <..snip..>INFO[0002] Migrations file pairs found: XXWhen you see this line above, hit Ctrl-C (^C) to exit, as all schema updates have been performed.
  10. Restart API service
    [root@localhost atmail-suite[version]]# systemctl restart apiserver
  11. Check the status of apiserver and ensure it is active and running.
  12. [root@localhost atmail-suite[version]]# 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
  13. Use yum to install the atmail-webmail rpm.
    [root@localhost atmail-suite-[version]]# yum install atmail-webmail[version].el7.centos.x86_64.rpm -y -q
    1. If a new installation, 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 ] :
  14. OPTIONAL: Use yum to install the atmail-dav rpm.
    [root@localhost atmail-suite-[version]]# yum install atmail-dav[version].el7.centos.x86_64.rpm -y -q
    Generating self-signed cert
    1. If a new installation, 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 ] :
  15. Restart services.
    systemctl restart php-fpm
    systemctl restart nginx
  16. atmail suite installation complete! Access your installation via your URL hostname slash webmail.

Post-installation notes

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