The Zimbra Collaboration Suite includes the Zimbra MTA, the Zimbra LDAP server, and the Zimbra mailbox server. In a single-server installation, all components are installed on one server and require no additional manual configuration.
This installation guide is a quick start guide that describes the basic steps needed to install and configure the Zimbra Collaboration Suite in a direct network connect environment. In this environment, the Zimbra server is assigned a domain for which it receives mail, and a direct network connection to the Internet. When the Zimbra Collaboration Suite is installed, you will be able to log on to the Zimbra administration console to manage the domain and provision accounts. The accounts you create will be able to send and receive external email.
The Zimbra Collaboration Suite is designed to be the only application suite installed on the server. The Zimbra Collaboration Suite bundles and installs, as part of the installation process various other third party and open source software, including Apache Jetty, Postfix, OpenLDAP®, and MySQL®. The versions installed have been tested and configured to work with the Zimbra
software. See the Administration Guide for a complete list of software. A Zimbra license is required in order to create accounts on the Network Edition Zimbra Collaboration Suite server. You cannot install ZCS without a license. See “Zimbra License Requirements for ZCS Network Edition” on page 9.Important: You cannot have any other web server, database, LDAP, or MTA server running, when you install the Zimbra software. If you have installed any of the applications before you install Zimbra software, disable these applications. During the ZCS install, Zimbra makes global system changes that may break applications that are on your server.
In order to successfully install and run the Zimbra Collaboration Suite, ensure your system meets the requirements described in this section. System administrators should be familiar with installing and managing email systems.
Note: To find SSH client software, go to Download.com at http://www.download.com/ and search for SSH. The list displays software that can be purchased or downloaded for free. An example of a free SSH client software is PuTTY, a software implementation of SSH for Win32 and Unix platforms. To download a copy go to
http:// putty.nl/.
Configuration modifications for two of the most frequently used operating systems, Red Hat Enterprise Linux and Fedora, are described in this guide. The SUSE configuration would be similar to those described for the Red Hat Enterprise Linux. The Mac OS requires no additional modifications.
Other operating systems may require similar modifications, use this information as a reference to gauge whether your operating system may need to be modified. Also, search the
Zimbra Forums and
Zimbra Wiki.
The Zimbra Collaboration Suite runs on the Red Hat Enterprise Linux, version 4 operating system or later. When you install the Red Hat software for the Zimbra Collaboration Suite, except for the Disk Partition Setup, the Network Configuration, the Gateway and Primary DNS addresses, the Edit Interface, and the Firewall Configuration, accept the default setup answers. Details of what should be modified in these categories are listed below. Refer to the Red Hat Enterprise Linux installation guide for detailed documentation about installing their software.
• | The Mount Point/RAID Volume size for the Boot partition ( /)should be 100 MB. |
• | The Swap partition should be set to twice the size of the RAM on your machine. |
• | The Root partition ( /) should be set with the remaining disk space size. |
• | In the Edit Interface pop-up screen, check Activate on Boot. Enter the IP Address and Netmask of the device. This allows the interface to start when you boot. |
• | Firewall Configuration should be set to No firewall, and the Security Enhanced Linux (SELinux) should be disabled. |
Important: Make sure that FQDN entry in /etc/hosts appears before the hostnames. If this is missing, the creation of the Zimbra certificate fails. The FQDN entry should look like this example. See
zmcreatecert in the
Administrator’s Guide, Appendix A: Command-Line Utilities.
The Zimbra Collaboration Suite runs on the Fedora, Core 4 operating system. When you install the Fedora software for the Zimbra Collaboration Suite, except for the Disk Partition Setup, the Network Configuration, the Gateway and Primary DNS addresses, the Edit Interface, and the Firewall Configuration, accept the default setup answers. Details of what should be modified in these categories are listed below. Refer to the Fedora installation guide for detailed documentation about installing their software.
• | The Mount Point/RAID Volume size for the Boot partition ( /) should be 100 MB. |
• | The Swap partition should be set to twice the size of the RAM on your machine. |
• | The Root partition ( /) should be set with the remaining disk space size. |
• | In the Edit Interface pop-up screen, check Activate on Boot. Enter the IP Address and Netmask of the device. This allows the interface to start when you boot. |
• | Firewall Configuration should be set to No firewall, and the Security Enhanced Linux (SELinux) should be disabled. |
• | Make sure that FQDN entry in /etc/hosts appears before the hostnames. If this is missing, the creation of the Zimbra certificate fails. The FQDN entry should look like this example. |
In order to send and receive email, the Zimbra MTA must be configured in DNS with both A and MX records. For sending mail, the MTA uses DNS to resolve hostnames and email-routing information. To receive mail, the MX record must be configured correctly to route the message to the mail server.
During the installation process, ZCS checks to see if you have an MX record correctly configured. If it is not, an error is displayed suggesting that the domain name have an MX record configured in DNS.
You must configure a relay host if you do not enable DNS. After ZCS is installed, go to the
Global Settings>MTA tab on the administration console and uncheck
Enable DNS lookups. Enter the relay MTA address to use for external delivery.
• | Zimbra Core installs the libraries, utilities, and monitoring tools. |
• | Zimbra LDAP installs the OpenLDAP software, which provides open source LDAP directory services. |
• | Zimbra MTA installs the Postfix open source MTA, the Clam AntiVirus antivirus engine, the SpamAssassin junk mail filter, and the Amavisd-New content filter. |
• | Zimbra Store installs the mailbox server, including Jetty, the servlet container for the Zimbra server. |
• | Zimbra Spell installs the Aspell open source spelling checker. |
• | Zimbra Apache is installed automatically when Zimbra Spell or Zimbra Convertd (See Note) is installed. |
• | Zimbra SNMP installs the SNMP package for monitoring. This package is optional. |
• | Zimbra Logger installs tools for syslog aggregation, reporting, and message tracing. If you do not install Logger, you cannot use the message trace feature, the server statistics are not captures, and the server statistics section of the administration console does not display. |
• | Zimbra Proxy installs the proxy feature which can be configured for POP and IMAP proxy and for reverse proxy HTTP requests. |
The Zimbra server configuration is menu driven. The installation menu shows you the default configuration values. The menu displays the logical host name and email domain name [mailhost.example.com] as configured on the computer. You can change any of the values. For single server installs, you must define the administrator’s password, which you use to log on to the administration console, and you specify the location of the Zimbra license xml file.
For the latest Zimbra software download, go to www.zimbra.com. Save the Zimbra Collaboration Suite archive file to the computer from which you will install the software.
Zimbra License Requirements for ZCS Network Edition
A Zimbra license is required in order to create accounts in the Network Edition Zimbra Collaboration Suite servers. A trial license and a regular license are available:Trial. You can obtain the trial license from the Zimbra license portal for free. The trial license allows you to create up to 50 users. It expires in 60 days.Regular. You must purchase the Zimbra Regular license. This license is valid for a specific Zimbra Collaboration Suite system and is encrypted with the number of Zimbra accounts (seats) you have purchased, the effective date, and expiration date of the regular license. Go to Zimbra’s Website to obtain a trial license from the Network Downloads area. Contact Zimbra sales to purchase a regular license, by emailing sales@zimbra.com or calling 1-650-212-7767, extension 100.The regular license can only be installed on the ZCS system for which it is purchased. Only one Zimbra license is required for your Zimbra Collaboration Suite environment.Current license information, including the number of accounts purchased, the number of accounts used, and the expiration date, can be viewed from Global Settings>License tab on the administration console.The default configuration installs the Zimbra-LDAP, the Zimbra-MTA with anti-virus and anti-spam protection, the Zimbra mailbox server, the SNMP monitoring tools (optional), Zimbra-spell (optional), the logger tool (optional), and the Zimbra proxy (optional) on one server.
The menu driven installation displays the components and their existing default values. You can modify the information during the installation process.
| |
1) Common Configuration - These are common settings for all servers |
| |
| The LDAP host name. On a single server installation, this name is the same as the hostname. |
| |
| |
Require secure interprocess communications | By default, startTLS is YES. When startTLS is enabled, there is a secure communication between amavis and postfix and the LDAP server. |
| Select the time zone to apply to the default COS. The time zone that should be entered is the time zone that the majority of users in the COS will be located in. The default time zone is PST (Pacific Time). |
|
| You can create one domain during installation and additional domains can be created from the administration console. |
| The default domain is the fully qualified hostname of the server. If you created a valid mail domain on your DNS server, enter it now. In most cases, you will accept the default. |
| |
| This is the password used by the LDAP replication user to identify itself to the LDAP master and must be the same as the password on the LDAP master server. |
| This is the password used by the postfix user to identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP master server. |
| This is the password used by the amavis user to identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP server. |
| This is the password used by the nginx user to identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP server. |
|
| The administrator account is created during installation. This account is the first account provisioned on the Zimbra server and allows you to log on to the administration console. |
| |
| You must set the admin account password. The password is case sensitive and must be a minimum of six characters. The administrator name, mail address, and password are required to log in to the administration console. |
| 1. Spam Training User to receive mail notification about mail that was not marked as junk, but should have been. 2. Non-spam (HAM) Training User to receive mail notification about mail that was marked as junk, but should not have been. These addresses are automatically configured to work with the spam training filter. The accounts created have a randomly selected name. To recognize what the account is used for, you may want to change this name. |
| The Global Documents account is automatically created when ZCS is installed. The Global Documents account holds the templates and the default Documents Notebook. The Documents feature is enabled for the COS or for individual accounts |
The default port configurations are shown | Mixed mode uses HTTPS for logging in and HTTP for normal session traffic Both mode means that an HTTP session stays HTTP, including during the login phase, and an HTTPS session remains HTTPS throughout, including the login phase. Redirect mode redirects any users connecting via HTTP to an HTTPS connection. |
| License file name | Unset (Network Edition). The license file must be saved to the server in order to add it to ZCS during the install process. Enter the name and location for the Zimbra license file to have the license installed as part of the installation. |
|
| • | MTA Auth host — This is configured automatically if the MTA authentication server host is on the same server, but must be configured if the authentication server is not on the MTA. |
• | Notification address for AV alerts — Sets the notification address for AV alerts. You can either accept the default or create a new address. If you create a new address, remember to provision this address from the admin console. |
• | Bind password for Postfix LDAP user. Automatically set.This is the password used by the postfix user to identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP master server. |
• | Bind password for Amavis LDAP user. Automatically set. This is the password used by the amavis user to identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP server. |
|
|
| |
| When installed, it is automatically enabled. Logs from the hosts are sent to the mailbox server where zimbra-logger is installed and the information is used to generate the statistics graphs and for message tracing. |
| |
This menu section lists major new features for the ZCS release and whether the feature is enabled or not. When you change the feature setting during ZCS installation, you change the default COS settings Having this control, lets you decide when to introduce new features to your users. |
Enable default backup schedule | For Network Edition only, sets the schedule for Backup session to run as a full backup every Sunday at 1 a.m. and as incremental on the other days at 1 a.m. |
| |
| When the installation and configuration is complete, if this is set to Yes, the Zimbra server is automatically started. |
| |
| |
| |
1. | Log in as root to the Zimbra server and cd to the directory where the Zimbra Collaboration Suite archive tar file is saved (cd /var/<tmp>). Type the following commands: |
The install.sh script reviews the installation software to verify that the Zimbra packages are available.
zimbra-archiving...NOT FOUND zimbra-convertd...NOT FOUND zimbra-cluster...NOT FOUND |
For the cross mailbox search feature, install the Zimbra Archive package. To use the archiving and discovery feature, contact Zimbra sales.6. | Type Y and press Enter to modify the system. The selected packages are installed on the server. |
| Install zimbra-archiving [N] N |
+Hostname: mailhost.example.com +Ldap master host: mailhost.example.com +Ldap Admin password: set +Require secure interprocess communications:yes +TimeZone: (GMT-08.00) Pacific Time (US & Canada) +Domain to create: mailhost.example.com +Ldap Replication password: set +Ldap Postfix password: set +Ldap Amavis password: set +Admin user to create: admin@mailhost.example.com +Enable automated spam training: yes +Spam training user: spam.rstn2dbcr@mailhost.example.com +Non-spam(Ham) training user: ham.bvjx1nyw@mailhost.example.com +Global Documents Account: wiki@mailhost.example.com +SMTP host: mailhost.example.com +Web server HTTP port: 80 +Web server HTTPS port: 443 +IMAP server SSL port: 993 +POP server SSL port: 995 +Use spell check server: yes +Spell server URL: http://mailhost.example.com:7780/aspell.php +License filename: UNSET |
9. | Enter 3 to select zimbra-store from the main menu. |
| **19) License filename: UNSET |
• | Type 4 and type the admin password. The password must be six or more characters. Press Enter. |
11. | Type r to return to the Main menu. |
14. | When Save Configuration data to file appears, type Yes and press Enter. |
16. | When The system will be modified - continue? appears, type Yes and press Enter. |
17. | When Configuration complete - press return to exit displays, press Enter. |
When Configuration complete! appears, the installation is finished and the server has been started.
2. | Type zmcontrol status. The services status information is displayed. All services should be running. |
See the Administration Guide, Appendix A: Command-Line Utilities for more
zmcontrol commands.
5. | The Easy Install dialog displays. Select the services to be installed on this server. To install all service packages on a single server, click Install. |
7. | To install the Zimbra license file during the ZCS install, copy the ZCSLicense.xml file to /opt/zimbra/conf. |
8. | Type cd /opt/zimbra/libexec |
9. | Type ls to see the packages in the directory. |
10. | Type ./zmsetup.pl. This starts the ZCS configuration. A temporary log file is created and the server port configurations are checked for conflicts. The installation process checks to see if Sendmail, Postfix, and MySQL software are running. If any of these applications are running, you are asked to disable them. Disabling MySQL is optional but highly recommended. Sendmail and Postfix must be disabled for the Zimbra Collaboration Suite to start correctly. |
The open source nginx proxy is bundled as part of the zimbra-proxy package, and this package can be installed on ZCS servers, or on their own independent servers. When the zimbra-proxy package is installed, the proxy feature is enabled.
• | Nginx. A high performance IMAP/POP3 proxy server which handles all incoming POP/IMAP requests. |
• | Memcached. A high performance, distributed memory object caching system. Route information is cached for further use in order to increase performance. |
• | Zimbra Proxy Route Lookup Handler. This is a servlet located on the ZCS mailbox server. This servlet handles queries for the user account route information (the server and port number where the user account resides). |
Once the mailbox server is running, open your browser, enter the administration console URL and log on to the console to provision email accounts. The administration console URL is entered as:
The first time you log on, a certificate authority (CA) alert may be displayed. Click
Accept this certificate permanently to accept the certificate and be able connect to the Zimbra administration console. Then click
OK.
2. | Click New. The first page of the New Account Wizard opens. |
4. | You can click Finish at this point, and the account is configured with the default COS and global features. |
Zimbra developed different applications to facilitate moving a user’s email messages, calendars, and contacts from their old email servers to their accounts on the Zimbra server. When the user’s files are imported, the folder hierarchy is maintained. Use one of the ZCS utilities to move user mail to ZCS to guarantee that all information is imported correctly.
The following applications can be accessed from the administration console Download page, and instruction guides are available from the Help Desk page or from the Zimbra Website, Documents page.
• | Zimbra Collaboration Suite Import Wizard for Outlook®. Format is an .exe file. Users download the Import Wizard to their computers and run the executable file to import their Outlook .pst files to the Zimbra server. Before users run this utility, Zimbra recommends that they run the Outlook Inbox Repair tool, scanpst.exe, on their .pst files, to clean up any errors in their file. For more information about this tool, go to http://support.microsoft.com/kb/287497. |
Initial administrative tasks when you log on for the first time may include setting up the admin mailbox to include features, aliases, and forwarding addresses needed for the administrator’s working environment.
• | Postmaster. The postmaster address is displayed in emails that are automatically generated from Postfix when messages cannot be sent . If users reply to this address, the message is forwarded to the admin mailbox. |
• | Root. This address is where notification messages from the operating system are sent. |
To uninstall servers, run the install script
-u, delete the zcs directory, and remove the
zcs.tgz file on the servers.
1. | cd to the original install directory for the zcs files. |
3. | When Completely remove existing installation? is displayed, type Yes. |
4. | Type rm -rf [zcsfullfilename] to delete the ZCS directory. |
To learn more about the Zimbra Collaboration Suite, read the Administrator’s Guide and Help. The Zimbra guides and release notes in .pdf format can be found in the
opt/zimbra/docs directory and is also available from the administration console Help button and from the Zimbra Website.
• | Administrator’s Guide. This guide describes product architecture, server functionality, administration tasks, configuration options, and backup and restore procedures. The guide is available in pdf format from the administrator’s console, and in HTML format on the Zimbra Website. |
• | Administrator Help. The administrator Help provides detailed instructions about how to add and maintain your servers, domains, and user accounts from the admin console. |
Visit www.zimbra.com to join the community and to be a part of building the best open source messaging solution. We appreciate your feedback and suggestions.
• | Join the Zimbra Community Forums, to participate and learn more about the Zimbra Collaboration Suite. |
If you encounter problems with this software, visit www.zimbra.com and submit a bug report. Make sure you provide enough detail so that the bug can be easily duplicated.
Copyright © 2008 Zimbra Inc.
