Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 4.05 KB

README.md

File metadata and controls

115 lines (81 loc) · 4.05 KB
Raw

Nostr Relay

One click and spin up your own Nostr relay. Share with the world, or use privately.

Configure:

  • Free Plan: with limitted storage (limit can be changed)
  • Paid Plan: pay to join and pay for storage
  • Storage Limit (can buy more)
  • Rate Limit
  • Filter Limit
  • Allow/Block accounts
  • Optional Auth for Events and Filters

Supported NIPs

  • NIP-01: Basic protocol flow
  • NIP-02: Contact List and Petnames
    • kind: 3: delete past contact lists as soon as the relay receives a new one
  • NIP-04: Encrypted Direct Message
    • if AUTH enabled: send only to the intended target
  • NIP-09: Event Deletion
  • NIP-11: Relay Information Document
  • NIP-12: Generic Tag Queries
    • todo
  • NIP-15: End of Stored Events Notice
  • NIP-16: Event Treatment
    • Regular Events
    • Replaceable Events
    • Ephemeral Events
  • NIP-20: Command Results
    • todo: use correct prefixes
  • NIP-22: Event created_at Limits
  • NIP-26: Delegated Event Signing
    • not planned
  • NIP-28 Public Chat
    • kind: 41: handled similar to kind 0 metadata events
  • NIP-33: Parameterized Replaceable Events
    • todo
  • NIP-40: Expiration Timestamp
    • todo
  • NIP-42: Authentication of clients to relays
    • todo: use correct prefix
  • NIP-50: Search Capability
    • todo

Create Relay

Creating a new relay is straightforward. Just click New Relay then enter the Relay Info.

Note: admin users can select a relay id. Regular users will be assigned a generated relay id. The relay can be activated/deactivated.

  • New Relay Dialog
    • image

Configure Relay

Find your Relay in the list and click the expand button (+) to configure it.

Relay Info

This tab contains data according to NIP-11 (Relay Information Document).

Note: the domain is added automatically and shoud be corrected manually if needed. This value is used for NIP-42 (Authentication of clients to relays)

  • Relay Info Tab
    • image

Payment

By default the relay is free to access, but it can be configured to ask for payments. It is encourage to also activate the Require Auth option for paid relays.

Note: check the info button (I) tooltip for a description of each field.

  • Payment Config Tab
    • image

Click on the Relay ID (or visit https://{your_domain}/nostrrelay/${relay_id}) for the Relay public page. Here the entry and storage fees can be paid.

  • Relay Public Page
    • image

Config

Configure NIP-22 (Event created_at Limits), NIP-42 (Authentication of clients to relays) and other Relay parameters.

Some configurations are not standard (NIPs) but they help control what clients are allowed to do, thus blocking (some) attack vectors.

Note: check the info button (I) tooltip for a description of each field.

  • Config Tab
    • image

Accounts

Allows the Relay operator to Block or Allow certain accounts.

If an account is allowed then it is not required to pay to join.

When an account is blocked it does not matter if it paid to join or if it is allowed.

  • Accounts Tab
    • image

Development

Create Symbolic Link:

ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay