help centre
For more info visit status.atmail.com

How can we help?


Search our knowledge base for answers to
common questions and latest updates.



My activities New request

Follow

atmail suite installation guide

Stewart -

PROBLEM

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

ENVIRONMENT

  • atmail suite

CAUSE

Installation requirement.

RESOLUTION

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.

Download

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.

portal-downloads.png

Installation notes

  1. Extract the atmail-suite-rpm.tar.gz package.
    [root@localhost tmp]# tar xvzf atmail-suite-rpm.tar.gz
    atmail-suite-[version]/
    atmail-suite-[version]/atmail-dav[version].el7.centos.x86_64.rpm
    atmail-suite-[version]/atmail-webmail[version].el7.centos.x86_64.rpm
    atmail-suite-[version]/atmail-common[version].centos.x86_64.rpm
    atmail-suite-[version]/atmail-api[version].el7.centos.x86_64.rpm
  2. Enter the atmail-suite directory.
    [root@localhost tmp]# cd atmail-suite-[version]
    [root@localhost atmail-suite-[version]]#
  3. 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 ]
  4. 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) <epel@fedoraproject.org>"
    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 5.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.
    Run:
    /usr/bin/atmail-api-install
    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/atmail-apiadmin.sh
    11. Create an admin user by running the following.
      apiadmin user add <username> <passwd> --role=admin
  6. Restart API service
    systemctl restart apiserver
  7. 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. Run /usr/bin/atmail-webmail-configure
      1. Enter URL Hostname for atmail services [ localhost.localdomain ] :
      2. Configure NginX [ yes ] :
    1. Configure the atmail webmail
  8. 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. Run /usr/bin/atmail-dav-install
      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 ] :

  9. Restart services.
    [root@localhost ]# systemctl restart apiserver
    [root@localhost ]# systemctl restart php-fpm
    [root@localhost ]# systemctl restart nginx
  10. atmail suite installation complete! Access your installation via your URL hostname slash webmail.
    https://yourhostname.com/login/

Post-installation notes

apiserver

After a successful installation of atmail suite, the apiserver may fail to start on boot even while enabled. This is due to the apiserver trying to initialise itself before mariadb on startup. To amend this, please find the below solution.

  1. Create a systemd directory for the apiserver.
    mkdir /etc/systemd/system/apiserver.service.d/
  2. Create a depends.conf file in the newly created directory containing the following contents.
    [root@tesbox ~]# cat /etc/systemd/system/apiserver.service.d/depends.conf 
    [Unit]                                                                                              
    Requires=mariadb.service                                                                            
    After=mariadb.service
  3. Check that your apiserver is enabled.
    [root@tesbox ~]# systemctl is-enabled apiserver
    enabled
  4. Perform reboot and then check: 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 Wed 2017-07-19 12:47:50 AEST; 1s ago
         Docs: http://www.atmail.com/
      Process: 3845 ExecStop=/bin/kill -s QUIT $MAINPID (code=exited, status=0/SUCCESS)
     Main PID: 3847 (apiserver)
       CGroup: /system.slice/apiserver.service
               └─3847 /usr/bin/apiserver -config /etc/atmail/api/api.conf

    Jul 19 12:47:50 a8 systemd[1]: Started atmail-api - jmap api for atmail webmail.
    Jul 19 12:47:50 a8 systemd[1]: Starting atmail-api - jmap api for atmail webmail...

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

Comments


Contact our support team


+61 (7) 5357 6605       support@atmail.com