Difference between revisions of "Kerio Connect Integration"

[unchecked revision][checked revision]
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Synchronizing User Accounts with a Kerio Connect User Database =
+
{{DISPLAYTITLE:Synchronizing User Accounts with Kerio Connect}}
 
+
{{Directory Services Preamble|Kerio Connect}}
In addition to adding users manually (as described in chapter [[Users,_Folders_and_Settings#User_Management|User Management]]), MailStore can synchronize its internal user database with a Kerio Connect user database.
 
 
 
During synchronization, user information and email addresses are taken from the Kerio Connect user database and entered into MailStore. MailStore makes no changes to the Kerio Connect user database itself, and the synchronization can be limited to one or more individual domains and groups.
 
  
 
== Accessing the Directory Service Integration ==
 
== Accessing the Directory Service Integration ==
 +
{{Directory Services Accessing Configuration|Kerio Connect|Kerio_sync_01.png}}
  
* Log on to MailStore Client as MailStore administrator.
+
== Connection to the Kerio Connect ==
* Click on ''Administrative Tools'' > ''Users and Privileges'' and then on ''Directory Services''.
+
For synchronization MailStore Server requires information on how to connect to the Kerio Connect.  
* Under ''Integration'', change the Directory Service type to ''Kerio Connect''.
 
 
 
[[File:Kerio_sync_01.png|center|450px]]
 
 
== Specifying Connection Settings ==
 
 
 
Before the synchronization feature can be used, MailStore Server needs information on how the Kerio Connect server can be reached:
 
* '''Server Name''' - The Name or the IP address of the Kerio Connect server. If you are using a self-signed SSL certificate on the Kerio Connect server, please check the checkbox ''Ignore SSL Security Warnings''.
 
* '''User Name''' – The name of a user with administrative privileges.
 
* '''Password''' – The password of the user with administrative privileges.
 
 
== Specifying Standard Privileges ==
 
 
 
By default, users who were synchronized to MailStore from a directory service can log in to MailStore Server and have access to their own user archive.
 
Before synchronization, you can modify these standard privileges to give all new users the Archive Emails privilege, for example. To do so, click on the ''Standard Privileges…'' button.
 
 
 
Additional information about managing user privileges and their effects is available in chapter [[Users, Folders and Settings]]. There you can also find tips on how to customize existing privileges.
 
 
 
== Performing the Synchronization ==
 
 
 
Once the connection settings have been specified (as described above), you can synchronize the MailStore user list with the Kerio Connect user database.
 
 
 
To limit synchronization to one or more domains and groups, click on the button next to the domains and groups field and put a checkmark in front of the groups to be synchronized. If no domain or group is selected, all users will be synchronized.
 
 
 
Click on ''Verify Settings'' to see what happens when clicking ''Synchronize Now''. Click on ''Synchronize Now'' to start.
 
 
 
 
 
[[File:Kerio_sync_02.png|center|450px]]
 
  
= Login with Kerio Connect Access Data =
+
*'''Server Name'''<br/>DNS name of the Kerio Connect. In case the Kerio Server is reachable over a non-default port (the default port is 4040), the port can be appended to the server name with a colon. {{Option Accept all certificates}}
 +
*'''User Name'''<br/>Name of a user with administrative privileges on the Kerio Connect.
 +
*'''Password'''<br/>Password of that user.
  
By default, each MailStore user has a password exclusively for MailStore. The MailStore administrator specifies the password upon creation of the user account while the user can later change it via MailStore Client’s ''Administrative Tools''. Alternatively, you can configure MailStore to allow users to log in to MailStore Server using their Kerio Connect passwords.  
+
=== Synchronize ===
 +
After configuring the connection settings as described above, you can specify filter criteria for the Kerio Connect user database synchronization in this section.
  
Before users can log in to MailStore Server using their Kerio Connect access data, the following settings must be specified under ''Authentication'':
+
*'''Domains and Groups'''<br/>Choose one or more domains or groups to let only their members be created as MailStore Server Users. If no domains or groups are selected, all users will be synchronized.  
 
* '''Kerio IMAP Server''' – Enter the IP address or the host name of the Kerio Connect server against which authentication is to be performed.
 
* '''IMAP Server Access''' – Specify if the connection to the IMAP server is to be unencrypted or IMAP-TLS/IMAP-SSL encrypted.
 
*: '''Only when using IMAP-TLS and IMAP-SSL:''' Activate the option to ''Ignore SSL Security Warnings'' if an unofficial certificate is used on the Email server. Otherwise, authentication will fail continuously.  
 
  
== Procedure for Users Who Were Added Via Synchronization with the Kerio Connect User Database ==
+
{{Directory Services Options|Kerio Connect}}
 +
{{Directory Services Kerio Connect Authentication|Kerio Connect}}
 +
{{Directory Services Assign Default Privileges|an Kerio Connect Server}}
 +
{{Directory Services Run Synchronization|Kerio Connect}}
 +
[[File:ApplicationIntegration_sync_02.png|450px|center]]
  
If MailStore users were added via Kerio Connect directory service synchronization as described in the previous section, no further action is required. MailStore has already specified all necessary settings automatically.
 
  
== Procedure for Manually Added Users ==
+
{{Directory Services Test Authentication}}
 +
{{Directory Services Login with Directory Services Credentials|Kerio Connect}}
  
If MailStore users were added manually, and if these users are to be able to log in using their Kerio Connect password, please proceed as follows:
 
* Configure the Kerio Connect Integration as described in chapter [[Kerio Connect Integration#Synchronizing_User_Accounts_with_a_Kerio_Connect_User_Database|
 
Synchronizing User Accounts with a Kerio Connect User Database]]
 
* Make sure that the MailStore users have the same name as the corresponding users in the Kerio Connect user database.
 
* In the user properties under ''Authentication'', choose ''Directory Services''.
 
 
[[File:Kerio_sync_03.png|center|400px]]
 
 
[[de:Kerio_Connect-Integration]]
 
[[de:Kerio_Connect-Integration]]
 +
[[en:Kerio_Connect_Integration]]

Latest revision as of 15:59, 7 December 2020

In addition to adding users manually as described in chapter User Management, MailStore Server can synchronize its internal user database with the Kerio Connect of your organization.

During synchronization, user information, such as user names and email addresses, is copied from the Kerio Connect into MailStore Server's user database. That way, users can use their Kerio Connect credentials to also log on to MailStore Server and emails can be assigned to their corresponding user archives automatically, for example. No changes are made to the Kerio Connect itself by MailStore Server. The scope of the synchronization can be limited through filters.


Accessing the Directory Service Integration

  • Log on to MailStore Client as a MailStore Server administrator.
  • Click on Administrative Tools > Users and Archives > Directory Services.
  • In the Integration section, change the directory service type to Kerio Connect.
Kerio sync 01.png


Connection to the Kerio Connect

For synchronization MailStore Server requires information on how to connect to the Kerio Connect.

  • Server Name
    DNS name of the Kerio Connect. In case the Kerio Server is reachable over a non-default port (the default port is 4040), the port can be appended to the server name with a colon. If the certificate provided by the remote host cannot be verified (e.g. self-signed or signed by an unknown certificate authority), enable the option Accept all certificates to allow MailStore to establish a connection. As this option leads to an insecure configuration, warnings may appear in the summary and/or the dashboard.
  • User Name
    Name of a user with administrative privileges on the Kerio Connect.
  • Password
    Password of that user.

Synchronize

After configuring the connection settings as described above, you can specify filter criteria for the Kerio Connect user database synchronization in this section.

  • Domains and Groups
    Choose one or more domains or groups to let only their members be created as MailStore Server Users. If no domains or groups are selected, all users will be synchronized.

Options

  • Automatically delete users in MailStore Server
    Here you can choose whether users that have been deleted in the Kerio Connect will also be deleted in the MailStore Server user database by the synchronization. Users will also be deleted if they fall out of scope of the configured settings.
    Only MailStore Server users that have their authentication method set to Directory Services will be deleted.
    If the archive folder of such a user already contains archived emails, only the user entry but not its archive folder will be deleted in MailStore Server.

Authentication

As the Kerio Connect API only support synchronization, but not authentication of users, MailStore allows authenticate users via an IMAP login. To achieve this, you have to configure the following settings in the Authentication section:

  • Kerio IMAP Server
    Enter the IP address or the DNS name of the Kerio Connect server against which authentication should be performed.
  • IMAP Server Access
    Configure the connection protocol. Be aware that IMAP servers often expect the connection to be encrypted (IMAP-TLS, IMAP-SSL). If the certificate provided by the remote host cannot be verified (e.g. self-signed or signed by an unknown certificate authority), enable the option Accept all certificates to allow MailStore to establish a connection. As this option leads to an insecure configuration, warnings may appear in the summary and/or the dashboard.

Important Notice: If your Kerio Connect users authenticate against an Active Directory or if you store the passwords as SHA hashes, you must disable CRAM-MD5 and DIGEST-MD5 under Configuration > Advanced Options > Security Policy in your Kerio Connect Server. Otherwise users will not be able to log on to MailStore.

Assigning Default Privileges

By default, users that have been synchronized to MailStore Server from an Kerio Connect Server have the privilege to log on to MailStore Server as well as read access to their own user archive.
You can configure those default privileges before synchronization, for example, to assign the privilege Archive E-mail to all new users. To do this, click on Default Privileges...
More information on managing user privileges and their effects is available in the chapter Users, Folders and Settings which also has details on editing existing privileges.

Running Directory Services Synchronization

Click on Test Settings to check synchronization configuration and the results returned by the Kerio Connect without any changes to the MailStore Server user database being actually committed.

To finally run the synchronization, click on Synchronize now. The results are shown with any changes committed to the MailStore Server user database.

ApplicationIntegration sync 02.png


You can test the authentication for a user by first selecting him from the list and then clicking on the button on the lower left. You will now be asked for that user's password. Upon clicking OK you'll receive a message whether the authentication has been successful.

Login with Kerio Connect Credentials

After synchronization MailStore users can log on to MailStore Server with their Kerio Connect username and Kerio Connect password.