Kopano Core Administrator Manual

Edition 8.3.0 - Kopano Team

This document, the Kopano Core Administrator Manual, describes how to install, upgrade, configure and maintain KC on your system. In addition various advanced configurations and integration options are covered.

Table of contents

• 1. Abstract
• 2. Introduction
  • 2.1. Intended Audience
  • 2.2. Architecture
  • 2.3. Components
  • 2.4. Protocols and Connections
    • 2.4.1. SOAP
    • 2.4.2. Secure HTTP (HTTPS)
• 3. Installing
  • 3.1. System Requirements
    • 3.1.1. Hardware Recommendations
    • 3.1.2. Connection/bandwidth Recommendation
    • 3.1.3. Supported Platforms
    • 3.1.4. Dependencies
  • 3.2. Installation
    • 3.2.1. Installing Kopano Core through the Kopano package repositories
    • 3.2.2. Manually Installing the individual Packages
      • 3.2.2.1. RPM-based distributions
      • 3.2.2.2. DEB-based distributions
  • 3.3. Troubleshooting Installation Issues
    • 3.3.1. Server processes
    • 3.3.2. SELinux
  • 3.4. SSL
• 4. Upgrading
  • 4.1. Preparing
    • 4.1.1. Database Attachments
      • 4.1.1.1. Configuring storage method
      • 4.1.1.2. Migrating database attachments to files
      • 4.1.1.3. Storage layout
  • 4.2. Creating backups
    • 4.2.1. Consistent backups
  • 4.3. KC 8 dependencies
  • 4.4. Performing the Upgrade on RPM based distributions
  • 4.5. Performing the Upgrade on Debian based distributions
  • 4.6. Finalizing the upgrade
• 5. Configure KC Components
  • 5.1. Configure the Kopano Server
    • 5.1.1. Configure language for store creation
    • 5.1.2. User Authentication
      • 5.1.2.1. The DB Authentication Plugin
      • 5.1.2.2. The Unix Authentication Plugin
      • 5.1.2.3. The LDAP Authentication Plugin
    • 5.1.3. Autoresponder
    • 5.1.4. Storing attachments outside the database
    • 5.1.5. SSL connections and certificates
  • 5.2. Configure Kopano Konnect
    • 5.2.1. Configuration
    • 5.2.2. Configure a Webserver for Konnect
    • 5.2.3. Configure 3rd Party Applications to Authenticate using Konnect
      • 5.2.3.1. Using Kopano Konnect to sign into Nextcloud
      • 5.2.3.2. Using Kopano Konnect to sign into services supporting ID4me
  • 5.3. Configure Kopano Kraph
    • 5.3.1. Configuration
    • 5.3.2. Configure a Websever for Kopano Kraph
  • 5.4. Configure the Kopano Spooler
    • 5.4.1. Configuration
  • 5.5. Configure Kopano Caldav
    • 5.5.1. SSL/TLS for CalDAV
  • 5.6. Configure Kopano Gateway (IMAP and POP3)
    • 5.6.1. SSL/TLS for Gateway
      • 5.6.1.1. Important notes
  • 5.7. Configure Kopano Quota Manager
    • 5.7.1. Setup server-wide quota
    • 5.7.2. Setup quota per user
    • 5.7.3. Monitoring for quota exceeding
    • 5.7.4. Quota warning templates
  • 5.8. Configure Kopano Search
    • 5.8.1. Enabling the search service
    • 5.8.2. Search configuration
    • 5.8.3. Attachments
  • 5.9. Configure Kopano WebApp
    • 5.9.1. Configure the Webserver
      • 5.9.1.1. Installing php-mapi
  • 5.10. Configure Kopano for user management with LDAP (e.g. OpenLDAP/ADS)
    • 5.10.1. Configuring OpenLDAP to use the Kopano schema
    • 5.10.2. Configure LDAP indices in OpenLDAP
    • 5.10.3. Configuring ADS to use the Kopano schema
    • 5.10.4. Configuring Kopano for users stored in LDAP
    • 5.10.5. Fine-tuning user configuration
    • 5.10.6. Fine-tuning group configuration
    • 5.10.7. Addresslist configuration
    • 5.10.8. Testing LDAP configuration
  • 5.11. Postfix integration
    • 5.11.1. Configure Kopano-dagent for delivery via unix socket
    • 5.11.2. Configure Postfix integration with OpenLDAP
    • 5.11.3. Configure KC Postfix integration with Active Directory
    • 5.11.4. Configure KC Postfix integration with virtual users
    • 5.11.5. Configure KC Postfix integration with the DB plugin
  • 5.12. Configure Z-Push (ActiveSync for Mobile Devices)
    • 5.12.1. Compatibility
    • 5.12.2. Security
    • 5.12.3. Installation
    • 5.12.4. Mobile Device Management
    • 5.12.5. Limiting Access to Certain Users
    • 5.12.6. Upgrade
    • 5.12.7. S/MIME
    • 5.12.8. Configuring SSL for Windows Mobile and Windows Phone
    • 5.12.9. Troubleshooting
      • 5.12.9.1. General configuration
      • 5.12.9.2. Synchronization problems
      • 5.12.9.3. Log messages
