Documentation/PalmOrder Server

PalmOrder Server

Portable JVM

Run PalmOrder Server with Java on Linux, macOS or Windows.

The Portable JVM distribution is suitable for Linux, macOS or Windows when the server startup is controlled by an administrator, a script or a custom service. Java is not included, so you need to install it separately.

Requirements

Java Runtime or JDK version 25 is required. Check your installed version:

java --version

If Java is installed in a non-standard location, set the JAVA_HOME environment variable before starting. Scripts run.sh and run.bat will use Java from this variable.

Prepare the catalog

  1. Extract the archive to a permanent directory, such as /opt/palmorder-server or C:\PalmOrderServer.
  2. Open config/application.yml and change the default admin password.
  3. Make sure the server has write access to data and logs.

The unpacked directory contains:

PalmOrderServer/
├── config/application.yml
├── data/
├── lib/palmorder-server.jar
├── logs/
├── run.sh
└── run.bat

Start the server

On Linux or macOS, navigate to the distribution directory and run:

./run.sh

On Windows, run run.bat or execute it with cmd.exe.

After starting, open:

http://localhost:8888/ui

To pass an option for the current run only, add it after the command. For example, for another port:

./run.sh --server.port=8899

For normal termination press Ctrl+C in the window where the server is running.

Constant launch

In portable JVM mode, the terminal must remain open while the server is running. For permanent work, use the operating system services manager:

When running through the service manager, its working directory should be the PalmOrderServer directory. Otherwise, the relative paths from config/application.yml may not point where you expect.

Before upgrading or moving a server, create a backup. See Update and Backup.