Magnet Max Server “All-in-One” Installation and Upgrade Guide

===

Table of Contents

Section 1: Magnet Max Server Component Overview and Requirements

1.1 Architecture Overview
1.2 Network Overview
1.3 Component Overview
1.4 Required Components
1.5 Optional Components

Section 2: How to Install the Magnet Max Server “All-in-One"

2.1 Determine if Magnet Max Server runs and is supported on your platform.
2.2 Download the Magnet Max Server ZIP file
2.3 Install Magnet Max Server
2.4 Install Webserver
2.5 Set up SMTP Mail Server
2.6 Install the database server, configure it, and create the necessary tables
2.7 Install ElasticSearch and configure
2.8 Set up the Magnet Max Server storage for images, etc.
2.9 Configure and Test the Magnet Max Server setup

Section 3: How to Upgrade the Magnet Max Server “All-in-One”

3.1 Download the latest version of Magnet Max Server
3.2 Install in fresh directory
3.3 Copy configuration directory
3.4 Made any upgrade specific configuration changes as needed
3.5 Restart Magnet Max server

===

Section 1: Magnet Max Server Component Overview and Requirements

There are several applications that come together to make Magnet Max server 3.0 work. Be sure to use the versions listed as required.

1.1 Architecture Overview

The Magnet Max server is a Java-based application which typically runs on a Linux server. It utilizes several advanced client applications as helpers for search, data storage, etc.

[DIAGRAM OF COMPONENTS]

1.2 Network Overview

All requests are routed via NGINX.

[DIAGRAM OF TYPICAL SERVER LAYOUT]

1.3 Component Overview

The Magnet Max server "All-in-One" is composed of several pieces that work together. These pieces are:

  • Java (Version 1.7 or earlier REQUIRED)
  • Database (one of H2, Hsql, MySQL (VERSION 5.6 or earlier REQUIRED) or PostgreSQL)
  • ElasticSearch (either local or remote) (VERSION 1.7 REQUIRED)
  • E-Mail server
  • File storage (either local or remote)

1.4 Required Components

The following components are required for the Magnet Max server to function:

  • Server that can run Java-based applications
  • Database (available types listed in Section 1.3 above)
  • ElasticSearch (either local or remote). See https://www.elastic.co/.
  • E-mail server
  • File storage (either local or remote)

1.5 Optional Components

The following components are optional, but add additional functionality to the Magnet Max server:

  • SSL-enabled webserver: Used for encrypted communication between client and server
  • AWS (Amazon Web Services) S3 Buckets: These can be used instead of local file storage for images, etc.
  • Hazelcast: This is a cache style application that can be used to speed up database results, etc.

===

Section 2: How to Install the Magnet Max Server “All-in-One”

This section describes how to obtain and install the Magnet Max server “All-in-One” component. A summary of the procedure follows and later sections provide the details. If you plan to upgrade an existing version of Max Server to a newer version, see Section 3, How to Upgrade the Magnet Max Server “All-in-One” Application for information about upgrade procedures and issues that you should consider before upgrading.

First-time installation of Magnet Max server generally follows the steps outlined here:

  1. Determine if the Magnet Max server runs and is supported on your platform.
  2. Download the Magnet Max server ZIP file.
  3. Install the Magnet Max server.
  4. Install the Webserver.
  5. Set up the SMTP Mail Server.
  6. Install the database server, configure it, and create the necessary tables.
  7. Install ElasticSearch and configure it.
  8. Set up the Magnet Max server storage for images, etc.
  9. Configure and test the Magnet Max server setup.

2.1 Determine if Magnet Max Server runs and is supported on your platform.

Please note that not all platforms are equally suitable for running the Magnet Max server, and that not all platforms on which Magnet Max server is known to run are officially supported by Magnet, Inc. For information about those platforms that are officially supported, see http://www.magnet.com/support/supportedplatforms.html on the Magnet Web site.

