5a1a400f45
to errors while loading relay configuration from the DB and that also caused the loaded meta information to be invalid. Mandatory fields for NostrRelay were not selected by the query, and a dictionary representation of the meta object should not be returned as it causes some members such as require_auth_filter and event_requires_auth to not be accessible, leading to breaking exceptions. |
||
|---|---|---|
| .github/workflows | ||
| relay | ||
| static | ||
| templates/nostrrelay | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierrc | ||
| __init__.py | ||
| client_manager.py | ||
| config.json | ||
| crud.py | ||
| description.md | ||
| helpers.py | ||
| LICENSE | ||
| Makefile | ||
| manifest.json | ||
| migrations.py | ||
| models.py | ||
| package-lock.json | ||
| package.json | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| tasks.py | ||
| toc.md | ||
| views.py | ||
| views_api.py | ||
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 joinandpay for storage - Storage Limit (can buy more)
- Rate Limit
- Filter Limit
- Allow/Block accounts
- Optional Auth for
EventsandFilters
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
AUTHenabled: send only to the intended target
- if
- NIP-09: Event Deletion
- NIP-11: Relay Information Document
-
Note
: the endpoint is NOT on the root level of the domain. It also includes a path (eg https://lnbits.link/nostrrelay/)
-
- 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 tokind 0metadata 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
The relay can be activated/deactivated.
- New Relay Dialog
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
domainis added automatically and shoud be corrected manually if needed. This value is used forNIP-42(Authentication of clients to relays)
- Relay Info Tab
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
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
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
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
Development
Create Symbolic Link:
ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay