4. Installation¶
4.1. Requirements¶
To deploy the Kopano Archiver at least two servers are required: one primary Kopano Core server and one Kopano Archive server. Multi-server technology is used to connect archives to users automatically.
Note
A multi-server setup requires a central LDAP or Active Directory. It’s not possible to use multi-server with the DB or unix user plugin.
4.1.1. Software Requirements¶
- Kopano Core 8+
- Multi-server Kopano setup with LDAP or ADS (please refer to the Kopano Core Administrator manual for more information on how to setup a Multi-Server Environment which you can find here:)
- Kopano subscription including Archiver component
4.1.2. Required Packages¶
The following Kopano packages are required on a primary node:
- kopano-client
- kopano-dagent (for LMTP only)
- kopano-search or kopano-indexer
- kopano-server
- kopano-spooler
- kopano-utils
The following Kopano packages are required on an archive node:
- python-mapi
- kopano-client
- kopano-common
- kopano-libarchiver
- kopano-libs
- kopano-server
- kopano-utils
4.2. Installation¶
The Kopano Archiver software can be found on the Kopano Portal as an additional download or installed via the Kopano repository archiver: The Kopano Archiver download will include the following package:
- kopano-archiver containing the Archive controller and configuration files
4.2.1. Default installation location¶
The Kopano Archiver packages can be installed on any node in a multi-server setup. However, installing the packages on the archive node is recommended.
4.2.1.1. RPM based distributions¶
Use the following command to install the kopano-archiver package on RPM based distributions:
rpm -Uvh kopano-archiver_<version>_<platform>.rpm
Replace <version> with the correct version and <platform> with the required target platform (i386, i586, x86_64).
4.2.1.2. DEB based distributions¶
On Debian based distributions use:
dpkg -i kopano-archiver_<version>_<platform>.deb
Replace <version> with the correct version and <platform> with the required target platform (i386, x86_64).
4.3. Basic Configuration¶
Kopano Archiver is configured by default in /etc/kopano/archiver.cfg. If the default configuration file is not found, Archiver will try to work with default configuration settings, which will most probably fail. Archiver will display an error message like “Unable to open admin session on server https://192.168.1.10:237/kopano” and close.
An alternative configuration file may be specified by using command line option --config. When such a configuration file is specified and cannot be found, Archiver will emit an error message like: “Unable to open configuration file /tmp/test.cfg” and close.
4.3.1. Connection Parameters¶
As with all Kopano components, kopano-archiver needs to know where to connect to and how to authenticate. This is configured using the server_socket, sslkey_file and sslkey_pass settings.
For instance:
server_socket = file:///var/run/kopano/server.sock
Or when running the archiver an a different server:
server_socket = https://servername:237/kopano
sslkey_file = /etc/kopano/ssl/client.pem
sslkey_pass = secret
Note
Under normal circumstances kopano-archiver will connect to a local server through the file socket.
4.3.2. MySQL Settings¶
kopano-archiver uses one central MySQL database for managing deduplication of archived attachments. MySQL settings can be configured like this:
mysql_host = localhost
mysql_port = 3306
mysql_user = kopano
mysql_password = password
mysql_socket =
mysql_database = kopano_archiver
This database should not be the same one that kopano-server is using and needs to be accessible over the network from each server running the kopano-archiver command.