Installation

This page describes how to install and prepare Axon Server Proxy for use.

System requirements

Java runtime

When using the JAR distribution:

  • Java 21 or higher

  • Sufficient memory for your expected connection load (typically 256 MB - 1 GB)

Network requirements

  • Network connectivity to Axon Server admin nodes (default port 8124)

  • Inbound network access from your applications

  • Open port for the proxy to listen on (configurable)

Obtaining the proxy

Download the ZIP file

Download the latest axonserver-proxy.zip from the download server (https://download.axoniq.io/axonserver/axonserver-proxy.zip).

Use the Docker image

Alternatively, you can use the official Docker image docker.axoniq.io/axoniq/axonserver-proxy:<version>.

Prepare configuration

Before running the proxy, you need to prepare a configuration file. See Configuration for details.

Create a configuration file named proxy.properties in the working directory:

# Minimal configuration
proxy.servers=axonserver1:8124,axonserver2:8124
proxy.port=8124

Directory structure

A typical installation directory structure:

/opt/axon-server-proxy/
├── axon-server-proxy.jar (or native binary)
├── proxy.properties
└── logs/

Next steps