• 6. Special KC Configurations
  • 6.1. Running KC components beyond localhost
  • 6.2. Multi-tenancy configurations
    • 6.2.1. Support user plugins
    • 6.2.2. Configuring the server
      • 6.2.2.1. Enabling Multi-tenancy
      • 6.2.2.2. Configuring login name
      • 6.2.2.3. Configuring store name
      • 6.2.2.4. Configuring the LDAP plugin
      • 6.2.2.5. Public stores
    • 6.2.3. Managing tenant (company) spaces
    • 6.2.4. Managing users and groups
    • 6.2.5. Quota levels
    • 6.2.6. Administrator users
  • 6.3. Multi-server setup
    • 6.3.1. Introduction
    • 6.3.2. Prepare / setup the LDAP server for multi-server setup
    • 6.3.3. Configuring the servers
    • 6.3.4. Creating SSL certificates
  • 6.4. Single Instance Attachment Storage
    • 6.4.1. Single Instance Attachment Storage and LMTP
  • 6.5. Single Sign On with KC
    • 6.5.1. NTLM SSO with ADS
      • 6.5.1.1. Installing Linux software
      • 6.5.1.2. ADS: Specific network setup
      • 6.5.1.3. Configuring the Kerberos library
      • 6.5.1.4. Joining the ADS domain
    • 6.5.2. NTLM SSO with Samba 3
      • 6.5.2.1. Installing Linux software
      • 6.5.2.2. Joining the domain
    • 6.5.3. SSO with Kerberos
      • 6.5.3.1. Requirements and Conventions
      • 6.5.3.2. Active Directory configuration
      • 6.5.3.3. Kerberos configuration
      • 6.5.3.4. Kopano Server configuration
      • 6.5.3.5. Apache configuration (for SSO with WebApp)
      • 6.5.3.6. WebApp configuration
      • 6.5.3.7. Browser configuration
    • 6.5.4. Up and running
  • 6.6. Tracking messages with Kopano Archiver
    • 6.6.1. Archive on delivery
    • 6.6.2. Archive on send
  • 6.7. Kopano Python plugin framework
    • 6.7.1. How it works
    • 6.7.2. General Options
    • 6.7.3. How to use
    • 6.7.4. Kopano-DAgent plugins
      • 6.7.4.1. Move to public
      • 6.7.4.2. BMP2PNG converter
    • 6.7.5. Kopano-Spooler plugins
      • 6.7.5.1. Disclaimer
    • 6.7.6. Troubleshooting
      • 6.7.6.1. Log explanation
      • 6.7.6.2. Problem - Solution
  • 6.8. Running KC multi-server behind Reverse Proxy
    • 6.8.1. Description of redirection problem
    • 6.8.2. Setup Prerequisites
    • 6.8.3. Example Setup with Apache
      • 6.8.3.1. Configuring Apache
      • 6.8.3.2. Adding attribute to Servers
      • 6.8.3.3. Configuring Kopano Server
  • 6.9. Running KC with Active Directory in multi-forest environment
  • 6.10. Configuring kopano-spamd for automatic spam/ham learning
• 7. Managing KC Components
  • 7.1. Starting the services
    • 7.1.1. Stopping the services
    • 7.1.2. Reloading service configuration
  • 7.2. Logging options
  • 7.3. Security logging
    • 7.3.1. Logging items
      • 7.3.1.1. Startup
      • 7.3.1.2. Signals
      • 7.3.1.3. Authentications
      • 7.3.1.4. Authentications with impersonation
      • 7.3.1.5. Sharing actions
      • 7.3.1.6. Log parsing
      • 7.3.1.7. Not logged
    • 7.3.2. Configuration
  • 7.4. Kopano statistics monitoring
  • 7.5. Soft Delete system
• 8. User Management
  • 8.1. Public folder
  • 8.2. General usage of kopano-admin tool
    • 8.2.1. Listing users
    • 8.2.2. Displaying details
    • 8.2.3. Reattaching stores from deleted users
    • 8.2.4. Additional commands and further information
  • 8.3. Users management with DB plugin
    • 8.3.1. Creating users with DB plugin
    • 8.3.2. Non-active users
    • 8.3.3. Updating user information with DB plugin
    • 8.3.4. Deleting users with DB plugin
    • 8.3.5. Configuring ‘Send as’ permissions
    • 8.3.6. Groups
      • 8.3.6.1. Creating groups with the DB plugin
  • 8.4. Users management with UNIX plugin
    • 8.4.1. Creating users with Unix plugin
    • 8.4.2. Non-active users
    • 8.4.3. Updating user information with Unix plugin
    • 8.4.4. Deleting users with Unix plugin
    • 8.4.5. Configuring ‘Send as’ permissions
    • 8.4.6. Groups with Unix plugin
      • 8.4.6.1. Creating groups with the Unix plugin
  • 8.5. User Management with LDAP or Active Directory
    • 8.5.1. The Kopano user synchronization principle
      • 8.5.1.1. Add/Remove events
      • 8.5.1.2. Group membership
      • 8.5.1.3. LDAP server dependency
      • 8.5.1.4. Setting up the LDAP repository
    • 8.5.2. User management from OpenLDAP
      • 8.5.2.1. Creating users using OpenLDAP
      • 8.5.2.2. Creating groups using OpenLDAP
      • 8.5.2.3. Creating contacts using OpenLDAP
      • 8.5.2.4. Configuring sendas permissions using OpenLDAP
      • 8.5.2.5. Setup addresslists in OpenLDAP
      • 8.5.2.6. Hide information from Global Address Book with OpenLDAP
  • 8.6. LDAP Condition examples
  • 8.7. Kopano Feature management
    • 8.7.1. Globally enabling features
    • 8.7.2. Per-user en- or disabling features
  • 8.8. Resource configuration
    • 8.8.1. Resource booking methods
    • 8.8.2. Meeting request (MR) booking
  • 8.9. Out of office management
