Skip to content

Installing xahaud

When running a node, users will have to configure settings based on whether the node will run on the test network or the main network. When transitioning a single node from one network to the other, database files must be wiped, except wallet.db, which contains the server’s identity credentials.

In addition to building from scratch, there are three ways to install xahaud: Docker, locally, and using a portable binary. The below install methods all rely on the xahaud builds published at: https://build.xahau.tech, though the end result is different.

To run xahaud in a Docker Container:

  1. Clone the appropriate (Mainnet or Testnet) Xahau Docker GitHub repository using the URL in the table below: git clone [repository-url]
  2. Navigate to the repository directory: cd [repository-name]
  3. Run: ./build
  4. Run: ./up
  5. Commands and additional information are located in the README.md file in the Docker repository. Configuration files and databases are located in the store directory inside the Docker directory.

The Xahau Docker repositories (Mainnet and Testnet) each contains a script to automate the local install process, so that xahaud can be run outside of Docker. These scripts will create systemd files, a ‘xahaud’ user, and default configuration files. The URLs for these scripts are in the table at the bottom of this page. To install locally:

  1. Download and run the install script: curl -sL [https://link-to-script] | bash
  2. Edit the configuration file: /opt/xahahud/etc/xahaud.cfg
  3. Verify and, if needed, edit the contents of the trusted validators file: /opt/xahaud/etc/validators-xahau.txt
  4. Start and enable xahaud to run automatically: systemctl enable —now xahaud
  5. Verify xahaud is running: /opt/xahaud/bin/xahaud server_info

Users seeking to install xahaud in non-traditional environments (e.g., outside Ubuntu) may benefit from the binary release packages, which are built with necessary dependencies. This install process is essentially the same as the “Local Install”, however, xahaud is not configured as a systemd service and config files are not installed in default directories.

  1. Download the latest release from https://build.xahau.tech
  2. Download and edit the relevant configuration and trusted validators files (see the table below for links to Mainnet and Testnet configurations). Ensure the paths to the validators-xahau.txt file, the database directory, and the logfile are accessible.
  3. Change permissions on the downloaded binary, so it is executable: chmod 500 [/path/to/xahaud]
  4. Consider restricting access to xahaud.cfg and validators-xahau.txt: chmod 400 xahaud.cfg validators-xahau.txt
  5. Run the binary: ./[path/to/xahaud] —net —conf [path to xahaud.cfg]
  6. Verify xahaud is running: ./[path/to/xahaud] server_info

This peering is relevant for both Docker containers and local installations.

ResourceMain NetworkTest Network
Documentation and Resourceshttps://xahau.network/Same as Mainnet
Hooks Smart Contract Documentationhttps://xrpl-hooks.readme.ioSame as Mainnet
Explorerhttps://explorer.xahau.network/https://explorer.xahau-test.net
Public WebSocket URLwss://xahau.networkwss://xahau-test.net
Network ID and Peer Listening Port2133721338
Peering and Bootstrap Serversbacab.alloy.ee 21337
hubs.xahau.as16089.net 21337
79.110.60.122 21338
79.110.60.124 21338
79.110.60.125 21338
79.110.60.121 21338

2a0c:3bc0::1c74 21338
2a0c:3bc0::169d 21338
2a0c:3bc0::1aaf 21338
2a0c:3bc0::1d78 21338
Docker Containerhttps://github.com/Xahau/mainnet-dockerhttps://github.com/Xahau/Xahau-Testnet-Docker
Local Install Scriptshttps://raw.githubusercontent.com/Xahau/mainnet-docker/refs/heads/main/xahaud-install-update.shhttps://github.com/Xahau/Xahau-Testnet-Docker/blob/main/xahaud-install-update.sh
Binary Releaseshttps://build.xahau.techSame as Mainnet
Sample Configuration Filehttps://github.com/Xahau/mainnet-docker/blob/main/store/etc/xahaud.sample.cfghttps://github.com/Xahau/Xahau-Testnet-Docker/blob/main/store/etc/xahaud.cfg
Sample Trusted Validators (UNL) Filehttps://github.com/Xahau/mainnet-docker/blob/main/store/etc/validators-xahau.sample.txthttps://github.com/Xahau/Xahau-Testnet-Docker/blob/main/store/etc/validators-xahau.txt
Documented Configuration Fileshttps://github.com/Xahau/xahaud/tree/dev/cfgSame as Mainnet
Github Build Actions (release numbers)https://github.com/Xahau/xahaud/actions?query=branch%3Arelease+is%3Asuccess+build+using+dockerSame as Mainnet