Welcome to the relay.tools installation guide!

If you already have an instance of relay.tools set up, you may be looking for the documentation!

Installation

git clone https://github.com/relaytools/relay-tools-images.git
cd relay-tools-images/machines
./prereqs.sh
./build

This is a good time to grab some coffee. ☕ (Average time: 15-20m)

Configuration

Pre-requisites.

• You must have configured a domain to point to this IP address, preferrably with a wildcard DNS address.
• Eg *.example.com -> your IP

Change your.domain to your own domain.

export MYDOMAIN=your.domain
./configure.sh
machinectl enable mysql && machinectl enable strfry && machinectl enable relaycreator && machinectl enable haproxy
reboot

Troubleshooting

If the configuration step fails, typically it's because DNS was not set. Currently, re-running configure does not help. To try again, we need to wipe the installation and rebuild/configure.

First, remove our persistent data storage so we can start fresh:

rm -rf /srv/*

In the relay-tools-images/machines directory:

./clean
./build

After re-building, try the configure.sh script again and it should succeed.

Relay Creation

• Navigate to your domain in a browser and select the drop-down menu
• Sign in with Nostr (Authorize with NIP-07 extension)
• Create some relays!
• Feel free to check out some of the other documentation!

Other docs

Spiral's guide to relay.tools locally, Local Install Guide!