README.md

myrelay.page

Your relay is awesome, its landing page should be too.

A nostr.watch R&D project made possible by OpenSats

why

That websocket URI representing your relay is floating all over the internet now. Its canonical https shouldn't be a 500, a blank page or some random page. + I both need to do this to eat my own dog food and it's something I've wanted to do since early 2023.

overview

SvelteKit CSR site with SSR disabled that implements ndk, nostr-zap and @nostrwatch/nocap. Utilizes NIP-65, NIP-66, NIP-78 and NIP-32.

live demos

• wss://lunchbox.sandwich.farm
• wss://wot.sandwich.farm
• wss://relay.nostr.watch
• wss://relaypag.es
• wss://user.kindpag.es
• wss://appdata.kindpag.es

"try before you buy"

https://relaypage.netlify.app/?url=wss://your.relay

for example

• snort
• damus
• purplepag.es
• nostr.land

todo

• general
  • tailwind
  • shadcn-svelete UI components
  • progressive load w/skeletons
  • NIP-07 support
  • NIP-46 support
  • mobile compat
  • options generic
  • manually set URL via .env for build-time URL setting for explicit control and unhandled edge-cases
• unique blocks
  • nip-11
  • operator profile/feed
  • map
  • relay feed
  • speed test (need to patch @nostrwatch/nocap)
• repeatable blocks
  • html
  • image
  • md
  • feed
• stateful meta-data
  • nip-11
  • operator profile
  • operator notes
  • notes from relay
  • long-form content feed
  • NIP-19 encoded nevent jumps
  • relay Geodata
  • NIP-66 Monitor Data
    • seen by monitors
    • round-trip time of monitors
    • map reactiveness
    • ssl
  • uptime
• parsing
  • notes: images
  • notes: videos
  • notes: spotify
  • notes: tidal
  • notes: NIP-19 encoded nostr: links
• authed User Interactivity
  • login
  • add relay to relay list [10002]
  • zap relay operator
  • follow relay operator
  • "People you follow who are here"
  • "Notes you have here"
• no-build customization via NIP-78
  • general
    • theme import
    • show/hide blocks
    • order blocks
    • per block customization
    • hide login
    • disable join
  • theming
    • default runtime themes
    • theme selection
    • theme customization
  • runtime-imported CSR blocks (svelte)
    • http/https
      • custom block imports
      • custom block options
    • git
      • custom block imports
      • custom block options
    • blossom
      • custom block imports
      • custom block options
  • internationalization (i18n)
    • i18n mapped language
    • NIP-78 overrides

Deploy

early alpha, things will change, history will be full of haphazard commit messages, force pushes to reset history eminent ... but have at it.

build

pnpm install
pnpm build

Artifacts will end up in the build directory. You just neeed to serve them.

docker

docker build .

Image is not available on a registry yet

Important Notes

1. To use the editor, you need to login with the pubkey listed in your NIP-11. The pubkey must be hex in alignment with NIP-11, not your NIP-19 encoded npub
2. myrelay.page is self-configuring, you don't need to set a URL. In the event it is not working more than likely, it's one of the following causes:

• If you run a wss relay, you must serve myrelay.page from https,
• if you run a ws (unsecured) relay, for instance from onion or a local relay, you must serve myrelay.page from http
• You are not serving myrelay.page from the https url equivalent of your relay, see below if testing locally.

dev

pnpm dev

You can show a myrelay.page for any relay from localhost by appending ?url=wss://relay.snort.social for instance.

serving from relay canonical

Depending on your relay software, you'll need to do some proxying to direct websocket, NIP-11 and/or NIP-05 traffic to your relay, and http(s) traffic without application/nostr+json to the myrelay.page static path or port.

nginx/caddy/haproxy

caddy

• strfry: see caddy/strfry/Caddyfile
• nostream: soon
• nostr-rs-relay: soon

nginx

soon

haproxy

soon