Configuration

You can find the default configuration here. The configuration is not true json as comments are permitted.

Section: server

This is the core server configuration.

Key	Default	Description
data	./	The location to store data. This location is used for the database and where certificates are generated
persist_messages	true	Persist messages to the local database. Disabling this may improve throughput if the database is on a slow storage medium.
name	hostname	This is the node name provided to the server. If not specified, the hostname will be used.

Section: api

This section controls the core API experience.

Key	Default	Description
port	8080	The port to listen on
swagger	true	Toggles the api documentation endpoint (/swagger)
ssl	false	Use SSL/TLS to secure the connection
cert	server.p12	The path to the certificate if using SSL
passphrase	atakatak	The passphrase for the certificate

Section: websockets

This section controls the web sockets experience.

Key	Default	Description
enabled	true	Toggles the web sockets experience
port	5000	The port to listen on
ssl	false	Use SSL/TLS to secure the connection
cert	server.p12	The path to the certificate if using SSL
passphrase	atakatak	The passphrase for the certificate

Section: tak

This section controls the CoT routing experience. OpenTakRouter is capable of hosting both tcp and tls servers simultaneously.

Section: tcp

This section controls the TCP endpoint for CoT traffic.

Key	Default	Description
enabled	true	Toggles the TCP CoT endpoint
port	58087	The port to listen on

Section: tls

This section controls the TLS endpoint for CoT traffic.

Key	Default	Description
enabled	true	Toggles the TLS CoT endpoint
port	58089	The port to listen on
cert	server.p12	The path to the certificate if using SSL
passphrase	atakatak	The passphrase for the certificate

Section: peers

This section lists peers for federation.

Key	Default	Description
name	None	The name of the peer
mode	duplex	The mode of the connection.
		duplex - Send and Receive
		receive - Only receive events, do not retransmit
		transmit - Only retransmit events, ignore incoming events
address		The hostname or ip address of the peer
port	8080	The port to connect on
ssl	false	Use SSL for the peer connection
cert	server.p12	The path to the certificate if using SSL
passphrase	atakatak	The passphrase for the certificate

Example peers configuration:

"peers": [
    {
        "name": "foo",
        "mode": "duplex",
        "address": "foo.example.com",
        "port": 8087,

        "ssl": true,
        "cert": "/certs/example/server.p12",
        "passphrase": "atakatak"
    },
    {
        "name": "bar",
        "mode": "transmit",
        "address": "foo.example.com",
        "port": 8087,
    },
]