• 9. Performance Tuning
  • 9.1. Hardware Considerations
    • 9.1.1. Memory usage
    • 9.1.2. Hardware considerations
    • 9.1.3. More Memory is More Speed
    • 9.1.4. RAID 1/10 is faster than RAID 5
    • 9.1.5. High rotation speed (RPMs) for better database performance
    • 9.1.6. Hardware RAID
  • 9.2. Memory Usage setup
    • 9.2.1. Kopano’s Cell Cache (cache_cell_size)
    • 9.2.2. Kopano’s object cache (cache_object_size)
    • 9.2.3. Kopano’s indexedobject cache (cache_indexedobject_size)
    • 9.2.4. MySQL innodb_buffer_pool_size
    • 9.2.5. MySQL innodb_log_file_size
    • 9.2.6. MySQL innodb_log_buffer_size
    • 9.2.7. MySQL query_cache_size
    • 9.2.8. MySQL innodb_file_per_table
    • 9.2.9. MySQL max_allowed_packet
  • 9.3. Setup of modules on different servers
• 10. Backup & Restore
  • 10.1. Softdelete restore
  • 10.2. Full database dump
    • 10.2.1. SQL dump through mysqldump
    • 10.2.2. Binary data dump via LVM Snapshotting
    • 10.2.3. Attachments backup
  • 10.3. Brick-level backups
    • 10.3.1. kopano-backup vs. zarafa-backup
• 11. High Availability
  • 11.1. High Availability example setups
  • 11.2. Installing
    • 11.2.1. System Requirements
    • 11.2.2. Installation
      • 11.2.2.1. Network configuration
      • 11.2.2.2. Package installation
    • 11.2.3. Cluster configuration
      • 11.2.3.1. Corosync configuration
  • 11.3. DRBD device initialization
  • 11.4. Pacemaker configuration
  • 11.5. Testing configuration
  • 11.6. Testing a node failure
  • 11.7. Testing a resource failure
  • 11.8. Getting more information
• 12. Release Notes
  • 12.1. Release notes for 8.5.0 (2018-02-05)
  • 12.2. Release notes for 8.4.7
  • 12.3. Release notes for 8.4.6 (2018-02-02)
  • 12.4. Release notes for 8.4.5 (2017-12-15)
  • 12.5. Release notes for 8.4.4 (2017-11-23)
  • 12.6. Release notes for 8.4.3 (2017-11-07)
  • 12.7. Release notes for 8.4.2 (2017-11-02)
  • 12.8. Release notes for 8.4.1 (2017-11-01)
  • 12.9. Release notes for 8.4.0 (2017-10-30)
  • 12.10. Release notes for 8.3.5 (unreleased/state of 2017-10-31)
  • 12.11. Release notes for 8.3.4 (2017-09-01)
  • 12.12. Release notes for 8.3.3 (2017-08-09)
  • 12.13. Release notes for 8.3.2 [2017-07-06]
  • 12.14. Release notes for 8.3.1 [2017-06-20]
  • 12.15. Release notes for 8.3.0 [2017-04-27]
  • 12.16. Release notes for 8.2.0 [2017-02-17]
  • 12.17. Kopano Core 8.1.0
  • 12.18. Kopano Core 8.0.1
• 13. Compiling from source
  • 13.1. Installing Kopano Core from Source
    • 13.1.1. Requirements
  • 13.2. Installing Kopano MMC Snap-in from Source
    • 13.2.1. Requirements
    • 13.2.2. Download the source code
    • 13.2.3. Download and install Microsoft Build Tools 2015
    • 13.2.4. Download NuGet
    • 13.2.5. Download and install .NET Framework 4.6 Software Development Kit
    • 13.2.6. Build the binaries
    • 13.2.7. Register the binaries
    • 13.2.8. Verify installation
• 14. Appendix A: Upgrade strategies
  • 14.1. Upgrade from Zarafa Collaboration Platform
• 15. Appendix B: LDAP attribute description
• 16. Appendix C: Example LDIF
• 17. Appendix D: Common MAPI Errors
• 18. Legal Notice