Difference between revisions of "Installation"

[unchecked revision]

[checked revision]

Latest revision as of 12:34, 16 April 2021

MailStore Server can be installed on virtually any Windows PC. Neither a server operating system nor a database system is required. For example, you can set up a test installation of MailStore Server on your desktop machine without any problem. Running MailStore Server inside a virtual machine is supported as well. For more information, please refer to the System Requirements article.

Choosing a Computer for the Installation of MailStore Server

Whenever possible, MailStore Server should be installed on a dedicated machine. Depending on the environment, archiving strategy and usage, MailStore Server can be installed on an already existing server, too. On the part of the email server to be archived, no components need to be installed though.

Starting the Installation

To start the installation process, double-click on the downloaded setup file. This is a regular Windows installation, just follow the instructions on the screen:

If you want to install MailStore Server in a language different to the operating system's, you can choose it at the beginning of the installation.
Carefully read the license agreement and privacy policy. You have to agree to these terms to continue.
In the next step you can choose which folder to install MailStore Server in. In most cases, you should keep the default setting.
The installation program now deploys the necessary components.

Install License

You must now enter your MailStore product key which you have received by email after your trial registration or upon buying MailStore Server. Alternatively you can import a license file here. That file you can download either through the link provided in the dialog or directly from our website.
If you've entered a valid 30-day-trial key, it will be activated automatically. If you've entered a production license key, all information that is sent to MailStore will be displayed before activation.

Configure Certificate

In the next step, you need to configure the certificate to be used by MailStore Server in order to ensure authenticity and security for all inbound connections. The certificate can be changed any time after the installation through the MailStore Server Service Configuration tool.
- Create self-signed certificate
  
  Though not recommended for production use, self-signed certificates may be a good choice for a trial installation. But keep in mind that self-signed certificates will trigger certificate warning in web browsers and email clients.
- Use existing certificate
  If a certificate from a trusted Certificate Authority already exists (i.e. a wildcard certificate for your domain), this is the best option to select.
- Obtain certificate from Let's Encrypt
  Select this option if you would like to obtain a certificate from the free Certificate Authority Let's Encrypt

Option 1: Create Self-Signed Certificate

To create a self-signed certificate, that matches the actual server name, enter the name (i.e. mailstore.example.com) into the corresponding field Server Name. This server name should be resolvable by your client computer.

Option 2: Use Existing Certificate

Click on the ellipses choose from:
- Select from Certificate Store...
  Use an existing certificate from the computer's certificate store.
- Import from File...
  Import a certificate from a file into the computer's certificate store.

Option 3: Obtain Certificate from Let's Encrypt

This page lists the prerequisites for obtaining a certificate from Let's Encrypt, which are:
- A public DNS record (A or CNAME) for this server must exist and point to its public IP address.
- The server must be accessible from the Internet on TCP port 80 (HTTP) for Let's Encrypt's automatic domain approval process. A port forwarding on your firewall or gateway may be necessary.
Further information are available in Using Lets Encrypt Certificates.

To obtain a certificate from Let's encrypt an email address and the server name for which the certificate is requested must be entered in the corresponding fields.
Check the I accept Let's Encrypt's Subscriber Agreement box after you have read Let's Encrypt's Subscriber Agreement by clicking on the corresponding link.

Completing the MailStore Server Setup Wizard

In the next step you can configure several settings of your MailStore Server installation:
- Auto-configure Windows Firewall
  If this option is enabled, the default MailStore TCP ports will be opened in the Windows Firewall by the installation program automatically.
- Automatic license update
  If this option is enabled, MailStore Server regularly checks for updated license data. If a new license is available, e.g. more users have been licensed or the Update and Support Service contract has been extended, it will be downloaded and applied automatically.
- Enable automatic update check for server
  If this option is enabled, MailStore Server regularly checks for new product versions. If a new version is available, this will be displayed on the dashboard in the MailStore Client.
- Enable automatic update check for Web Access
  If this option is enabled, MailStore Server regularly checks for new versions of the MailStore Web Access. If a new version is available, this will be displayed on the dashboard in the MailStore Client.
- Automatically install updates
  If this option is enabled, new versions of MailStore Web Access will be downloaded and installed automatically without having to restart the MailStore Server Service.

Help us to improve MailStore

At the end of the installation process you can opt to help us improving MailStore:
- Submission of anonymous usage data
  If this option is enabled, MailStore Server regularly sends data on how the program is being used to MailStore. This data allows us to better understand different usage scenarios of MailStore Server and focus our development capacities accordingly. The submitted data is collected and evaluated exclusively for this purpose.
  No personal data such as user names, passwords or email content will be submitted. The submitted data is completely anonymized and cannot be correlated to a specific customer installation. You can enable or disable this option in the MailStore Client under Administrative Tools > Miscellaneous > Product Updates at any time; the option is disabled by default (opt-in).
