highperfocused/bostr
1
0
Fork 0
mirror of https://github.com/Yonle/bostr.git synced 2025-10-10 16:42:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Yonle
2024-03-21 22:12:53 +07:00
parent db0c88a2b7
commit 391c11f9b0
1 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -2,10 +2,10 @@
A nostr relay bouncer. A nostr relay bouncer.
## What is this? ## What is this?
**Bostr** is a multi nostr relay **proxy** that were serving as a nostr relay. **Bostr** is an nostr relay aggregator **proxy** that acts like a regular nostr relay. It connects to multiple configured relays to exchange data (events).
## Why? ## Why?
Nostr relays is a bunch of dummy servers that store user events. Normally nostr clients usually connects to more than 5-10 relays to receive and transmit events. Nostr relays is a bunch of dummy servers that store user events. Normally nostr clients connects to more than 5-10 relays to receive and transmit events.
Due to it's nature that connects to more than just a single relay, **Client bandwidth usage is high.** And because of this, Nostr bandwidth usage is not really recommended for some users, notably **mobile data users.** Due to it's nature that connects to more than just a single relay, **Client bandwidth usage is high.** And because of this, Nostr bandwidth usage is not really recommended for some users, notably **mobile data users.**
@@ -15,9 +15,11 @@ This project solve the problem by **reducing** the number of connected relays, a
![How it works](img/how_it_works.png) ![How it works](img/how_it_works.png)
## Installation ## Installation
- [NodeJS](https://nodejs.org) (v16 or up) - [NodeJS](https://nodejs.org) (v18 or up)
- A fast internet connection - A fast internet connection
You could set up an bostr bouncer by installing [Bostr CLI](#bostr-cli), or setting up via [The Source Code](#source-code), or via [Docker](#docker).
### Bostr CLI ### Bostr CLI
Install bostr via `npm`: Install bostr via `npm`:
``` ```
@@ -74,20 +76,26 @@ tmux new -d "node index.js"
When configuring reverse proxy, Ensure that `x-forwarded-proto` header was set as `https`. When configuring reverse proxy, Ensure that `x-forwarded-proto` header was set as `https`.
## Environment Variable ### Docker
- `CLUSTERS` - Run Bostr with specified numbers of clusters.
- `LOG_ABOUT_RELAYS` - Whenever to log about relay connections
## Docker
### Quick Run
``` ```
git clone https://github.com/Yonle/bostr git clone https://github.com/Yonle/bostr
cd bostr cd bostr
cp config.js.example config.js
```
You will then need to edit `config.js` before running the bouncer.
#### Running
```
docker build -t bostr:local . docker build -t bostr:local .
docker run --rm --name bostr -p 8080:8080 -v ./config.js:/usr/src/app/config.js bostr:local docker run --rm --name bostr -p 8080:8080 -v ./config.js:/usr/src/app/config.js bostr:local
``` ```
**Note:** You will need to edit `config.js` before running the bouncer. ## Environment Variables
You could specify the following environment variables to override the current settings:
- `CLUSTERS` - Run Bostr with specified numbers of clusters.
- `LOG_ABOUT_RELAYS` - Whenever to log about relay connections.
## License ## License