The end of life (EOL) date for this module is on 31 January, 2020.

Run a Cluster Node

Step 1: Download and extract the node

To begin, download the Open Access Node zip file from our Downloads Page. Extract the downloaded server package into your installation directory of choice.

Step 2: Configure the nodes address

Now we need to configure the node address. This should be a hostname or IP that is reachable by your intended clients.

Edit the configuration file config/application.conf, configure the akka.remote.netty.tcp.hostname and the first akka.cluster.seed-nodes entry with the address. If you intend to run the client locally on the same node this can be left as localhost, however an appropriate hostname is recommended. Here we use

akka {
    remote.netty.tcp {
        hostname = ""
        port = 2551
    cluster {
        seed-nodes = ["akka.tcp://", ...]

See Cluster Network settings for more details.

Note: The hostname (and seed-nodes) address are used to resolve the location of the node on the network and as a unique identifier in the OpenAccess cluster. It is important that you use the same value in the client when connecting. If you set hostname to, then the URL in your client code would be geneos.cluster:// In the example above, we would need to use geneos.cluster:// They are not interchangeable!

Step 3: Configure the node to connect to a gateway

Edit the configuration file config/settings.conf and edit the gateways part of the file to point the host and port at your gateway.

gateways {
    My Gateway {
        host = "my.gateway.hostname"        port = 30000

See Gateway Connections for more gateway settings

Step 4: Run the Open Access Node

Simply execute the script on *nix or node.bat on Windows. (For more on the node script see /cluster/oacluster_script)

The server will start and then pause briefly with the output:

2013-08-21 12:39:15,967  INFO - Waiting for all cluster members: 1

The node will then attempt to connect to the gateway configured:

2013-08-21 12:39:22,298  INFO - Adding gateway connection my.gateway.hostname:30000
2013-08-21 12:39:22,308  INFO - Adding connection: Key[my.gateway.hostname:30000] Host[my.gateway.hostname] Port[30000], ...