README.md

Relay Runner 📡

Become a relay runner, help decentralize Nostr, and take control of your data.

Relay Runner will guide you through the process of setting up various relay implementations from scratch.

You'll learn how to:

• Get a server

• Get a domain name

• Set up remote access using SSH

• Configure nginx

• Set up a firewall

• Obtain and set up an SSL/TLS certificate

• Build the relay software

• Install the relay software

• Configure your relay

• Set up a systemd service for your relay

Contribute

This site use MKDocs Material.

To get started, fork and clone the repository, then run the following commands:

Enter the project directory:

cd relayrunner

Create a virtual environment:

python3 -m venv env

Active the virtual environment:

source env/bin/activate

Install the cairo package (macOS):

brew install cairo

Install python dependencies:

pip install -r requirements.txt

To run the site locally, run the following command:

mkdocs serve

The documentation is written in markdown and can be found in the docs directory.

You will also need to edit the mkdocs.yml file to add new pages to the site.