RelayDiscovery

RelayDiscovery is a relay that specializes in serving relay kind nostr notes to make to make it easier for clients to implement the outbox model.

It's built on the Khatru framework.

Prerequisites

• Go: Ensure you have Go installed on your system. You can download it from here.
• Build Essentials: If you're using Linux, you may need to install build essentials. You can do this by running sudo apt install build-essential.

Setup Instructions

Follow these steps to get the RelayDiscovery Relay running on your local machine:

1. Clone the repository

git clone https://github.com/bitvora/relay-discovery.git
cd relay-discovery

2. Copy .env.example to .env

You'll need to create an .env file based on the example provided in the repository.

cp .env.example .env

3. Set your environment variables

Open the .env file and set the necessary environment variables. Example variables include:

# System Configuration
RELAY_NAME="RelayDiscovery.com"
RELAY_PUBKEY="e2ccf7cf20403f3f2a4a55b328f0de3be38558a7d5f33632fdaaefc726c1c8eb"
RELAY_DESCRIPTION="Discover relay lists for pubkeys on the nostr network"
RELAY_ICON="https://i.nostr.build/G5gKAZSmtCU1jDkf.png"
RELAY_PORT="3334"

LMDB_PATH="db/"
LMDB_MAPSIZE=0

GLOBAL_RELAYS="global_relays.json"

4. Build the project

Run the following command to build the relay:

go build

6. Create a Systemd Service (optional)

To have the relay run as a service, create a systemd unit file.

1. Create the file:

sudo nano /etc/systemd/system/relay-discovery.service

2. Add the following contents:

[Unit]
Description=RelayDiscovery Relay Service
After=network.target

[Service]
ExecStart=/home/ubuntu/relay-discovery/relay-discovery
WorkingDirectory=/home/ubuntu/relay-discovery
Restart=always

[Install]
WantedBy=multi-user.target

3. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

4. Start the service:

sudo systemctl start relay-discovery

5. (Optional) Enable the service to start on boot:

sudo systemctl enable relay-discovery

6. Serving over nginx (optional)

install nginx:

sudo apt-get update
sudo apt-get install nginx

You can serve the relay over nginx by adding the following configuration to your nginx configuration file located at /etc/nginx/sites-available/default:

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://localhost:3334;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

Replace yourdomain.com with your actual domain name.

After adding the configuration, restart nginx:

sudo systemctl restart nginx

8. Install Certbot (optional)

If you want to serve the relay over HTTPS, you can use Certbot to generate an SSL certificate.

sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx

After installing Certbot, run the following command to generate an SSL certificate:

sudo certbot --nginx

Follow the instructions to generate the certificate.

8. Access the relay

Once everything is set up, the relay will be running on localhost:3334 or your domain name if you set up nginx.