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!

If you would like to install relay.tools locally, check out the local install guide!

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

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

Relay Creation

• Navigate to your domain in a browser and authorize with NIP-07 extension

• Select 'create relay' from the drop-down menu

• Create some relays!

• Feel free to check out some of the other documentation!