Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/txthinking/brook-manager
Brook Manager is a Brook management system for medium to large merchants. Brook Manager 是一个 Brook 管理系统，功能包含用户注册，流量统计，收款，自动生成导入链接等全自动化操作
https://github.com/txthinking/brook-manager
brook business management privacy proxy shadowsocks ui vpn web
Last synced: 2 months ago
JSON representation
Brook Manager is a Brook management system for medium to large merchants. Brook Manager 是一个 Brook 管理系统，功能包含用户注册，流量统计，收款，自动生成导入链接等全自动化操作
- Host: GitHub
- URL: https://github.com/txthinking/brook-manager
- Owner: txthinking
- License: other
- Created: 2022-06-10T09:26:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T10:20:08.000Z (over 1 year ago)
- Last Synced: 2024-03-01T07:37:05.280Z (11 months ago)
- Topics: brook, business, management, privacy, proxy, shadowsocks, ui, vpn, web
- Language: HTML
- Homepage:
- Size: 299 KB
- Stars: 120
- Watchers: 6
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Deprecated. Please move to: https://github.com/TxThinkingInc/brook-user-system
# brook-manager
A Web UI for fully automatic management of [Brook](https://github.com/txthinking/brook)
## Features
| Features | 功能 |
| ------------------------------------------------------------------------------------ | ---------------------------------------------------- |
| Fully automatic deployment of brook | 全自动部署 brook |
| User registration/payment/adding nodes will automatically trigger deployment brook | 用户注册/支付/添加节点会自动触发部署 brook |
| You never even need to log into the node machine | 你甚至永远不需要登录节点机器 |
| User registration | 用户注册 |
| Traffic Statistics | 流量统计 |
| Multi-port multi-user | 多端口多用户 |
| Single-port multi-user | 单端口多用户 |
| Audit rules | 审计规则 |
| multi-level lines | 多级别线路 |
| Multi-level VIP | 多级别 VIP |
| Order and payment | 订单及支付 |
| Automatically generate subscription links | 自动生成订阅链接 |
| Ban/Restore User | 禁用/恢复用户 |
| One-line command deployment | 一行命令部署 |
| MySQL database [Auth](https://github.com/denodrivers/mysql/issues/37#issuecomment-651771807) | MySQL 数据库 [Auth](https://github.com/denodrivers/mysql/issues/37#issuecomment-651771807) |
| Reset all user traffic on the 1st of every month | 每月 1 号重置所有用户流量 |
| Automatically clear their nodes when users expire | 当用户到期自动清除其节点 |
| It also supports adding your own manual deployment brook link and traffic Statistics | 同时也支持添加你自己手动部署的 brook link 和流量统计 |
| ... | ... |
## Install [nami](https://github.com/txthinking/nami)
```
bash <(curl https://bash.ooo/nami.sh)
```
#### Install mysql
Here take Ubuntu 22.04 as an example, if there is a problem, you can google how to solve the problem of mysql installation and configuration
```
apt-get install default-mysql-server default-mysql-client // or the old name: mysql-server mysql-client
nami install mysql-init
mysql-init
systemctl restart mysql.service
```
Test via mysql client
```
mysql -h 127.0.0.1 -u root -p111111
```
#### Install brook-manager
```
nami install joker nico hancock mad brook-manager
```
#### Run brook-manager http server
create a http server `http://127.0.0.1:8080`
```
brook-manager --listen 127.0.0.1:8080 --ui default --mysqladdress 127.0.0.1:3306 --mysqlusername root --mysqlpassword 111111 --mysqldbname brook
```
#### Run brook-manager task
```
brook-manager --task --mysqladdress 127.0.0.1:3306 --mysqlusername root --mysqlpassword 111111 --mysqldbname brook
```
#### Run a reverse proxy web server
Here is an example of nico, of course you need to prepare a domain name and resolve it to your server IP
```
nico domain.com http://127.0.0.1:8080
```
#### How to run command as daemon
You may like [joker](https://github.com/txthinking/joker)
#### Amdin URL
https://domain.com/admin/
#### User URL
https://domain.com
## PR Welcome
```
nami install hancock mad 7z deno denobundle
git clone https://github.com/txthinking/brook-manager.git
cd brook-manager
dev=1 deno run -Ar main.js --listen 127.0.0.1:8080 --ui default --mysqladdress 127.0.0.1:3306 --mysqlusername root --mysqlpassword 111111 --mysqldbname brook
dev=1 deno run -Ar main.js --task --mysqladdress 127.0.0.1:3306 --mysqlusername root --mysqlpassword 111111 --mysqldbname brook
# then open http://127.0.0.1:8080/admin/
# then open http://127.0.0.1:8080
```
#### File introduction
```
├── adminapi.js // admin api
├── userapi.js // user api
├── cron.js // cron
├── task.js // task
├── main.js // entry
├── mysqlmigrate.js // mysql db migration
├── static/
│ └── default/ // default ui, you can create more ui
│ ├── account.html
│ ├── admin/ // admin ui
│ ├── cryptocurrency_payment.html
│ ├── index.html
│ ├── lang/ // i18n
│ ├── signin.html
│ ├── signup.html
│ ├── simulate_payment.html
│ └── vip.html
```
## License
```
- Any client-side web page based on this project and any derivatives must provide merchant contact information:
telegram group or other ways to contact you
- Any client-side web page based on this project and any derivatives must contain the following statement in a prominent place(or other languages with the same meaning):
The current site is built by the merchant based on the open source software brook-manager(https://github.com/txthinking/brook-manager), and brook has no interest in you. If you encounter problems, please contact the merchant.
```
## Disclaimer
We have no liability to you.