Skip to main content

Archive Installation (zip / tar.gz)

Install MAPS Messaging on any OS with JDK 21 by extracting a release archive and running the start script.

Version token: Use {MAPS_VERSION} wherever a version appears. See the 4.0.1 example below.

Prerequisites​

  • Java 21 available on PATH (java -version should report 21.x)
  • Appropriate ports open (e.g., 8080 HTTP API; others per your config)
  • Execute permissions on the extracted scripts

Download​

Release archives (replace {MAPS_VERSION} with the desired version):

  • ZIP
    https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/{MAPS_VERSION}/maps-{MAPS_VERSION}-install.zip
  • tar.gz
    https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/{MAPS_VERSION}/maps-{MAPS_VERSION}-install.tar.gz

Example (4.0.1):

  • ZIP: https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/4.0.1/maps-4.0.1-install.zip
  • tar.gz: https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/4.0.1/maps-4.0.1-install.tar.gz

Tip: Keep each version in its own directory so you can roll back by switching folders.

Linux / macOS​

  1. Download & extract (choose one format)
# Using the version token
MAPS_VERSION=4.0.1   # set to the release you want

# tar.gz
curl -LO "https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/${MAPS_VERSION}/maps-${MAPS_VERSION}-install.tar.gz"
tar -xvzf "maps-${MAPS_VERSION}-install.tar.gz"

# or ZIP
curl -LO "https://repository.mapsmessaging.io/repository/maps_releases/io/mapsmessaging/maps/${MAPS_VERSION}/maps-${MAPS_VERSION}-install.zip"
unzip "maps-${MAPS_VERSION}-install.zip"
  1. Start
cd "maps-${MAPS_VERSION}"
chmod +x bin/start.sh
./bin/start.sh
  1. Verify
curl -s http://localhost:8080/api/v1/ping   # -> {"status":"Success"}
curl -s http://localhost:8080/health       # -> OK | Warning | Error

Windows​

  1. Download & extract the ZIP to a folder, e.g. C:\maps-{MAPS_VERSION}\
    (Example: C:\maps-4.0.1\)

  2. Start (Command Prompt or PowerShell)

cd C:\maps-{MAPS_VERSION}
bin\start.bat
  1. Verify (PowerShell)
(Invoke-WebRequest http://localhost:8080/api/v1/ping).Content   # {"status":"Success"}
(Invoke-WebRequest http://localhost:8080/health).Content        # OK | Warning | Error

If java is not found, install JDK 21 and/or set JAVA_HOME and update PATH.

Upgrades​

  • Stop the running instance.
  • Extract the new version to a new directory (e.g., maps-4.0.2).
  • Copy/merge your conf/ and any persistent data/ as needed.
  • Start the new version. Roll back by switching back to the previous folder.