Installation

Axon Synapse is available for download at https://download.axoniq.io/axonserver/axon-synapse.zip.

The zip file contains Axon Synapse as an executable JAR file. Move the JAR file to your preferred location.

Synapse reads configuration from the axonsynapse.properties file in the startup directory. You can also provide properties as parameters for the Java process, or as environment variables.

The default HTTP port for Synapse is 8080. You can customize this by setting the server.port property.

For Synapse to work it’s important that it can connect to Axon Server. To specify the location of the Axon Server nodes, specify the property synapse.server-list. This is a comma separated list of host names and optional port numbers.

For example, to use 3 axon server nodes:

For example, an axon server node using a custom gRPC port (not 8124):

If you configure Axon Server to use transport layer security (TLS) for the gRPC communication, you need to perform additional steps to configure your installation. In this case, set the property synapse.use-tls to true.

If Axon Server requires authentication, you need to specify a token that Synapse uses to connect to Axon Server for its internal tasks (like retrieving the existing contexts). Create the synapse.auth.token property. This token should have an ADMIN or VIEW_CONFIGURATION role to get all contexts from Axon Server, or it can have roles for specific contexts to only get those contexts.

Please refer to the Configuration section for more information.

To run Axon Synapse, open a terminal window, and cd to the folder where you moved the JAR file, and execute the JAR file.

You should see the following status message on the command terminal.

You can access the Synapse admin interface using a browser at port 8080.