Difference between revisions of "Quick Start Guide"

[unchecked revision][checked revision]
 
(55 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Starting MailStore Client =
+
__NOTOC__
 +
== Install MailStore Server ==
 +
If you have not already downloaded the free 30-day trial version, please download it from {{go.mailstore.com|target{{=}}website&context{{=}}server-trial-download|www.mailstore.com}} and start the installer by double-clicking the setup file.
  
After successful [[Installation|installation]], a new ''MailStore Client'' icon will appear on the desktop; simply double click this icon to start MailStore.
+
{{#ev:youtube|https://youtu.be/uIyH3kePDG4|350|right|''Tech Tip: Basics of Installing''}}
 +
It is a typical Microsoft Windows installer package. Thus, simply follow the on-screen prompts until you are asked to install a license.
  
'''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.
+
'''Hint''': Due to low system requirements, MailStore Server can be installed on a normal workstation computer for testing. Tests with a larger number of users should be done in an environment that follows our [[System Requirements]]. Our Tech Tip video provides an overview.
  
== Loggin On as Administrator ==
+
A test installation can be converted to a full version by just replacing the license key. It can also be moved to another computer at any time.
 +
<br clear="all">
  
[[File:gsta_login_01.png|right|350px]]
+
=== Install Trial License ===
 +
[[File:Setup003.png|right|350px]]
 +
After the program files have been copied by the installation program, you are required to enter a product key.
  
When logging on as administrator, you will be prompted for the access data. Server name ''localhost'', user name ''admin'' and password ''admin'' are preset; simply click on ''OK''. If asked whether to trust MailStore Server, click on ''OK'' as well.
+
You can now either install the trial license you were emailed after downloading the free trial version or a license you have purchased.
  
 
<br style="clear: both;" />
 
<br style="clear: both;" />
  
== Installing a License ==
+
=== Configure Certificate ===
 +
[[File:Setup003a.png|right|350px]]
 +
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.
  
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.
+
Though not recommended for production use, self-signed certificates may be a acceptable choice for a trial installation. But keep in mind that self-signed certificates will trigger certificate warnings in web browsers and email clients.  
  
== Changing the Password (Recommended)==
+
A better option is [[Using_Lets_Encrypt_Certificates|using Let's Encrypt Certificates]], which are suitable for both production and trial use.
  
To ensure security, the administrator password should be changed after the first start of MailStore: simply click on ''Administrative Tools'' > ''Users and Privileges'' > ''Users''. Double-click on the ''admin'' user and select ''Password...''.
+
The certificate can be changed any time after the installation through the [[MailStore Server Service Configuration]] tool.
  
'''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''.
+
<br style="clear: both;" />
 +
 
 +
=== Configure Self-Signed Certificate ===
 +
[[File:Setup003a1.png|right|350px]]
 +
 
 +
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 via DNS by your client computer.
 +
 
 +
<br style="clear: both;" />
 +
 
 +
=== Complete the Installation ===
 +
[[File:Setup004.png|right|350px]]
 +
At the end of the installation, select whether MailStore should automatically configure the Windows firewall and search for license and product updates regularly.
 +
 
 +
'''Help us to improve MailStore''' by enabling the option ''Submission of anonymous usage data'', whereby you help us to even better understand how our software is being used.
 +
 
 +
<br style="clear: both;" />
 +
 
 +
== Logging on as Administrator ==
 +
[[File:Gsta_login_02.png|right|350px]]
 +
The logon credentials (username/password: ''admin'') required for a newly-installed MailStore Server show up automatically in the two login dialogs.
  
= Adding New Users =
+
Therefore simply click ''Next'' and ''Log in'' in the username and password dialog to log on.
  
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.
+
<br style="clear: both;" />
  
<p class="msnote">'''Important notice:''' This chapter describes how you can add a MailStore user manually. However, users can also be added through [[Active Directory Integration]], [[Generic LDAP Integration]] or [[MDaemon Integration]]. In addition, MailStore users can be created automatically during archiving a Microsoft Exchange Server.</p>
+
== Changing the Password ==
 +
[[File:LoginChangePassword001.png|right|350px]]
 +
After you have logged in, you are required to change the admin user's password.
  
== Opening User Management ==
+
Enter the new password into both the ''New Password'' and ''Repeat Password'' fields and click ''OK'' to proceed.
  
 +
The passwords must meet the [[Notes on Password Complexity|complexity rules]].
 +
 +
<br style="clear: both;" />
 +
 +
== Create Users ==
 +
It may be more economical to synchronize users with a directory service rather than creating them manually, depending on your system environment. In addition to Active Directory and generic LDAP support, MailStore Server also enables you to synchronize users from MDaemon, Kerio Connect and IceWarp mail servers. By means of the generic Application Integration, users can also be synchronized with your own backend.
 +
 +
If your initial archiving needs only encompass a single mailbox or email files (such as a PST file), manual user creation is entirely adequate.
 +
 +
=== Option 1: Synchronize Users ===
 +
To set up synchronization with a directory service in MailStore Server,
 +
proceed as follows:
 +
 +
* Click ''Administrative Tools'' > ''Users and Archives'' > ''Directory Services''.
 +
* Change the ''Directory Services Type'' to the directory service that matches your environment.
 +
* Next, enter the required settings for the selected ''Directory Services Type''. In-depth descriptions of these settings are provided in the MailStore Server help section.
 +
* ''Optional:'' Click ''Default Privileges...'' to view and specify privileges for new users provided from a directory service.
 +
* To test your entries, click ''Test Settings'' and check the results.
 +
* To synchronize, and thereby create the users, click ''Synchronize Now''.
 +
 +
'''Hint:''' Some archiving profiles provide a ''Synchronize with directory service before archiving'' option, which can be used to ensure that MailStore synchronizes users and their properties regularly.
 +
 +
=== Option 2: Create Users Manually ===
 
[[File:QuickStart_users.png|right|350px]]
 
[[File:QuickStart_users.png|right|350px]]
 +
To create users manually, proceed as follows:
  
Click on ''Administrative Tools'' > ''Users and Privileges'' and select ''Users''; user management is displayed.
+
* Click ''Administrative Tools'' > ''Users and Archives'' > Users''.
 +
* Click Create ''New...''.
 +
* Enter a user name for the new user and confirm with ''OK''.
 +
* In the next window, enter the full user name and click the ''Password...'' button to specify a MailStore password for the new user. Passwords must meet the [[Notes on Password Complexity|complexity rules]].
 +
* Click ''OK'' to apply the settings and exit the User Properties.
  
== Adding a New User ==
+
'''Note:''' Manually-created users are permitted to archive email by default.
  
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''.
+
== Archiving Management based on Profiles ==
 +
=== Overall Concept ===
 +
In MailStore Server, email archiving is controlled using archiving profiles.
 +
An archiving profile contains the following data:
  
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.
+
* What is archived (for example, a specific mail server)
 +
* How much is archived (for example, specified mailboxes or a specific folder within a mailbox)
 +
* Additional settings such as deletion rules (these settings are disabled by default, enabling you to safely test MailStore in live operating environments)
  
== Logging On to MailStore Server as User ==
+
'''Note:''' Archiving profiles can either be run manually or according to a
 +
schedule and they can be modified or deleted at any time. This has no
 +
effect on previously archived emails.
  
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''.
+
'''Note:''' In MailStore Server, archived emails are always associated with
 +
specific users and stored in the corresponding user archives.
  
= Creating and Executing an Archiving Task =
+
=== Archiving Your First Email ===
 +
[[File:WuickStart_arch.png|left|350px]]
 +
MailStore users who are assigned the required privileges by the MailStore Administrator are able to archive individual mailboxes, local email client profiles, and email files.
 +
 
 +
Administrators are additionally able to centrally archive email for several or all users. Archiving profiles such as ''Multiple Mailboxes'' can be used for this purpose. To get to know MailStore, we recommend first archiving a single mailbox or a local email client profile. To do this, proceed as follows:
  
Once you have set up their accounts, you can archive emails for the new users:
 
[[File:WuickStart_arch.png|left|350px]]
 
* Click on ''Archive Email''.
 
* In the ''Create Profile'' area of the application window, select the source from which emails are to be archived.
 
* A wizard will help you define the properties of your archiving task (e.g. which mailbox is to be archived by which email server).
 
* Once completed, you can find your new archiving task in the list under ''Saved Profiles''.
 
* You can now run your archiving task manually or specify a schedule for its execution.
 
 
<br style="clear: both;" />
 
<br style="clear: both;" />
'''Notice'''
 
* Each archiving task can be executed any number of times. MailStore only archives emails which are not yet stored in the archive. By default, no emails will be deleted and no changes will be made to the mailboxes, email clients or email files (e.g. PST files) that are to be archived.
 
* When archiving, emails will be indexed automatically and can be located using the integrated full-text search. By default, the contents of file attachments are not included in the search index. To be able to include the contents of certain file attachments in the search, MailStore Server has to be configured accordingly. This can be done in ''Administrative Tools'' > ''Storage'' > ''Search Indexes''.
 
  
= Setting Up User Access to the Archive =
+
* Click ''Archive Email''.
MailStore provides several different ways for users to access their archived emails (their user archive):
+
* In the ''Create Profile'' area, select the source for archiving your email.
 +
* You can then specify the properties of the archiving profile using the Setup Wizard provided.
 +
* The last page in the Setup Wizard dialog box provides a ''Finish'' button, which you need to click in order to run the archiving profile.
 +
 
 +
After archiving is complete, you can immediately access the archived emails using the folder structure provided on the left of the window. The archiving profile you have just created is now displayed in the ''Saved Profiles'' list. From here, you can run it whenever it is required.
  
== Using MailStore Client ==
+
'''Note:''' If you are logged on as the MailStore Administrator while setting up the archiving profile, you can also specify the user archive in which the emails are stored. If you are logged on as a regular user, this is always your own user archive. Please note that in case you are archiving emails into the archive of another user, you will not be able to access these emails, as long as the ''Archive Access'' is blocked for MailStore administrators in the [[Compliance General|compliance settings]].
MailStore Client is a Windows application that can be installed on any number of user computers (depending on the license purchased). Of all the options for accessing the archive, MailStore Client provides the largest range of functions: Not only can users browse and view their emails but, depending on the privileges assigned to them, set up and execute archiving and exporting tasks. The available functions of MailStore Client are explained in the chapter [[Accessing the Archive with the MailStore Client software]].
 
  
== Using the MailStore Add-In for Microsoft Outlook ==
+
== User Access to the Archive ==
The add-in can be included in the installation of MailStore Client or by using a separate setup-file. The add-in provides access to the archive directly from Microsoft Outlook. Additional information about this neat feature can be found in the chapter [[Accessing the Archive with the Microsoft Outlook integration]].
+
Users can access their individual user archives in a variety of ways. Click the ''Install MailStore Client on other Computers'' link on the desktop to access the installers for MailStore Client and the MailStore Outlook add-in.
  
== Using an Internet Browser (MailStore Web Access) ==
+
=== Via MailStore Client ===
The archive can be accessed using any internet browser; it does not require any additional software to be installed on the user computers. Simply enter ''http://servername:8461'',or ''https://servername:8462'' for an encrypted connection, into your browser. Please replace ''servername'' with the actual name of the server on which MailStore Server was installed. More information about this feature, called MailStore Web Access, is available the chapter [[Accessing the Archive with MailStore Web Access]].
+
With MailStore Client, users can access MailStore Server from any computer in the network. With this option, users can search and view emails that have been archived specifically for them. Additionally, users with the corresponding privileges can use MailStore Client to archive emails themselves.
  
== Using an iPhone Client==
+
=== Via the MailStore Outlook Add-In ===
 +
The MailStore Outlook add-in provides an additional toolbar in Microsoft Outlook that permits easy access to the archive.
  
Users can access the archive using their iPhone or iPod touch using a version of MailStore Web Access specialized for these devices. To find out more about this feature, please visit the chapter [[Accessing the Archive with iPhone and iPod touch]].
+
=== Via Other Email Clients ===
 +
MailStore Server provides an integrated IMAP server, that offers you read-only access to the archive for any IMAP capable email client. Especially for alternative email clients (Mozilla Thunderbird) or operating systems (e.g. MacOS or Linux), as well as for mobile platforms such as Android, IPhone or Symbian, this is a very convenient way of accessing the archive.
  
== Using an IMAP-capable Email Client ==
+
=== Via an Internet Browser (MailStore Web Access) ===
MailStore Server provides an integrated IMAP Server for accessing the archive that is independent of the operating system being used. This enables users to access their archives using most email clients even on Mac OS and Linux-workstations and mobile devices. This archive just needs to be set up like a regular mailbox.
+
MailStore Web Access provides users with access to the archive via any Internet browser and due to its responsive design also supports mobile devices. No additional software needs to be installed on the user's  computers. Simply enter <tt><nowiki>https://servername:8462</nowiki></tt> in your browser. Make sure to replace ''servername'' with the actual fully qualified domain name (e.g. <tt>mailstore.example.com</tt>) of the computer where MailStore Server is installed.
  
MailStore's integrates IMAP server can be enabled and configured through the [[MailStore Server Service Configuration]].
 
  
 
[[de:Quick_Start_Guide]]
 
[[de:Quick_Start_Guide]]
 +
[[en:Quick_Start_Guide]]

Latest revision as of 12:07, 16 April 2021

Install MailStore Server

If you have not already downloaded the free 30-day trial version, please download it from www.mailstore.com and start the installer by double-clicking the setup file.

Tech Tip: Basics of Installing

It is a typical Microsoft Windows installer package. Thus, simply follow the on-screen prompts until you are asked to install a license.

Hint: Due to low system requirements, MailStore Server can be installed on a normal workstation computer for testing. Tests with a larger number of users should be done in an environment that follows our System Requirements. Our Tech Tip video provides an overview.

A test installation can be converted to a full version by just replacing the license key. It can also be moved to another computer at any time.

Install Trial License

Setup003.png

After the program files have been copied by the installation program, you are required to enter a product key.

You can now either install the trial license you were emailed after downloading the free trial version or a license you have purchased.


Configure Certificate

Setup003a.png

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.

Though not recommended for production use, self-signed certificates may be a acceptable choice for a trial installation. But keep in mind that self-signed certificates will trigger certificate warnings in web browsers and email clients.

A better option is using Let's Encrypt Certificates, which are suitable for both production and trial use.

The certificate can be changed any time after the installation through the MailStore Server Service Configuration tool.


Configure Self-Signed Certificate

Setup003a1.png

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 via DNS by your client computer.


Complete the Installation

Setup004.png

At the end of the installation, select whether MailStore should automatically configure the Windows firewall and search for license and product updates regularly.

Help us to improve MailStore by enabling the option Submission of anonymous usage data, whereby you help us to even better understand how our software is being used.


Logging on as Administrator

Gsta login 02.png

The logon credentials (username/password: admin) required for a newly-installed MailStore Server show up automatically in the two login dialogs.

Therefore simply click Next and Log in in the username and password dialog to log on.


Changing the Password

LoginChangePassword001.png

After you have logged in, you are required to change the admin user's password.

Enter the new password into both the New Password and Repeat Password fields and click OK to proceed.

The passwords must meet the complexity rules.


Create Users

It may be more economical to synchronize users with a directory service rather than creating them manually, depending on your system environment. In addition to Active Directory and generic LDAP support, MailStore Server also enables you to synchronize users from MDaemon, Kerio Connect and IceWarp mail servers. By means of the generic Application Integration, users can also be synchronized with your own backend.

If your initial archiving needs only encompass a single mailbox or email files (such as a PST file), manual user creation is entirely adequate.

Option 1: Synchronize Users

To set up synchronization with a directory service in MailStore Server, proceed as follows:

  • Click Administrative Tools > Users and Archives > Directory Services.
  • Change the Directory Services Type to the directory service that matches your environment.
  • Next, enter the required settings for the selected Directory Services Type. In-depth descriptions of these settings are provided in the MailStore Server help section.
  • Optional: Click Default Privileges... to view and specify privileges for new users provided from a directory service.
  • To test your entries, click Test Settings and check the results.
  • To synchronize, and thereby create the users, click Synchronize Now.

Hint: Some archiving profiles provide a Synchronize with directory service before archiving option, which can be used to ensure that MailStore synchronizes users and their properties regularly.

Option 2: Create Users Manually

QuickStart users.png

To create users manually, proceed as follows:

  • Click Administrative Tools > Users and Archives > Users.
  • Click Create New....
  • Enter a user name for the new user and confirm with OK.
  • In the next window, enter the full user name and click the Password... button to specify a MailStore password for the new user. Passwords must meet the complexity rules.
  • Click OK to apply the settings and exit the User Properties.

Note: Manually-created users are permitted to archive email by default.

Archiving Management based on Profiles

Overall Concept

In MailStore Server, email archiving is controlled using archiving profiles. An archiving profile contains the following data:

  • What is archived (for example, a specific mail server)
  • How much is archived (for example, specified mailboxes or a specific folder within a mailbox)
  • Additional settings such as deletion rules (these settings are disabled by default, enabling you to safely test MailStore in live operating environments)

Note: Archiving profiles can either be run manually or according to a schedule and they can be modified or deleted at any time. This has no effect on previously archived emails.

Note: In MailStore Server, archived emails are always associated with specific users and stored in the corresponding user archives.

Archiving Your First Email

WuickStart arch.png

MailStore users who are assigned the required privileges by the MailStore Administrator are able to archive individual mailboxes, local email client profiles, and email files.

Administrators are additionally able to centrally archive email for several or all users. Archiving profiles such as Multiple Mailboxes can be used for this purpose. To get to know MailStore, we recommend first archiving a single mailbox or a local email client profile. To do this, proceed as follows:


  • Click Archive Email.
  • In the Create Profile area, select the source for archiving your email.
  • You can then specify the properties of the archiving profile using the Setup Wizard provided.
  • The last page in the Setup Wizard dialog box provides a Finish button, which you need to click in order to run the archiving profile.

After archiving is complete, you can immediately access the archived emails using the folder structure provided on the left of the window. The archiving profile you have just created is now displayed in the Saved Profiles list. From here, you can run it whenever it is required.

Note: If you are logged on as the MailStore Administrator while setting up the archiving profile, you can also specify the user archive in which the emails are stored. If you are logged on as a regular user, this is always your own user archive. Please note that in case you are archiving emails into the archive of another user, you will not be able to access these emails, as long as the Archive Access is blocked for MailStore administrators in the compliance settings.

User Access to the Archive

Users can access their individual user archives in a variety of ways. Click the Install MailStore Client on other Computers link on the desktop to access the installers for MailStore Client and the MailStore Outlook add-in.

Via MailStore Client

With MailStore Client, users can access MailStore Server from any computer in the network. With this option, users can search and view emails that have been archived specifically for them. Additionally, users with the corresponding privileges can use MailStore Client to archive emails themselves.

Via the MailStore Outlook Add-In

The MailStore Outlook add-in provides an additional toolbar in Microsoft Outlook that permits easy access to the archive.

Via Other Email Clients

MailStore Server provides an integrated IMAP server, that offers you read-only access to the archive for any IMAP capable email client. Especially for alternative email clients (Mozilla Thunderbird) or operating systems (e.g. MacOS or Linux), as well as for mobile platforms such as Android, IPhone or Symbian, this is a very convenient way of accessing the archive.

Via an Internet Browser (MailStore Web Access)

MailStore Web Access provides users with access to the archive via any Internet browser and due to its responsive design also supports mobile devices. No additional software needs to be installed on the user's computers. Simply enter https://servername:8462 in your browser. Make sure to replace servername with the actual fully qualified domain name (e.g. mailstore.example.com) of the computer where MailStore Server is installed.