By clicking on Finish the installation will be completed and the MailStore Server Service and the MailStore Client will be started.

Customizing the Installation

The installation program creates a fully functional default installation of MailStore Server, which is perfectly suited for testing purposes. For production environments, parameters such as the Master Database directory, features, TCP ports, SSL certificates etc can be customized via the MailStore Server Service Configuration.

First Time Installation

After successfully installing MailStore Server for the first time, it is recommended to continue with the Quick Start Guide. A step-by-step tutorial explains the basics, from creating users to successfully archivig emails for the first time.

@@ Line 1: / Line 1: @@
-= Installing MailStore =
+MailStore Server can be installed on virtually any Windows PC. Neither a server operating system nor a database system is required. For example, you can set up a test installation of MailStore Server on your desktop machine without any problem. Running MailStore Server inside a virtual machine is supported as well. For more information, please refer to the [[System Requirements]] article.
-The chapter "Getting Started" guides you through the installation process of MailStore Server and demonstrates its basic functionality using several examples.
-Please note: Information about the installation of updates is available in chapter Updates.
 == Choosing a Computer for the Installation of MailStore Server ==
+Whenever possible, MailStore Server should be installed on a dedicated machine. Depending on the environment, archiving strategy and usage, MailStore Server can be installed on an already existing server, too. On the part of the email server to be archived, no components need to be installed though.
-The MailStore server can be installed on any Windows PC. Neither server operating system nor database system is required. An overview of supported operating systems can be found in chapter System Requirements.
-'''Installation on an existing server'''
-MailStore Server can be installed on an already existing server PC without any restrictions. Although not required, a concurrent installation on a Microsoft Exchange server is possible without any restrictions as well. No changes are made to the Exchange server. Should the capacity of the current computer used for archiving reach its limits, the entire archive can be moved to another machine within minutes.
-'''Tips for the test mode'''
-To test MailStore Server, it can be installed on any workstation PC. Operation in a virtual machine (e.g. VMware) is possible without any restrictions as well.
 == Starting the Installation ==
