Join our official collaboration hub!
Download the latest stable release from the downloads page and unzip contents under /opt/xoken
The Nexa node sources configurable parameters from two different config files, as below:
- node-config.yaml: Contains all the general Nexa node, Bitcoin P2P & listen endpoint related configurations.
- arivi-config.yaml: Contains all the Arivi P2P related configurations (typically autogenerated)
Place the node-config.yaml (provided in the release) in the same directory as the xoken-nexa executable. Typically you will need to update the following parameters.
- bitcoinNodeListenIP : the Nexa host's public IP that is used to interact with public Bitcoin mining nodes via BitconP2P.
- bitcoinNodeListenPort : the system port that is used to connect with public Bitcoin mining nodes. Default value of '3000' is recommended.
- endPointTLSListenIP : the host's public IP where the TLS endpoint is listening.
- endPointTLSListenPort : the port being used by the TLS server. Default value of '9090' is recommended.
- tlsCertificatePath : the TLS self-signed certificate file path, including the file-name.
- tlsKeyfilePath : the TLS keyfile path, including the file-name.
- tlsCertificateStorePath : Please set to any valid directory, currently the client certificate validation is disabled.
- endPointHTTPSListenIP : listen IP for the HTTPS REST API endpoint.
- endPointHTTPSListenPort : listen port for the HTTPS REST API.
- endpointneo4jUsername : neo4j username
- neo4jPassword : neo4j password
- logLevel : Debug/Warn/Error , Debug level is very verbose and is not recommended unless you are troubleshooting.
The rest are mostly tuning related parameters and meant for advanced users.
The following command can be used to generate a TLS certificate and keyfile pair:
openssl req -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -out example.crt -keyout example.key
The Xoken Nexa server can be started as below, and it will run as a daemon process by defualt
$ ./xoken-nexa
And to stop the node you can do
$ pkill xoken-nexa
Backup admin password & keysOnce the server has started successfully for the first time, open the nexa.log file and safely backup the auto generated admin password, this is needed to provision other users and control user/node privileges.
Open the newly generated arivi-config.yaml file and safely backup the application generated secret key. This is essential to restore the unique identity of your node, since nodes maintain the reputation of their peers.
e.g.
secretKey: d670be193389c79349edd8ea4194925609f39cbeffc59b78fc1b4d431c0ebac