Difference between revisions of "MailStore Server Service Configuration"

Jump to: navigation, search
[checked revision][unchecked revision]
(Server Certificate)
Line 1: Line 1:
__NOTOC__
+
With the MailStore Server Service Configuration you can configure basic administrative features of a MailStore Server installation as well as control the MailStore Server service. The current status of the MailStore Server service is shown at the bottom of the window.
  
Basic administrative features are available through the MailStore Server Service Configuration. It can be accessed through the MailStore Server application folder in the Windows Start menu or the corresponding desktop shortcut.
+
== General==
 +
On this page you can select the storage location of the master database, configure where audit events should be stored and enable or disable individual features for accessing MailStore Server.
  
 
[[File:tech_config_01.png|center|500px]]
 
[[File:tech_config_01.png|center|500px]]
  
At the bottom of the window, the current status of the MailStore Server service is shown. The service can be controlled using the ''Start Service'', ''Restart Service'' and ''Stop Service'' buttons. This may be necessary after certain changes to the configuration have been made or before performing backups, for example.
 
 
== General==
 
 
=== Master Database ===
 
=== Master Database ===
Select the storage location of an existing master database. When choosing an empty directory, a new master database is created therein. Should an existing archive be moved to a new storage location, refer to the instruction in [[Moving the Archive]].  
+
Select the storage location of an existing master database. If you chose an empty directory, a new master database will be created therein. If you want to move an existing archive to a new storage location, refer to the instruction in [[Moving the Archive]].  
  
Also the destination for logging audit events can be specified here.
+
You can also specify the destination for logging audit events here.
  
 
=== Features ===
 
=== Features ===
Individual components for accessing the MailStore server can be activated or deactivated. These include:
+
In this section you can enable or disable individual features for accessing MailStore Server.
  
* MailStore Web Access / Outlook Add-In (HTTP)
+
* ''MailStore Web Access / Outlook Add-In (HTTP)''<br/>Enables archive access via HTTP through [[Accessing_the_Archive_with_MailStore_Web_Access|MailStore Web Access]] and the [[Accessing_the_Archive_with_the_Microsoft_Outlook_integration|MailStore Outlook Add-in]].
* MailStore Web Access / Outlook Add-In (HTTPS)
+
* ''MailStore Web Access / Outlook Add-In (HTTPS)''<br/>Enables archive access via HTTPS through MailStore Web Access and the MailStore Outlook Add-in.
* IMAP Server (unencrypted / STARTTLS)
+
* ''IMAP Server (unencrypted / STARTTLS)''<br/>Enables both unencrypted and STARTTLS-encrypted archive access through the integrated [[Accessing_the_Archive_via_Integrated_IMAP_Server|IMAP server]].
* IMAP Server (SSL)
+
* ''IMAP Server (SSL)''<br/>Enables SSL-encrypted archive access through the integrated IMAP server.
* MailStore Administrations API (HTTPS)
+
* ''MailStore Administrations API (HTTPS)''<br/>Enables the [[Administration_API_-_Using_the_API|MailStore Administration API]].
 +
