Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Commit

Permalink
deps: need more speed? there you go. bufferutil for ws dep
Browse files Browse the repository at this point in the history
Signed-off-by: Yonle <yonle@lecturify.net>
  • Loading branch information
Yonle committed May 11, 2024
1 parent 62c79c1 commit 82689f7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
```
Expand Down Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"nostr-tools": "^2.5.2",
"ws": "^8.17.0"
},
"optionalDependencies": {
"bufferutil": "^4.0.8"
},
"engines": {
"node": ">=18"
}
Expand Down

0 comments on commit 82689f7

Please sign in to comment.