hulxv/Nostr Relay

Downloads and starts a pre-built nostr-rs-relay

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Mar 7, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: hulxv/nostr-relay-action@f9b2992e6dac9fa9fe7509633f677b1313d8c7c0 # v1.0.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
portPort to run the relay onno8000
addressAddress to bind the relay onno0.0.0.0
versionRelease tag from nostr-relay-action repo (e.g. master or 0.9.0)yes
startWhether to start the relay after downloadingnotrue
relay_urlPublic-facing URL of the relayno""
nameRelay namenonostr-rs-relay (CI)
descriptionRelay descriptionno""
pubkeyRelay operator pubkey (hex)no""
contactRelay operator contactno""
max_event_bytesMaximum size of an EVENT message in bytesno262144
max_ws_message_bytesMaximum WebSocket message size in bytesno262144
max_ws_frame_bytesMaximum WebSocket frame size in bytesno262144
messages_per_secMax event writes per second (leave empty for unlimited)no""
subscriptions_per_minMax subscriptions per minute (leave empty for unlimited)no""
event_kind_blacklistComma-separated list of event kinds to blacklistno""
event_kind_allowlistComma-separated list of event kinds to allowlistno""
limit_scrapersWhether to limit scrapersnofalse
pubkey_whitelistComma-separated list of pubkeys allowed to publish (leave empty to allow all)no""
nip42_authEnable NIP-42 authenticationnofalse
nip42_dmsSend DMs only to authenticated recipients (requires nip42_auth)nofalse
db_engineDatabase engine (sqlite or rocksdb)nosqlite
db_min_connMinimum database connectionsno4
db_max_connMaximum database connectionsno8
db_in_memoryUse in-memory database (data lost on stop)notrue
reject_future_secondsReject events with a timestamp more than X seconds in the future (leave empty to disable)no""

no outputs