Relays is used to host Nostr relay binaries.
The binaries have been tested with and are used by Relay Wizard which is a CLI tool that helps you bootstrap a Nostr relay.
To download a relay binary navigate to the Releases page and click on the binary you want to download.
Alternatively, you can use Relay Wizard which will download the binary for your preferred relay implementation as well as bootstrap the rest of the relay.
Before running the binaries, you should first verify their authenticity. This will minimize the possibility of the binaries being compromised. To perform the verification you'll need to have gnupg and curl installed which are most likely already installed on your system, but if not here's how to install them on some operating systems:
sudo pacman -S gnupgsudo apt install -y gnupgsudo pacman -S curlsudo apt install -y curlNow you need to import the public key that signed the manifest file which you can do by running the following command:
curl https://keybase.io/nodetec/pgp_keys.asc | gpg --importYou're now ready to verify the manifest file. You will need to have the relays-x.x.x-manifest.sha512sum and the relays-x.x.x-manifest.sha512sum.asc files in the same directory as the binaries you downloaded where the x.x.x is replaced by whatever version of relays you're verifying.
To verify the manifest file run the following command:
gpg --verify relays-x.x.x-manifest.sha512sum.ascHere's the command to run for the latest version of relays:
gpg --verify relays-0.4.0-manifest.sha512sum.ascYou should see output similar to the following if the verification was successful:
gpg: assuming signed data in 'relays-0.4.0-manifest.sha512sum'
gpg: Signature made Sat 05 Oct 2024 08:43:11 AM UTC
gpg: using RSA key 252F57B9DCD920EBF14E6151A8841CC4D10CC288
gpg: Good signature from "NODE-TEC Devs <[email protected]>" [unknown]
gpg: aka "[jpeg image of size 5143]" [unknown]
Primary key fingerprint: 04BD 8C20 598F A5FD DE19 BECD 8F24 69F7 1314 FAD7
Subkey fingerprint: 252F 57B9 DCD9 20EB F14E 6151 A884 1CC4 D10C C288Unless you tell GnuPG to trust the key, you'll see a warning similar to the following:
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.This warning means that the key is not certified by another third party authority. If the downloaded file was a fake, then the signature verification process would fail and you would be warned that the fingerprints don't match.
When you get a warning like this it's also good practice to check the key against other sources, e.g., the NODE-TEC Keybase or the NODE-TEC GitHub.
You have now verified the signature of the manifest file which ensures the integrity and authenticity of the file but not of the binaries.
To verify the binaries you'll need to recompute the SHA512 hashes of the files, compare them with the corresponding hashes in the manifest file, and ensure they match exactly which you can do by running the following command:
sha512sum --check relays-x.x.x-manifest.sha512sumHere's the command to run for the latest version of relays:
sha512sum --check relays-0.4.0-manifest.sha512sumIf the verification was successful you should see the output similar to the following:
khatru-pyramid-0.1.0-x86_64-linux-gnu.tar.gz: OK
nostr-rs-relay-0.9.0-x86_64-linux-gnu.tar.gz: OK
strfry-1.0.1-x86_64-linux-gnu.tar.gz: OK
wot-relay-0.1.12-x86_64-linux-gnu.tar.gz: OK
relay29-0.4.0-khatru29-x86_64-linux-gnu.tar.gz: OK
relay29-0.4.0-strfry29-x86_64-linux-gnu.tar.gz: OKBy completing the above steps you will have successfully verified the integrity of the binaries.
The
relays-x.x.x-manifest.sha512sumfile contains checksums for multiple relay implementations, and you may not have downloaded all of them. This is why you may see output showingNo such file or directoryfor the missing files. Unless you’re using one of those files, you can ignore the output associated with them.
If you want to learn more about how to setup a relay from scratch, check out Relay Runner.
If you just want to know enough to get started, read the following sections to get a server, hook up a domain name and setup remote access:
You should then be able to run Relay Wizard:
curl -sL https://relayrunner.org/relaywizard.sh | bashIf you want to contribute consider testing the binaries by setting up your own relays, by following the Relay Runner guides, and by using Relay Wizard.
