highperfocused/bostr
1
0
Fork 0
mirror of https://github.com/Yonle/bostr.git synced 2025-03-17 21:32:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

deps: need more speed? there you go. bufferutil for ws dep

Browse Source 
Signed-off-by: Yonle <yonle@lecturify.net>
This commit is contained in:
Yonle 2024-05-11 12:00:46 +07:00
parent 62c79c1180
commit 82689f7c50
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -20,6 +20,8 @@ This project solve the problem by **reducing** the number of connected relays, a
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).
**Tip:** When dependencies installation is failed due to failed compilation of `bufferutil` package, Run `npm install` with `--omit=optional` being set (Example: `npm install --omit=optional -g bostr`).
### Bostr CLI
Install bostr via `npm`:
```
@ -58,7 +60,7 @@ When configuring reverse proxy, Ensure that `x-forwarded-proto` header was set a
```
git clone -b stable https://github.com/Yonle/bostr
cd bostr
npm i
npm install
```
Rename `config.js.example` as `config.js`, Start editing the file and fill some required fields accordingly to your needs. You could run it for everyone or only for yourself.

3
package.json
View File

@ -30,6 +30,9 @@
"nostr-tools": "^2.5.2",
"ws": "^8.17.0"
},
"optionalDependencies": {
"bufferutil": "^4.0.8"
},
"engines": {
"node": ">=18"
}