Build

We're now going to discuss how to build nostr-rs-relay.

Dependencies

It's recommended to install the following packages before building the binary:

apt install build-essential cmake protobuf-compiler pkg-config libssl-dev

Git

We also need to install Git to be able to clone the nostr-rs-relay repository:

apt install git

Rust

Lastly, we need to install Rust and Cargo to build the binary:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

After running the above command, you'll be asked if you want to proceed with the standard installation or if you want to customize the installation. We're going to use the standard installation, so when prompted just press enter.

To configure your current shell after installing Rust, you need to source the corresponding env file under $HOME/.cargo.

This can be accomplished for sh, bash, zsh, ash, dash, and pdksh using:

. "$HOME/.cargo/env"

To check Rust is installed and in your path:

rustc --version

To check cargo is installed and in your path:

cargo --version

Clone the Repository

Before cloning the nostr-rs-relay repository, we're going to first create the following directories in the $HOME directory:

mkdir -p $HOME/nostr/relays

We can now navigate to the relays directory:

cd $HOME/nostr/relays

We're now ready to clone the nostr-rs-relay repository:

git clone https://git.sr.ht/\~gheartsfield/nostr-rs-relay

After cloning the repository, navigate to the nostr-rs-relay directory:

cd nostr-rs-relay

You can use the repository to update the nostr-rs-relay, so we're going to keep the repository on the relay.

Build nostr-rs-relay

We're now ready to build a release version of nostr-rs-relay:

cargo build --release

The compilation could take a while depending on your server's specs, so be patient while the binary is being built.

When the compilation is finished the binary will be located in the target/release directory.

To navigate to that directory run the following:

cd target/release

You can list out the contents of that directory to see the binary:

ls

You should see the binary file which should be named nostr-rs-relay.

Check Version

Here's how to check which version of nostr-rs-relay you've installed:

nostr-rs-relay --version

At the time of writing, the latest version of nostr-rs-relay is 0.9.0 which is what the rest of the guide is currently based on.

Run Binary

You can now run the binary with logging enabled:

RUST_LOG=warn,nostr_rs_relay=info ./nostr-rs-relay

The nostr-rs-relay should now be listening on 0.0.0.0:8080.

To stop the relay press Ctrl+C.