We now have a simplified way of installing the LIPI indoor positioning software using our new CLI Tool. This is a comprehensive document and is divided into 5 parts as shown below.

Please note that you will still need to involve someone who has access to the LIPI server, has experience with SSH and Linux, and preferably has access to CMX GUI. Let us make sure that our system is ready for our positioning system by checking these prerequisites beforehand and complying with them.

Note: If you are planning to install a LIPI that does not have internet connection, please refer to https://mazemap.atlassian.net/l/c/1eY8xdGE

Note: To install LIPI for DNA Spaces please refer to [Deprecated] LIPI for DNA Spaces Installation Guide

PREREQUISITES for the LIPI Installation

Requirements for the LIPI server

• Can be virtual or physical, does not matter.

  • No OVA currently available, one of the supported OSes needs to be installed.

  • Supported Operating systems: Newest stable Ubuntu or Debian.

  • Server/Virtual Machine(VM) specs: Tested to work with single Core VM with 3.5 GB Ram and 7 GB HDD.

  • Before you install LIPI, you need to install Java Headless, the command is

    sudo apt-get install openjdk-8-jre-headless

     

Requirements for the network

• Open port 443 from LIPI server to CMX (https for API).

  • Open port 443 from all wireless clients to LIPI (https for position requests).

  • Open port 443 from all wireless clients to MazeMap server.

  • Traffic from Wireless Clients to LIPI must not pass through NAT.

Requirements for the CMX 

If the lipi is to be configured to use DNA-Spaces (MazeMap Cloud Positioning) then ignore this part of the doc

• CMX set up with Location services activated and sufficient licenses.

  • Building maps, with correct map scaling and a minimum of 3 GPS markers per floor need to be set up on Cisco Prime, exported and imported into CMX.

    • GPS markers should use coordinates created using MazeMaps own map. MazeMap provides a tool for generating these. You can find the POI inspector-tool here: https://debug.mazemap.com/

  • Access points must be placed correctly (within a meter of actual location) in the maps in Cisco Prime.

  • Enable the API server

    cmxos apiserver enable cmxos apiserver restart

  • CMX GUI user for MazeMap with Full Read Only privileges set up on CMX.

  • CMX CLI API user with full Read and API access. Both CMX GUI and CLI users should have the same username/password
    To create a CMX CLI user ssh into your CMX and run the following command:

    cmxos apiserver user add

You will be asked to type in a username and password for the user - use the same username and password as you used for the GUI user.

Open

Dependencies

In order to upgrade the LIPI you will need the following:

• SSH access to the LIPI server.

• Access to CMX GUI (browser) and CLI (terminal).

• A device that is connected to the WiFi network that is used for positioning purposes. This requires you being on site at the campus and using public wifi network

• Pre-installed java in the server openjdk-8-jre-headless

• Access to Map Editor in MazeMap https://admin.mazemap.com/

• LIPI 4.1.1 software update tool that can be downloaded from here: https://storage.mazemap.com/lipi/latest/lipi

Information the customer has to send to MazeMap

• Private IP-address of the LIPI server (The one WiFi clients will connect to the LIPI with; in IPv4 or IPv6 formats). Used to set up DNS Record showing domain name *.mazepos.com

• Public IP address/es range/s for all WIFI-clients (the NAT-devices' IP-address if in use). Used for network configuration setup

• CMX Software version (we only support version 10.2 or later versions)

Now we are ready to Install the LIPI

I. Installing the LIPI CLI Tool

Download the CLI Tool

Make the file executable (root privilege required)

Add lipi command to your path. (root privilege required)

Complete the installation (one time setup of API key and installation folder).

Note: All lipi commands here on after should be run from the directory within which the lipi --setup command was run. This will be the directory that contains the params.txt file

Open

When you have already pasted the API key as shown above, you will get a new question regarding the name of your new folder in the field as shown below. (E.g, “lipi-install” or any intuitive name).

Once you have successfully installed the tool we use to install and set up the LIPI correctly, you will get the following message.

II. Usage commands

Download and install latest LIPI

(requires MazeMap API key and internet access)

Note: If this is the first installation, the tool will also download the configuration
file from MazeMap.

You will get the following questions. On ready to activate input y

You should get the message:

Run status check

You should get the message:

Run status check, and report to MazeMap

(requires MazeMap API key and internet access)

List available LIPI versions

(requires MazeMap API key and internet access)

Download and install specific version of LIPI

(requires MazeMap API key and internet access)

Install from local source

Install from MazeMap, using custom configuration file

Update config of running LIPI

(requires MazeMap API key and internet access)

Update config of running LIPI, using custom configuration file

(requires mazemap API key and internet access)

List installed LIPI versions and see which one is active

Activate a previous installation

Reconfigure running LIPI

Reinitialize the current configuration with new variables.

III. What happens during install and updating?

• If the MazeMap API key is set, the tool can download new versions of lipi and
  the configuration file from MazeMap servers.

• After running initial --setup, the tool will install a cron task which regularly
  runs the command lipi --status report. This will send lipi health data to MazeMap
  on a regular basis so that we can provide a better level of service to you. This is
  only installed if the MazeMap API Key is set during setup. If this is not installed
  we can not help debugging an installation, and we will not be able to help users
  if they have trouble accessing the LIPI service. See Run status check, and report to MazeMap
  to see what is reported to MazeMap.

• When installing a new version of LIPI, the update tool will prefer to use the
  configuration files of the currently running LIPI version. This can be overridden
  using the --config-path flag or by running --update-config before running
  --install.

• Every --install and --update-config creates a new installation version. This
  is done to allow switching between new and previous installations or configurations
  at will. If something goes wrong, a previous version can be activated using
  --activate. The installation or update process will activate the previous version
  if the new version can't be started or seem unresponsive (if --status does not
  show a fully healthy installation).

Manual fixing:

• --setup stored values in a file params.txt. Running --setup again will overwrite it.

• A LIPI service has a config.json in its installation folder, which can be copied,
  edited and used using --config-path, if needed.

• The folders under LIPI installation path are self contained and can be deleted at will.
  Just make sure to not delete the running version. Use --list or --status to see which
  version is running.

• LIPI is started using systemctl. Status and control of that service is available.
  systemctl [status|start|stop|restart] lipi.service.

IV. Summary of the Common CLI Commands

This summary contains commands that are useful when setting up the LIPI server.

The config file that is used is under the /srv folder use command cd to open folder and ls to read what is in the folder.

LIPI + CMX Architecture