+To start the installation process, double-click on the downloaded setup file. This is a regular Windows installation, just follow the instructions on the screen:
+* If you want to install MailStore Server in a language different to the operating system's, you can choose it at the beginning of the installation.
+* Carefully read the license agreement and privacy policy. You have to agree to these terms to continue.
+* In the next step you can choose which folder to install MailStore Server in. In most cases, you should keep the default setting.
+* The installation program now deploys the necessary components.
-To start the installation process, double-click on the downloaded setup file. This is a regular Windows installation; simply follow the instructions on the screen.
+=== Install License ===
+* [[File:Setup003.png|right|320px]]You must now enter your MailStore product key which you have received by email after your trial registration or upon buying MailStore Server. Alternatively you can import a license file here. That file you can download either through the link provided in the dialog or directly from our {{go.mailstore.com|target{{=}}activate|website}}.
-[[File:gsta_install_01.png|center|400px]]
+* If you've entered a valid 30-day-trial key, it will be activated automatically. If you've entered a production license key, all information that is sent to MailStore will be displayed before activation.
+<br clear=all/>
-== Choosing a Directory ==
-During the installation you will be prompted for choosing a storage location for the master database. This will be the directory in which the actual email archive will be stored. The following destination folder is suggested:
-C:\MailArchive
-You can accept the default folder or change the directory; you will still be able to change the directory after installation through MailStore's Administrative Tools. Should you plan to store on a Network Attached Storage (NAS), the chapter Using NAS Devices will provide with more information on this.
-[[File:gsta_install_02.png|center|400px]]
-= Starting MailStore =
-After successful installation, a new ''MailStore Client'' icon will appear on the desktop; simply double click this icon to start MailStore.
-Background Information: With MailStore Client, a Windows application, users can search the archive and view archived emails. The administration of MailStore Server is also done through MailStore Client. Therefore, when installing MailStore Server, an installation of MailClient is automatically included as well.
-== Loggin On as Administrator ==
-When logging on as administrator, you will be prompted for the access data. Server name localhost and user name ''admin'' are preset; simply click on OK. If asked whether to trust MailStore Server, click on ''OK'' as well.
-[[File:gsta_login_01.png|center|350px]]
-== Installing a License ==
-If MailStore Server was installed for the first time, the license manager will open after logging on as administrator. Here you can install a free 30-day test license or an already purchased license. Information about obtaining license files is available in chapter Licensing.
-== Changing the Password (Recommended)==
-To ensure security, the administrator password should be changed after the first start of MailStore: simply click on ''Administrative Tools'' and select ''Change Password''.
-Important notice: For security reasons you will not be allowed to log on to MailStore as user ''admin'' from any other computer, as long as the password is set to ''admin''.
-[[File:gsta_login_02.png|center|500px]]
-= Adding new users =
-When emails are archived, they are always assigned to individual users. For each user, whose emails are to be archived with MailStore, a corresponding user account has to be created in MailStore. As a suggestion, begin by adding a user account for yourself.
-Important notice: This chapter describes how you can add a MailStore user manually. However, users can also be added through Active Directory Integration. In addition, MailStore users can be created automatically during Archiving a Microsoft Exchange Server.
-== Opening User Management ==
-Click on ''Administrative Tools'' and select ''Users''; user management is displayed.
-== Adding a New User ==
-Click on ''Create New'' and enter a user name for the new user, such as the first name or a short combination of first and last name. Click on ''OK''.
-On the next screen, the full name can be entered; the button ''password'' provides the option to create a MailStore password for the new user. Click on ''OK'' to save the settings and close user management.
-== Logging On to MailStore Server as User ==
-To log on to MailStore Server using the new user account, simply close and restart MailStore Client. On the login screen enter the new access data (user name and password) and click on ''OK''.
-= Archiving Emails =
-After creating a MailStore user, you can start archiving emails for that user. '''In the following example, emails are archived from the local Outlook application'''. No changes are made to Outlook or the emails contained therein.
-Important notice: This section describes how to archive emails from the local Microsoft Outlook application as an example. Detailed information about other archiving options is available in chapters Archiving Emails and MailStore and Microsoft Exchange.
-*Click on Archive Email.
-*From the list on the upper right, select Microsoft Outlook as source.
-[[File:gsta_archive_01.png|center|550px]]
-*Keep the default settings and click on ''Next''.
-[[File:gsta_archive_02.png|center|400px]]
-*If desired, you can choose further archiving settings in the following window. For now, keep the default settings and click on ''Next''.
-[[File:gsta_archive_05.png|center|400px]]
-*If you are logged on to MailStore Server as administrator, you will be prompted for the target archive in which the emails are to be stored. If you are logged on as user, the archive of the respective user is selected automatically.
-[[File:gsta_archive_03.png|center|400px]]
-*Finally, you can specify a name (e.g. "Microsoft Outlook Test") under which MailStore will save your archiving task. Click on Finish to start the archiving process.
-[[File:gsta_archive_04.png|center|400px]]
-*After the archiving process is finished, a protocol appears. If it does not contain any error messages, the process was successful.
-The new archiving profile is now listed under ''Saved Settings (Profiles)'' and from here can be run as often as desired. MailStore only archives those emails not yet stored in the archive.
+=== Configure Certificate ===
+* In the next step, you need to configure the certificate to be used by MailStore Server in order to ensure authenticity and security for all inbound connections. The certificate can be changed any time after the installation through the [[MailStore Server Service Configuration]] tool.
+** '''Create self-signed certificate'''[[File:Setup003a.png|right|320px]]<br/>Though not recommended for production use, self-signed certificates may be a good choice for a trial installation. But keep in mind that self-signed certificates will trigger certificate warning in web browsers and email clients.
+** '''Use existing certificate'''<br/>If a certificate from a trusted Certificate Authority already exists (i.e. a wildcard certificate for your domain), this is the best option to select.
+** '''Obtain certificate from Let's Encrypt'''<br/>Select this option if you would like to obtain a certificate from the free Certificate Authority Let's Encrypt
-= Viewing Archived Emails =
+<br style="clear: both;" />
-[[File:gsta_preview_01.png|left|250px]]
+==== Option 1: Create Self-Signed Certificate ====
+* [[File:Setup003a1.png|right|bottom|320px]]To create a self-signed certificate, that matches the actual server name, enter the name (i.e. mailstore.example.com) into the corresponding field ''Server Name''. This server name should be resolvable by your client computer.
+<br clear=all>
-MailStore displays the archived emails in a tree structure on the left side of the application window. An administrator (''admin'') can view the archived emails of all users, a regular user, by default, only his or her own user archive.
+==== Option 2: Use Existing Certificate ====
-<br style="clear:both;">
+* [[File:Setup003b1.png|right|bottom|320px]]Click on the ellipses choose from:
+** '''Select from Certificate Store...'''<br>Use an existing certificate from the computer's certificate store.
+** '''Import from File...'''<br/>Import a certificate from a file into the computer's certificate store.
-Click on a folder to view the emails it contains. Click on an email name in the lower left pane to view an individual email.
+<br clear=all>
-[[File:gsta_preview_02.png|center|500px]]
+==== Option 3: Obtain Certificate from Let's Encrypt ====
+* [[File:Setup003c1.png|right|bottom|320px]]This page lists the prerequisites for obtaining a certificate from Let's Encrypt, which are:
+** A public DNS record (A or CNAME) for this server must exist and point to its public IP address.
+** The server must be accessible from the Internet on TCP port 80 (HTTP) for Let's Encrypt's automatic domain approval process. A port forwarding on your firewall or gateway may be necessary.
+* Further information are available in [[Using Lets Encrypt Certificates]].
-Additional information about the email preview is available in chapter Working with Archived Emails.
+<br clear=all>
-= Searching Emails =
+* [[File:Setup003c2.png|right|bottom|320px]]To obtain a certificate from Let's encrypt an email address and the server name for which the certificate is requested must be entered in the corresponding fields.
+* Check the ''I accept Let's Encrypt's Subscriber Agreement'' box after you have read Let's Encrypt's Subscriber Agreement by clicking on the corresponding link.
-To locate emails quickly, MailStore offers a fast and convenient full-text search. Simply enter one or more keywords into the text field on the upper left of the application window and click ''Search'' or press the ''Enter'' key.
+<br clear=all>
-[[File:gsta_search_01.png|center|250px]]
+=== Completing the MailStore Server Setup Wizard ===
+*In the next step you can configure several settings of your MailStore Server installation:
+** [[File:Setup004.png|right|bottom|320px]]'''Auto-configure Windows Firewall'''<br/>If this option is enabled, the [[MailStore_Server_Service_Configuration#IP_Addresses_and_Ports|default MailStore TCP ports]] will be opened in the Windows Firewall by the installation program automatically.
+** '''Automatic license update'''<br/>If this option is enabled, MailStore Server regularly checks for updated license data. If a new license is available, e.g. more users have been licensed or the Update and Support Service contract has been extended, it will be downloaded and applied automatically.
+** '''Enable automatic update check for server'''<br/>If this option is enabled, MailStore Server regularly checks for new product versions. If a new version is available, this will be displayed on the dashboard in the MailStore Client.
+** '''Enable automatic update check for Web Access'''<br/>If this option is enabled, MailStore Server regularly checks for new versions of the [[Accessing_the_Archive_with_MailStore_Web_Access|MailStore Web Access]]. If a new version is available, this will be displayed on the dashboard in the MailStore Client.
+** '''Automatically install updates'''<br/>If this option is enabled, new versions of MailStore Web Access will be downloaded and installed automatically without having to restart the [[MailStore_Server_Service_Configuration|MailStore Server Service]].
-Search results are displayed below the tree. Click on an email name to view a particular email.
+=== Help us to improve MailStore ===
+* At the end of the installation process you can opt to help us improving MailStore:
+** [[File:Setup005.png|right|bottom|320px]]'''Submission of anonymous usage data'''<br/>If this option is enabled, MailStore Server regularly sends data on how the program is being used to MailStore. This data allows us to better understand different usage scenarios of MailStore Server and focus our development capacities accordingly. The submitted data is collected and evaluated exclusively for this purpose.<br/>No personal data such as user names, passwords or email content will be submitted. The submitted data is completely anonymized and cannot be correlated to a specific customer installation. You can enable or disable this option in the MailStore Client under [[Product Updates|Administrative Tools > Miscellaneous > Product Updates]] at any time; the option is disabled by default (opt-in).
+* By clicking on ''Finish'' the installation will be completed and the MailStore Server Service and the MailStore Client will be started.
-[[File:gsta_search_02.png|center|250px]]
+== Customizing the Installation ==
+The installation program creates a fully functional default installation of MailStore Server, which is perfectly suited for testing purposes. For production environments, parameters such as the Master Database directory, features, TCP ports, SSL certificates etc can be customized via the [[MailStore Server Service Configuration]].
-Additional information about using quick search is available in chapter Working With Archived Emails.
+== First Time Installation ==
+After successfully installing MailStore Server for the first time, it is recommended to continue with the [[Quick Start Guide]]. A step-by-step tutorial explains the basics, from creating users to successfully archivig emails for the first time.
+<noinclude>
+[[de:Installation]]
+[[en:Installation]]
+</noinclude>