Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haorendashu/cfrelay
A nostr relay base on cloudflare wokers.
https://github.com/haorendashu/cfrelay
nostr nostr-relay nostromo
Last synced: 24 days ago
JSON representation
A nostr relay base on cloudflare wokers.
- Host: GitHub
- URL: https://github.com/haorendashu/cfrelay
- Owner: haorendashu
- License: gpl-3.0
- Created: 2024-04-11T15:55:28.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-07-05T12:32:28.000Z (5 months ago)
- Last Synced: 2024-08-04T11:01:15.235Z (4 months ago)
- Topics: nostr, nostr-relay, nostromo
- Language: JavaScript
- Homepage:
- Size: 87.9 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - cfrelay - A personal nostr relay base on cloudflare workers. (Relays / Implementations)
README
# cfrelay
A relay run at cloudflare.
## Features
- [x] NIP-01 (Basic protocol flow description)
- [x] NIP-02 (Follow List)
- [x] NIP-05 (Mapping Nostr keys to DNS-based internet identifiers)
- [x] NIP-09 (Event Deletion)
- [x] NIP-11 (Relay Information Document)
- [x] NIP-12 (Generic Tag Queries)
- [x] NIP-33 (Parameterized Replaceable Events)
- [x] NIP-42 (Authentication of clients to relays)
- [x] NIP-45 (Counting results)
- [x] NIP-50 (Search Capability)
- [x] NIP-95 (Shared File)
- [x] NIP-96 (HTTP File Storage Integration)
- [x] NIP-98 (HTTP Auth)
## Implement
| Function | Cloudflare implement |
|---------------------|----------------------|
| Event Store | D1 |
| File Store (NIP-95) | KV |
| File Store (NIP-96) | R2 |
Why do we use the KV to save the file store?
Because the R2 must bing the payment method and when it run out of the free plan limit, it would make some fee.
## Deploy
### 1. Install NPM
### 2. Install wrangler
### 3. Init D1 database
create d1 database
```bash
wrangler d1 create relay
```
run init script
```bash
wrangler d1 execute relay --file=init.sql
```
### 4.Init KV
```bash
wrangler kv:namespace create relay
```
### 5.Init R2 (Optional)
**If you want to use R2, you must config your payment to cloudflare. I can't ensure that it won't cost you money**
After config payment, you can init the R2 bucket now. You can do it in the cloudflare website or run this script:
```bash
wrangler r2 bucket create relay
```
**It is important that config a custom domain for your bucket. Due to this domain can user cloudflare's cache and it will save you money.**
You can readmore from this [Connect a bucket to a custom domain
](https://developers.cloudflare.com/r2/buckets/public-buckets/#connect-a-bucket-to-a-custom-domain).
### 5.Change files
change the owners in in ```src/index.js```, chenge the ```29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07``` to you ```plain owner id```.
```js
const owners = ["29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07"];
```
```(Optional)```. change the nip05 config
```js
// nip05user config should set like this:
const nip05User = {"nicename": "pubkey"};
```
```(Optional)```. If you use R2 for NIP-96 and had config a custom domain, you should config r2CustomDomain in ```src/index.js```.
```js
const r2CustomDomain = 'You custom domain like: https://xxxxxx.com ';
```
change config file wrangler.toml set the database_id and kv_namespaces' id
```toml
[[d1_databases]]
binding = "DB"
database_name = "relay"
database_id = "Here is there d1 id"
[[kv_namespaces]]
binding = "KV"
id = "Here is there kv id"
```
```(Optional)```. If you use R2 for NIP-96, you should also add this setting to wrangler.toml.
```toml
[[d1_databases]]
[[r2_buckets]]
binding = "R2"
bucket_name = "You bucket name"
```
### 6.Deploy
run this script to install project dependent
```bash
npm install
```
run this script to deploy
```bash
npm run deploy
```