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

fix readme.

Browse Source 
Signed-off-by: Yonle <yonle@lecturify.net>
This commit is contained in:
Yonle 2024-02-19 18:44:48 +07:00
parent c16028a7ae
commit d82eb099a5
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -18,7 +18,7 @@ This project solve the problem by **reducing** the number of connected relays, a
- [NodeJS](https://nodejs.org) (v16 or up)
- A fast internet connection
#### Bostr CLI
### Bostr CLI
Install bostr via `npm`:
```
npm install -g bostr
@ -37,7 +37,7 @@ bostr makeconf bostr_config.js
Edit `bostr_config.js` (Could be modified) with your file editor and fill some required fields accordingly to your needs. You could run it for everyone or only for yourself.
### Running
#### Running
After you finished editing the config file, You could start bostr with the following command:
```
bostr start bostr_config.js
@ -51,7 +51,7 @@ tmux new -d "bostr start bostr_config.js"
When configuring reverse proxy, Ensure that `x-forwarded-proto` header was set as `https`.
#### Source code
### Source code
```
git clone -b stable https://github.com/Yonle/bostr
@ -61,7 +61,7 @@ npm i
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.
### Running
#### Running
```
node index.js
```