README.md

GM Relay

A Nostr relay that only accepts GM notes once a day. Comes with a bot to fetch some stats about your GMs.

Built with Khatru by fiatjaf

Live instance

• wss://gm.swarmstr.com

Simply add it to your relay list & forget it. It will collect all your GMs daily.

Running your own instance

If you'd like to run your own instance or modify relays behavior (eg. accept different kind of notes), here's how to do it:

Prerequisites

• Go: Ensure you have Go installed on your system. You can download it from here.

Setup

1. Clone the repository

git clone https://github.com/ptrio42/gm-relay.git
cd gm-relay

2. Copy .env.example to .env and set bot privkey (hex)

cp .env.example .env

3. Start the Project with Docker Compose

# in foreground
docker compose up --build
# in background
docker compose up --build -d

4. Access the relay

http://localhost:3336

Serving over nginx (optional)

server {
    server_name gm.swarmstr.com;

    location / {
        proxy_pass http://localhost:3336;
        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";
    }

Install certificate

sudo certbot --nginx -d gm.swarmstr.com

License

This project is licensed under the MIT License.