/relayrunner

📡 A guide to setup Nostr relays

Primary LanguageDockerfileMIT LicenseMIT

Relay Runner

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

For Contributors

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.