* ''VSS Writer''<br/>Activates the MailStore Volume Shadow Service Writer for enabling live backups of the archive using an [[Backup_and_Restore#Using_External_Backup_Software|external backup software]].
  
These components can be configured under ''IP Addresses and Ports''.
+
== IP Addresses and Ports ==
 +
In addition to enabling and disabling individual network based components, you can choose the IP address and the port to which a component is to be bound as well as the SSL certificate that should be used for encrypted connections.
 +
[[File:tech_config_02.png|center|550px]]
  
=== Locksmith ===
+
=== Basic Options ===
Use this feature to restore the user "admin" with the password "admin". The MailStore Server service has to be stopped.  
+
==== IP Address ====
 +
The IP address on which the component accepts connections. Generally, it is recommended to bind all MailStore components to all IP addresses (Standard).
  
== IP Addresses and Ports ==
+
==== Port ====
In addition to activating or deactivating individual components, you can choose the IP address and the port to which a component is to be linked as well as the SSL certificate that is to be used for encrypted connections.
+
Indicates the TCP port on which the component accepts connections.
 
+
:'''Example:''' If no web server other than MailStore Web Access is installed (e.g. an IIS website, Microsoft Outlook Web Access or SharePoint), you can specify the HTTP- and HTTPS standard ports (80 and 443). This way, users can access MailStore Web access directly using the URLs <nowiki>http://<server name></nowiki> or <nowiki>https://<server name></nowiki> without port numbers.
=== IP Address ===
 
IP address at which the component receives connections. Generally, it is advisable to link all MailStore components to all IP addresses (Standard).
 
=== Port ===
 
Indicates the TCP port at which the component receives connections.
 
:'''Example:''' If no web server other than MailStore Web Access is installed (e.g. an IIS website, Microsoft Outlook Web Access or SharePoint), the HTTP- and HTTPS standard ports (80 and 443) can be specified. This way, users can access MailStore Web access directly using the URLs <nowiki>http://<servername></nowiki> or <nowiki>https://<servername></nowiki>.
 
=== Server Certificate ===
 
Shows the current SSL certificate for the respective component of the MailStore server. To view details about the SSL certificate, click on its name. Using the button next to the name you can:
 
  
 +
==== Server Certificate ====
 +
Shows the current SSL certificate for the respective component of MailStore Server. Click on its name to view details about the SSL certificate. Using the button next to the name you can:
 
* Select an SSL certificate from the certificate store of the MailStore Server computer.
 
* Select an SSL certificate from the certificate store of the MailStore Server computer.
 
* Create a new self-signed SSL certificate.
 
* Create a new self-signed SSL certificate.
 
* Import an SSL certificate from a file directly into the certificate store of the MailStore Server computer. The file must be in PKCS #12 format and usually has the file extension ''pfx'' or ''p12''.
 
* Import an SSL certificate from a file directly into the certificate store of the MailStore Server computer. The file must be in PKCS #12 format and usually has the file extension ''pfx'' or ''p12''.
 +
 +
=== Specific Options ===
 +
==== MailStore Client ====
 +
You cannot disable this component because the MailStore Client is essential for managing MailStore Server. The default TCP port is 8460.
 +
==== MailStore Web Access / Outlook Add-in (HTTP) ====
 +
This component provides unencrypted archive access through MailStore Web Access and the MailStore Outlook Add-in. The default TCP port is 8461.
 +
* ''Enable HTTPS redirect''<br/>Enabling this option redirects unencrypted HTTP requests to the HTTPS port.
 +
* ''Redirect to custom server name''<br/>If MailStore Server should use a specific server name for the HTTPS redirect, it must be specified here.
 +
==== MailStore Web Access / Outlook Add-in (HTTPS) ====
 +
This component provides SSL-encrypted archive access through MailStore Web Access and the MailStore Outlook Add-in. The default TCP port is 8462.
 +
==== IMAP Server (unverschlüsselt / STARTTLS) ====
 +
This component provides both unencrypted and STARTTLS-encrypted archive access through the integrated IMAP server. The default TCP port is 143.
 +
==== IMAP Server (SSL) ====
 +
This component provides SSL-encrypted archive access through the integrated IMAP server. The default TCP port is 993.
 +
==== MailStore Administration API (HTTPS) ====
 +
This component provides SSL-encrypted access to the MailStore Administration API. The default TCP port is 8463.
 +
 +
== Security and Encryption ==
 +
This page provides several security features related to archive access and encryption. Please note that you cannot use these features while the MailStore Server service is running; it has to be stopped first.
 +
[[File:tech_config_03.png|center|550px]]
 +
 +
=== Restore Default Admin ===
 +
Through this feature you can restore the default admin user "admin" with the likewise password "admin". You will be asked to enter a product key or a recovery key if the recovery key of the archive whose default admin you want to restore is not the product key of the current MailStore Server installation.
 +
 +
=== Reinitialize Archive Encryption ===
 +
For security reasons the archive encryption is bound to the Windows installation on which MailStore Server has been installed. Therefore it might be necessary to reinitialize the archive encryption when moving the archive to another machine. You will be asked to enter a product key or a recovery key if the recovery key of the archive whose encryption you want to reinitialize is not the product key of the current MailStore Server installation.
 +
 +
=== Set Recovery Key ===
 +
By default, MailStore Server uses the product key provided during setup as recovery key. You can change your recovery key to an automatically generated, random value or reset it to the product key.
 +
==== [[File:tech_config_04.png|right|340px]]Changing the Recovery Key ====
 +
* Click on ''Change'' to change the recovery key to an automatically generated, random value.
 +
* You will be asked to save the recovery key to a file and/or print it. You have to choose at least one option to continue.
 +
<br clear=all />
 +
<p class="msnote">'''Important notice:''' Always store the recovery key in a secure location. Without the recovery key operations like restoring the default admin, moving the archive to another machine or attaching archive stores to another MailStore installation are not possible.</p>
 +
==== Resetting the Recovery Key ====
 +
You can reset the recovery key to the current product key of your MailStore Server installation at any time. Before the reset you will be asked to enter the current recovery key. By default, MailStore Server already uses the current product key as recovery key and the button is disabled.
  
 
== Startup Script ==
 
== Startup Script ==
Line 49: Line 82:
  
 
== Debug Log ==
 
== Debug Log ==
The ''Debug Protocol'' item provides direct access to all debug logs created by MailStore, activating or deactivating such logs as well as deletion of single log files.
+
On this page you can enable, view or delete all debug logs created by MailStore Server.
  
 
=== Enable Debug Log ===
 
=== Enable Debug Log ===
Activate this feature if any problems or errors have occurred while running MailStore Server. After restarting the server service via ''Restart Service'' in the same window, a detailed log file is taken down. This file can be evaluated by the MailStore support team, for example.
+
Enable this feature if any problems or errors have occurred while running MailStore Server. After restarting the server service via ''Restart Service'' in the same window, a detailed log file is recorded. This file can be evaluated by the MailStore support team, for example.
  
 
=== Enable IMAP Connection Debug Log ===
 
=== Enable IMAP Connection Debug Log ===
Activate this feature if problems or errors have occurred while accessing MailStore Server using the integrated IMAP server. After restarting the server service via ''Restart Service'' in the same window, a detailed log file is taken down. This file can be evaluated by the MailStore support team, for example.
+
Enable this feature if problems or errors have occurred while accessing MailStore Server using the integrated IMAP server. After restarting the server service via ''Restart Service'' in the same window, a detailed log file is recorded. This file can be evaluated by the MailStore support team, for example.
  
 
The table shows an overview of all debug log files. To view the contents of a debug log file in a text editor, double-click on the file name or click on ''Open''. To delete a debug log file, highlight the file name and click on ''Delete''.
 
The table shows an overview of all debug log files. To view the contents of a debug log file in a text editor, double-click on the file name or click on ''Open''. To delete a debug log file, highlight the file name and click on ''Delete''.

Revision as of 14:25, 28 November 2016

With the MailStore Server Service Configuration you can configure basic administrative features of a MailStore Server installation as well as control the MailStore Server service. The current status of the MailStore Server service is shown at the bottom of the window.

General

On this page you can select the storage location of the master database, configure where audit events should be stored and enable or disable individual features for accessing MailStore Server.

Tech config 01.png

Master Database

Select the storage location of an existing master database. If you chose an empty directory, a new master database will be created therein. If you want to move an existing archive to a new storage location, refer to the instruction in Moving the Archive.

You can also specify the destination for logging audit events here.

Features

In this section you can enable or disable individual features for accessing MailStore Server.

  • MailStore Web Access / Outlook Add-In (HTTP)
    Enables archive access via HTTP through MailStore Web Access and the MailStore Outlook Add-in.
  • MailStore Web Access / Outlook Add-In (HTTPS)
    Enables archive access via HTTPS through MailStore Web Access and the MailStore Outlook Add-in.
  • IMAP Server (unencrypted / STARTTLS)
    Enables both unencrypted and STARTTLS-encrypted archive access through the integrated IMAP server.
  • IMAP Server (SSL)
    Enables SSL-encrypted archive access through the integrated IMAP server.
  • MailStore Administrations API (HTTPS)
    Enables the MailStore Administration API.
  • VSS Writer
    Activates the MailStore Volume Shadow Service Writer for enabling live backups of the archive using an external backup software.

IP Addresses and Ports

In addition to enabling and disabling individual network based components, you can choose the IP address and the port to which a component is to be bound as well as the SSL certificate that should be used for encrypted connections.

Tech config 02.png

Basic Options

IP Address

The IP address on which the component accepts connections. Generally, it is recommended to bind all MailStore components to all IP addresses (Standard).

Port

Indicates the TCP port on which the component accepts connections.

Example: If no web server other than MailStore Web Access is installed (e.g. an IIS website, Microsoft Outlook Web Access or SharePoint), you can specify the HTTP- and HTTPS standard ports (80 and 443). This way, users can access MailStore Web access directly using the URLs http://<server name> or https://<server name> without port numbers.

Server Certificate

Shows the current SSL certificate for the respective component of MailStore Server. Click on its name to view details about the SSL certificate. Using the button next to the name you can:

  • Select an SSL certificate from the certificate store of the MailStore Server computer.
  • Create a new self-signed SSL certificate.
  • Import an SSL certificate from a file directly into the certificate store of the MailStore Server computer. The file must be in PKCS #12 format and usually has the file extension pfx or p12.

Specific Options

MailStore Client

You cannot disable this component because the MailStore Client is essential for managing MailStore Server. The default TCP port is 8460.

MailStore Web Access / Outlook Add-in (HTTP)

This component provides unencrypted archive access through MailStore Web Access and the MailStore Outlook Add-in. The default TCP port is 8461.

  • Enable HTTPS redirect
    Enabling this option redirects unencrypted HTTP requests to the HTTPS port.
  • Redirect to custom server name
    If MailStore Server should use a specific server name for the HTTPS redirect, it must be specified here.

MailStore Web Access / Outlook Add-in (HTTPS)

This component provides SSL-encrypted archive access through MailStore Web Access and the MailStore Outlook Add-in. The default TCP port is 8462.

IMAP Server (unverschlüsselt / STARTTLS)

This component provides both unencrypted and STARTTLS-encrypted archive access through the integrated IMAP server. The default TCP port is 143.

IMAP Server (SSL)

This component provides SSL-encrypted archive access through the integrated IMAP server. The default TCP port is 993.

MailStore Administration API (HTTPS)

This component provides SSL-encrypted access to the MailStore Administration API. The default TCP port is 8463.

Security and Encryption

This page provides several security features related to archive access and encryption. Please note that you cannot use these features while the MailStore Server service is running; it has to be stopped first.

Tech config 03.png

Restore Default Admin

Through this feature you can restore the default admin user "admin" with the likewise password "admin". You will be asked to enter a product key or a recovery key if the recovery key of the archive whose default admin you want to restore is not the product key of the current MailStore Server installation.

Reinitialize Archive Encryption

For security reasons the archive encryption is bound to the Windows installation on which MailStore Server has been installed. Therefore it might be necessary to reinitialize the archive encryption when moving the archive to another machine. You will be asked to enter a product key or a recovery key if the recovery key of the archive whose encryption you want to reinitialize is not the product key of the current MailStore Server installation.

Set Recovery Key

By default, MailStore Server uses the product key provided during setup as recovery key. You can change your recovery key to an automatically generated, random value or reset it to the product key.

Tech config 04.png
Changing the Recovery Key

  • Click on Change to change the recovery key to an automatically generated, random value.
  • You will be asked to save the recovery key to a file and/or print it. You have to choose at least one option to continue.


Important notice: Always store the recovery key in a secure location. Without the recovery key operations like restoring the default admin, moving the archive to another machine or attaching archive stores to another MailStore installation are not possible.

Resetting the Recovery Key

You can reset the recovery key to the current product key of your MailStore Server installation at any time. Before the reset you will be asked to enter the current recovery key. By default, MailStore Server already uses the current product key as recovery key and the button is disabled.

Startup Script

The MailStore Server service can execute a script before startup. The script can be used to establish a connection to a network resource using special connection parameters as described in chapter Using Network Attached Storage (NAS).

Event Viewer

Events such as starting or stopping the MailStore Server service are displayed here. If there are any errors, click on the corresponding entry to view additional details below the list.

Debug Log

On this page you can enable, view or delete all debug logs created by MailStore Server.

Enable Debug Log

Enable this feature if any problems or errors have occurred while running MailStore Server. After restarting the server service via Restart Service in the same window, a detailed log file is recorded. This file can be evaluated by the MailStore support team, for example.

Enable IMAP Connection Debug Log

Enable this feature if problems or errors have occurred while accessing MailStore Server using the integrated IMAP server. After restarting the server service via Restart Service in the same window, a detailed log file is recorded. This file can be evaluated by the MailStore support team, for example.

The table shows an overview of all debug log files. To view the contents of a debug log file in a text editor, double-click on the file name or click on Open. To delete a debug log file, highlight the file name and click on Delete.

Navigation
Tools
Print/export
About MailStore

  • MailStore Server is one of the leading email archiving solutions for SMB.
  • For private use there is a free tool for email archiving furthermore: MailStore Home.