khatru-pyramid/README.md

Khatru Pyramid

A relay based on Khatru with a invite hierarchy feature.

Deploy with docker

$ docker run \
    -p 3334:3334 \
    -v ./users.json:/app/users.json \
    -v ./db:/app/db \
    -e DOMAIN="yourdomain.example.com" \
    -e RELAY_NAME="your relay name" \
    -e RELAY_PUBKEY="your nostr hex pubkey" \
    tijlxyz/khatru-pyramid:latest

Deploy with

• YunoHost (app catalog pending)
• Cloudron (app catalog pending)

Manually build

$ git clone https://github.com/github-tijlxyz/khatru-pyramid 
$ cd khatru-pyramid
$ go build # or run
$ DOMAIN=example.com RELAY_NAME=test RELAY_PUBKEY=yourpubkey ./khatru-pyramid

Configuration

Format users.json as follows:

{ "[user_pubkey_hex]": "[invited_by_pubkey_hex]" }