Difference between revisions of "Main Page"

[unchecked revision][checked revision]
(94 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}
 
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}
  
−
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. For administration of MailStore Instances, which is comparable to the on-premises solution MailStore Server, please visit the [http://en.help.mailstore.com/ MailStore Server Help]
+
Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.
  
 +
== Getting Started ==
 +
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of  instances, management of users, and the archiving of email.
 +
 +
=== Before You Start ===
 
{|  
 
{|  
−
| style="vertical-align: top; width: 50%" |
+
| style="vertical-align: top; width: 200px" | [[Overview]]
−
= General Information =
+
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios.
−
An introduction to the architecture, the most typical usage scenarios of the MailStore Service Provider Edition and further general yet important information are given by the following articles:
+
|-
 +
| [[System Requirements]]
 +
|  Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.
 +
|-
 +
| [[Frequently Asked Questions]]
 +
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.
 +
|}
 +
 
 +
=== Installation and Setup ===
 +
{|
 +
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]
 +
| Irrespective of the projected scenario, it all begins with the installation of the software itself.
 +
|-
 +
| [[Single Server Mode Setup|Initial Configuration]]
 +
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.
 +
|-
 +
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]
 +
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up.
 +
|}
 +
 
 +
=== Using MailStore Service Provider Edition ===
 +
{|
 +
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]]
 +
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.
 +
|-
 +
| [[Creating Instances]]
 +
| Within a the MailStore Service Provider Edition, every customer gets his  own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.
 +
|-
 +
| [[Accessing Instances]]
 +
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.
 +
|}
  
−
* [[Overview]]
+
=== Archiving Email ===
−
* [[Performance and Scalability Guidelines]]
+
{|
−
* [[Frequently Asked Questions]]
+
| style="vertical-align: top; width: 200px" | [[Instance Administration]]
−
| style="vertical-align: top; width: 50%" |
+
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.
−
= Installation and Setup =
+
|-
−
The ''Installation and Setup'' chapter provides an entire walkthrough of installation and setup process of MailStore Service Provider Edition. Each article ends with a "What to do next" section that guides to the next step.
+
|}
  
−
* [[System Requirements]]
+
=== Post Installation Tasks ===
−
* [[Installing MailStore Service Provider Edition]]
+
{|
−
* [[Firewall Configuration]]
+
| [[End User Access]]
−
* [[Single Server Mode Setup]] or [[Multi Server Mode Setup]]
+
| This article provides information on how to access an instance as a  customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.
−
* [[Replace Self-signed SSL Certificates]]
+
|-
−
* [[Branding]]
+
| style="vertical-align: top; width: 200px" | [[Branding]]
 +
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.
 +
|-
 +
| [[Replace Self-signed SSL Certificates]]
 +
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information.
 +
|-
 +
| [[Backup and Restore]]
 +
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.
 
|-
 
|-
 +
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]
 +
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to  configure the required SMTP settings.
 +
|-
 +
| [[Monitoring]]
 +
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.
 +
|-
 +
| [[Enhancing SSL Security]]
 +
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.
 +
