Versions Compared

Version Old Version 12 New Version 13
Changes made by

David Lawrence (Unlicensed)

Roselle B Dela Fuente (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
*The Installation Prerequisites are listed at the lower portion of this document

We now have a simplified way of installing the LIPI program using our new CLI Tool. This is a comprehensive document about LIPI and is divided into 5 parts:

I. Installing the LIPI CLI Tool

II. CLI Commands for operational use

III. Scenarios during Installation, Updates and Troubleshooting

IV. Summary of Common CLI commands

V. Prerequisites for the LIPI Installation

Table of Contents

I. Installing the LIPI CLI Tool

Download the CLI Tool

Code Block
wget -O lipi https://storage.mazemap.com/lipi/latest/lipi

...

Code Block
Saving config: OK
Installing cron: OK
Setup complete

...

II. Usage commands

Download and install latest LIPI

...

Code Block
languagebash
lipi --reconfigure

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).

...

  • --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

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

...

Action

Command

Comment

Start LIPI server

sudo systemctl start lipi


Stop LIPI server

sudo systemctl stop lipi


Restart LIPI server

sudo systemctl restart lipi


Status of LIPI server

sudo systemctl status lipi


Check the lipi log

journalctl -u lipi -n 200 -f


Create a new command line user in CMX

cmxos apiserver user add [the_username] [the_password]


Update lipi

Download the new lipi 

Make sure that the file is executable by typing:
chmod +x upgrade.sh
Then run the command:
sudo ./upgrade.sh


open and update the config file

sudo nano config.json


view the config file

cat config.json


Move a file from one location to another

mv <start location> <end location> 
e.g. mv /home/cygate/config.json /srv/

In the example the config file is located in /home/cygate and we are moving it to /srv/. We are replacing the old file with the new file.

...

V. Prerequisites for the LIPI Installation

Requirements for the LIPI server

...