Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Lipi is now available via docker. if you already have docker installed, you could run LIPI with only a few commands. To install docker on various platforms see https://docs.docker.com/get-docker/

Environment variables

...

LIPI_API_KEY - Api key from lipi config in Map Editor

...

LIPI_HTTP_SCHEME - The http protocol LIPI will run with (http or https)

...

POSITION_PROVIDER_USERNAME - Username of the position provider (CMX, Aruba ALE...)

...

POSITION_PROVIDER_PASSWORD - Password of the position provider (CMX, Aruba ALE...)

...

HTTP_PROXY_SCHEME - Proxy server protocol (http or https)

...

HTTP_PROXY_HOST - Host name of proxy server

HTTP_PROXY_PORT - Port number for proxy server

Required

  • LIPI_API_KEY

  • POSITION_PROVIDER_USERNAME

  • POSITION_PROVIDER_PASSWORD

Optional and defaults

  • LIPI_HTTP_SCHEME='https'

    • Possible Values: http, https

Running LIPI

...

LIPI

...

...

Create an environment variable file lipi-docker-env-file

Code Block
languagebash
LIPI_API_KEY=<lipi-api-key>
POSITION_PROVIDER_USERNAME=<username-here>
POSITION_PROVIDER_PASSWORD=<password-here>

Then use the environment variable file to start the lipi

Code Block
languagebash
docker run --rm --name lipi \
 --env-file=lipi-docker-env-file \
 -p 443:8080 \
  gcr.io/mazemap-public-docker/lipi:

...

Alternatively you can include the environment variables in the docker run command
Remember to fill in the placeholders

Code Block
languagebash
LIPI_IMAGE_VERSION=4.2.2
LIPI_API_KEY=<lipi-api-key>
docker run --rm --name lipi \
    -e LIPI_API_KEY=$LIPI_API_KEY  \
    -e POSITION_PROVIDER_USERNAME=<username-here> \
    -e POSITION_PROVIDER_PASSWORD=<password-here> \
    -p 443:8080 \
    gcr.io/mazemap-public-docker/lipi:$LIPI_IMAGE_VERSION
latest

Start Server with local config.json file

...

Code Block
languagebash

...

docker run --rm --name lipi \
    -

...

-env-file=lipi-docker-env-file \
    -v <your-config-path>:/app/resources/local_config.json \
    -p 443:8080 \
    gcr.io/mazemap-public-docker/lipi:

...

latest

Applying LIPI Config Changes

...

Code Block
languagebash
docker restart lipi-server

...

Available LIPI versions

You can choose to run a specific LIPI version by replacing latest with a specific version string. To list available versions:

Code Block
languagebash
docker image ls  --format '{{json .Tag}}'  gcr.io/mazemap-public-docker/lipi

Recognized variables

  • LIPI_API_KEY - Api key from lipi config in Map Editor

  • LIPI_HTTP_SCHEME - The http protocol LIPI will run with (http or https)

  • POSITION_PROVIDER_USERNAME - Username of the position provider (CMX, Aruba ALE...)

  • POSITION_PROVIDER_PASSWORD - Password of the position provider (CMX, Aruba ALE...)

  • HTTP_PROXY_SCHEME - Proxy server protocol (http or https)

  • HTTP_PROXY_HOST - Host name of proxy server

  • HTTP_PROXY_PORT - Port number for proxy server

Required

  • LIPI_API_KEY

  • POSITION_PROVIDER_USERNAME

  • POSITION_PROVIDER_PASSWORD

Optional and defaults

  • LIPI_HTTP_SCHEME='https'

    • Possible Values: http, https