diff --git a/README.md b/README.md index 9e33ca6..d88eb34 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/package.json b/package.json index 559bf34..fafa6d4 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,9 @@ "nostr-tools": "^2.5.2", "ws": "^8.17.0" }, + "optionalDependencies": { + "bufferutil": "^4.0.8" + }, "engines": { "node": ">=18" }