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: