Matrify Server

Installation guide

This article contains information about installing and maintaining the downloadable Matrify Server software on the user's hardware (on-premises).

Before following the steps below make sure that you have backups of your system.

Please note that misconfiguration can lead to security risks. It is in your responsibility to install this software in a secure way.

If you are not familiar with technical administration tasks consider using our SaaS hosting service instead.

Download

Request the download link on the Download page.

Extract

Download the zip-archive. Extract the archive in a folder of your choice, e.g. in the user's home directory <home directory>/matrify.

Archive contents

  • start.sh / start.bat - Script to start the server.
  • stop.sh / stop.bat - Script to stop the server.
  • matrify-server-x.x.x.x/ - The Matrify Server software.
  • data/ - The folder containing the configuration, database files and logs.
    • matrify.properties - Configuration file
    • *.lic - License file (optional)
  • jre1.x.x_xx/ - Java Runtime Environment

Starting the server

To start the Matrify Server change into the installation directory, e.g. <home directory>/matrify, and execute ./start.sh in a terminal window.

In order to start the server in a remote terminal session and keep it running after logout execute the command nohup ./start.sh &.

Check

Check if everything is working by opening the following link in your browser:
http://127.0.0.1:8182/app

Login with the username admin and the default server password re6ma8to to create an account.

The URL above is only working, if the Matrify Server and Client (your Browser) are running on the same system and the default configuration has not been changed!

If you changed the configuration or the server software is running on another system, adjust the URL accordingly, e.g. to http://192.168.1.10/app or http://matrify.local/app.

Stopping the server

To stop the Matrify Server change into the installation directory, e.g. <home directory>/matrify, and execute ./stop.sh in a terminal window.

Done!

Congratulation, this is all you need to run the Matrify Server on your local system.

However, if you want to install the Matrify Server on another system, please continue reading.


Further configuration

Configure your Matrify Server instance by adjusting the matrify.properties configration file.

Default configuration:

        ####################################
        ### Matrify Server Configuration ###
        ####################################
        
        # IP address/hostname the server
        SERVER_ADDRESS=127.0.0.1
        
        # Port number of the web service
        PORT=8182
        
        # IPs that are allowed to access the server
        # e.g. ALL       -> everyone
        # e.g. 127.0.0.1 -> only localhost
        # e.g. 192.168   -> IP range 192.168.1.1-192.168.255.255
        CLIENT_IP_ALLOW=127.0.0.1
        
        # Server password (at least 8 characters)
        SERVER_PASSWORD=re6ma8to
        
        # Configure SSL encryption
        SSL=OFF
        
        # Path to the JKS file; if no path is given the file is supposed to be in the data directory
        # For Windows OS use double back slashes (e.g. c:\\test\\yourkeystore.jks)
        #SSL_JKS_PATH=[path to jks-file]
        
        # Password for the JKS
        #SSL_JKS_PASSWORD=[password]
        
        # Password for the key inside the JKS
        #SSL_KEY_PASSWORD=[password]
        			

SERVER_ADDRESS
The IP address or hostname to access the sever. The default value 127.0.0.1 works only, if the server and client (user's browser) are running on the same system. An example of a typical intranet setup could be 192.168.1.10 or better matrify.local.
PORT

The port the Matrify Server is listening on.

Please note that the standard ports 80(http) and 443(https) are usually not usable by non-root users on Linux/Mac for security reasons. In order to use those ports anyway you can configure a proxy (e.g. Apache, Nginx) or your firewall to forward requests to the used port number.

CLIENT_IP_ALLOW

Restrict the IP addresses that can access the Matrify Server.

The default configuration 127.0.0.1 does only allow connections from localhost (server and browser on the same system). If you install the Matrify Server software on another system adjust the value accordingly. A typical value to allow only users on your local intranet to access ther Matrify Server could be 192.168 to allow IPs in the range 192.168.1.1-192.168.255.255 to connect. To allow everyone to connect set the value to ALL.

SERVER_PASSWORD
The administration password for the Matrify Server. On the login page the username admin with this password allows you to create new accounts, remove accounts and change the password of existing accounts.
The password does also allow you to log into any account as an administrator using the email address for the specific account.
SSL
SSL/TLS can be activated to encrypt the traffic sent between client (user's browser) and the Matrify Server. Value can be ON or OFF. If set to ON a Java KeyStore (JKS) file must be provided and the properties SSL_JKS_PATH, SSL_JKS_PASSWORD and SSL_KEY_PASSWORD must be set accordingly.

License file

Without a license file Matrify is starting in the Matrify Basic edition, which is limited to 5 users/seats and 500 records.

In case you have a valid license file (*.lic), just put it into the data folder and Matrify Server will start in the Matrify Pro edition.

Contact

If you have any questions or feedback contact: support@matrify.com

To purchase a license key contact: sales@matrify.com