nostr-relay-tray

A simple nostr relay tray. For Mac, Windows, and Linux.

powered by nostr-relay

Features

• Comprehensive: A fully featured Nostr relay.
• User-Friendly: Start the relay with a single click.
• Granular Control: Manage which events to accept or reject with precision.
• Cross-Platform: Available for macOS, Windows, and Linux.

Flexible event filtering

nostr-relay-tray provides a flexible event filtering mechanism, allowing you to precisely control which events are accepted. The mechanism works in two layers:

                  Incoming Event
                        │
                        ▼
                ┌───────────────┐
                │  Block Rules  │  ✖ If blocked, event is rejected.
                └───────────────┘
                        │ (not blocked)
                        ▼
   ┌─────────────────────────────────────────┐
   │         Second Layer Filtering          │
   │        (Only one needs to pass)         │
   ├─────────────┬─────────────┬─────────────┤
   │ Allow Rules │     WoT     │     PoW     │
   └─────────────┴─────────────┴─────────────┘
                        │
                        ▼
                  Event Accepted ✅

Layer 1

• If block rules exist, any matching event is immediately rejected.
• If no block rules are defined, this layer is skipped, and the event proceeds to the second layer.

Layer 2

This layer consists of three independent filters:

• Allow Rules: Accepts events that meet predefined conditions.
• Web of Trust (WoT): Accepts events from trusted users or relays.
• Proof of Work (PoW): Accepts events that meet a certain computational difficulty.

Filtering logic:

• If at least one filter is enabled, the event must pass at least one.
• If all filters are disabled, the event is automatically accepted.

Download

You can download the latest version from the release page. If you want to use Apple Silicon version, you need to build it from the source code.

Because the app is not signed, you may need to allow it to run in the system settings.

Build from source

You can also build the app from the source code.

Note: Node.js >= 20 is required.

# Clone this repository
git clone https://github.com/CodyTseng/nostr-relay-tray.git

# Go into the repository
cd nostr-relay-tray

# Install dependencies
npm install

# Build the app
npm run build:mac
# or npm run build:win
# or npm run build:linux

The executable file will be in the dist folder.

Screenshot

Donate

If you like this project, you can buy me a coffee :) ⚡️ [email protected] ⚡️

Icon Attribution

The ostrich element within the icon is sourced from nostr_icons. Special thanks to satscoffee for providing such a beautiful ostrich.

License

MIT