|}
 +
 +
{|
 
| style="vertical-align: top; width: 50%" |
 
| style="vertical-align: top; width: 50%" |
  
−
= Management Console =
+
== Management Console ==
−
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide a general overview of all available functions. Every function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.
+
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.
  
−
* [[Management_Console|Logging On & Navigation]]
+
* [[Management_Console_-_Logging On|Logging On]]
 
* [[Management_Console_-_General|General]]
 
* [[Management_Console_-_General|General]]
 +
** [[Instance Management]]
 +
** [[Instance Administration]]
 
* [[Management_Console_-_Infrastructure|Infrastructure]]
 
* [[Management_Console_-_Infrastructure|Infrastructure]]
 
* [[Management_Console_-_Security|Security]]
 
* [[Management_Console_-_Security|Security]]
Line 35: Line 89:
 
| style="vertical-align: top; width: 50%" |
 
| style="vertical-align: top; width: 50%" |
  
−
= Instance Management =
+
== Management API ==
−
Managing MailStore Instances consist of two main areas: ''General Administration'' covers all aspects of creating, controlling and configuring instances, whereas ''Instance Administration'' deals with the administration of internal parameters for each instance such as archive stores, search indexes, user synchronization, archiving profiles, etc.
 
−
 
 
−
* [[Instance Management - General Administration| General Administration]]
 
−
* [[Instance Management - Instance Administration | Instance Administration]]
 
−
 
 
−
= Related Articles =
 
−
 
 
−
* [[Backup and Restore]]
 
−
* [[Application Integration|Directory Service: Application Integration]]
 
−
* [[Generic LDAP Integration|Directory Service: Generic LDAP Integration]]
 
−
* [[End Customer Access]]
 
−
* [[Startup Scripts]]
 
−
|-
 
−
| style="vertical-align: top; width: 50%" |
 
−
 
 
−
= Management API =
 
 
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.
 
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.
  
Line 57: Line 95:
 
* [[Management API - Function Reference|Function Reference]]
 
* [[Management API - Function Reference|Function Reference]]
 
* [[Management API - Command Line Client|Command Line Client]]
 
* [[Management API - Command Line Client|Command Line Client]]
−
: '''Example Implementation of API Libraries'''
+
'''Example Implementation of API Libraries'''
−
:* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]
+
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]
−
:* [[Python Library|Python]]
+
* [[Python API Wrapper Tutorial|Python]]
 +
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]
 +
|-
 
| style="vertical-align: top; width: 50%" |
 
| style="vertical-align: top; width: 50%" |
  
−
= Downloads =
+
== Related Articles ==
−
 
+
* [[Application Integration|Directory Service: Application Integration]]
−
:'''Active Directory Group Policy Templates'''
+
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]
−
 
+
* [[MailStore Server to MailStore SPE Migration]]
−
* [ftp://ftp.mailstore.com/spe/MailStoreSPE_ADM.zip ADM-Template]
+
* [[Moving Roles]]
−
* [ftp://ftp.mailstore.com/spe/MailStoreSPE_ADMX.zip ADMX-Template]
+
* '''Multi Server Mode'''
 +
** [[Multi Server Mode Setup|Setup]]
 +
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]
 +
* [[Renaming Servers]]
 +
* [[Moving Instances]]
 +
* [[Security Advisories]]
 +
* [[Startup Scripts]]
 +
* [[Update Notices]]
 +
* [[Working with SSL Certificates]]
 +
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]
 +
| style="vertical-align: top; width: 50%" |
  
−
:'''Example API Libraries and Clients'''
+
== Downloads ==
−
* [ftp://ftp.mailstore.com/pub/Scripts/PowerShell/MSSPE.PS.Lib.zip PowerShell Library]
+
'''Active Directory Group Policy Templates'''
−
* Python Library
+
* [[Media:MailStoreSPE_ADMX.zip|ADMX-Template]]
−
* [ftp://ftp.mailstore.com/spe/MailStoreSPE_Linux_Management_API_Client.zip Linux Management API Client]
 
 
|}
 
|}

Revision as of 14:05, 29 April 2020


Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The Getting Started section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.

Getting Started

The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.

Before You Start

Overview Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios.
System Requirements Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.
Frequently Asked Questions Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.

Installation and Setup

Installation Irrespective of the projected scenario, it all begins with the installation of the software itself.
Initial Configuration Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.
Firewall Configuration To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up.

Using MailStore Service Provider Edition

Logging On The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.
Creating Instances Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.
Accessing Instances A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.

Archiving Email

Instance Administration Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

Post Installation Tasks

End User Access This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.
Branding The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.
Replace Self-signed SSL Certificates For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information.
Backup and Restore In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.
SMTP Settings To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings.
Monitoring This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.
Enhancing SSL Security The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.

Management Console

The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding Management API command, which allows full, script-based control over MailStore Service Provider Edition.

Management API

The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.

Example Implementation of API Libraries

Related Articles

Downloads

Active Directory Group Policy Templates

Retrieved from "https://help.mailstore.com/en/spe/index.php?title=Main_Page&oldid=1838"