Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
<a href="https://lnbits.com" target="_blank" rel="noopener noreferrer">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/QE6SIrs.png">
<img src="https://i.imgur.com/fyKPgVT.png" alt="LNbits" style="width:280px">
</picture>
</a>

[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE)
[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits)

# Nostr Relay

### One click and spin up your own Nostr relay. Share with the world, or use privately.
Expand Down Expand Up @@ -117,3 +127,10 @@ Create Symbolic Link:
```
ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay
```

## Powered by LNbits

[LNbits](https://lnbits.com) is a free and open-source lightning accounts system.

[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/)
[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login)
13 changes: 10 additions & 3 deletions config.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{
"name": "Nostr Relay",
"id": "nostrrelay",
"version": "1.1.0",
"name": "Nostr Relay",
"repo": "https://github.com/lnbits/nostrrelay",
"short_description": "One click launch your own relay!",
"description": "",
"tile": "/nostrrelay/static/image/nostrrelay.png",
"min_lnbits_version": "1.4.0",
"contributors": [
{
"name": "motorina0",
"name": "Vlad Stan",
"uri": "https://github.com/motorina0",
"role": "Contributor"
},
Expand Down Expand Up @@ -38,5 +41,9 @@
],
"description_md": "https://raw.githubusercontent.com/lnbits/nostrrelay/main/description.md",
"terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/nostrrelay/main/toc.md",
"license": "MIT"
"license": "MIT",
"paid_features": "",
"tags": ["Nostr"],
"donate": "",
"hidden": false
}
14 changes: 8 additions & 6 deletions description.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Create a Nostr relay in just 2 steps!
Create and manage your own Nostr relay with optional paid access.

Optional settings include:
Its functions include:

- Charging for storage
- Charging for joining
- Npub allow/ban list (for restricting access)
- Pruning and filtering
- Setting up a Nostr relay in just a few steps
- Charging for storage or relay membership
- Managing npub allow and ban lists
- Configuring pruning and content filtering rules

An accessible entry point for anyone who wants to run their own Nostr relay with optional monetization and full control over who can publish.