Generally, any platform that supports Java version 1.7 and above should work. Refer to http://www.oracle.com/technetwork/java/index.html for more information.

2.2 Download the Magnet Max Server ZIP file

Download the latest package from here:

http://build.magnet.com:8082/job/Max-Server-Release/lastSuccessfulBuild/artifact/magnet-mobile-server/mms-single-server-dist/target/max-server.zip

2.3 Install Magnet Max Server

Unzip the "max_server.zip" file in the location that the Magnet Max server will execute from. This can be in a specific user’s home directory (as in the user the server will run under), or in any directory of your choice.

After unzipping, you will see a directory structure similar to this:

[DIAGRAM OF FILE STRUCTURE]

2.4 Install Webserver

Both of these web server applications are known to work with Magnet Max server:

Install the web server application of your choice, and after that follow the appropriate instructions below.

2.4.1 NGINX post-installation instructions

Please follow the instructions in the "Magnet Max Server 3.0 Deployment Properties" documentation for configuration details of NGINX.

2.4.2 Apache post-installation instructions

Please follow the instructions in the "Magnet Max Server 3.0 Deployment Properties" documentation for configuration details of Apache.

2.5 Set up SMTP Mail Server

The Magnet Max server uses e-mail for various tasks. A working email server is needed to run Magnet Max server. This can be either running locally or available via a 'relay-host'. Instructions for setting up or configuring an existing web server are beyond the scope of this document.

2.6 Install the database server, configure it, and create the necessary tables

The Magnet Max server can use these database engines:

2.7 Install ElasticSearch and configure it

Download and install ElasticSearch using the instructions found here:

After installation, there are only a couple of configuration changes that are needed to be made to the ElasticSearch set up to enable it to work. Please refer to the "Magnet Max Server 3.0 Deployment Properties" documentation.

2.8 Set up the Magnet Max Server storage for images, etc.

Next, set up storage on the Magnet Max server for images and other files. The Magnet Max server can use either local server file storage or AWS S3 buckets.

2.9 Configure and Test the Max Server setup

Please refer to the "Magnet Max Server 3.0 Deployment Properties" documentation for more configuration details for Magnet Max Server 3.0.

Magnet Max server has been programmed to provide installation feedback, to help track down installation issues. Use the following URLs to test your set up to ensure it is functioning as expected.

Standard API Calls:

Mobile API Calls:

===

Section 3: How to Upgrade the Magnet Max Server “All-in-One”

This chapter describes how to upgrade the Magnet Max server “All-in-One”. If you have not yet installed Magnet Max server, see Section 2: How to Install the Magnet Max Server “All-in-One” for information about installation and configuration procedures and about issues that you should consider before installing the Magnet Max server.

MAKE DATABASE BACKUPS. This cannot be stressed enough - you should always back up your existing database tables before performing an upgrade.

3.1 Download the latest version of Magnet Max Server

Download the latest package from here:

http://build.magnet.com:8082/job/Max-Server-Release/lastSuccessfulBuild/artifact/magnet-mobile-server/mms-single-server-dist/target/max-server.zip

3.2 Install in fresh directory

Install the Magnet Max server into a different directory than the one currently in use. This will help keep the two versions seperate, so you will be able to stop the upgrade and get the previous version running if there are any issues with the upgrade. After the upgrade is complete you can remove the old installation as desired.

3.3 Copy configuration directory

Copy the installation configuration details from the old Magnet Max server installation directory into the config files in the new installation directory. Ensure that any new configuration parameters have been set properly.

3.4 Made any upgrade specific configuration changes as needed

Some specific configuration changes may be required, depening on the Magnet Max server release. Please consult the "README" file included in the .zip file for more details.

Restart Magnet Max Server 3.0 and any related applications like ElasticSearch. After the restart, you can try the URLs listed above in Section 2.9, to confirm that Magnet Max server 3.0 has been upgraded properly and is functioning as expected.