基于统一 GUI 的、抗审查的解决方案,由 XRay 提供(源自 Marzban)
Rebecca
Unified GUI Censorship Resistant Solution Powered by XrayEnglish
/
فارسی
/
简体中文
/
Русский
Rebecca is a proxy management tool that provides a simple and easy-to-use user interface for managing hundreds of proxy accounts powered by Xray-core and built with a Go backend and React dashboard.
Rebecca is user-friendly, feature-rich and reliable. It lets you create different proxies for your users without any complicated configuration. Using its built-in web UI, you can monitor, modify and limit users.
Install Rebecca master with the binary installer:
curl -sL https://raw.githubusercontent.com/rebeccapanel/Rebecca/master/scripts/rebecca/rebecca-binary.sh | sudo bash -s -- installDo not run the installers with sudo bash -c "$(curl ...)"; the downloaded script can exceed Linux's single-argument limit and fail with Argument list too long. Always pipe the download into sudo bash -s -- as shown above.
For the dev channel, use:
curl -sL https://raw.githubusercontent.com/rebeccapanel/Rebecca/dev/scripts/rebecca/rebecca-binary.sh | sudo bash -s -- install --devInstall Rebecca-node on each node server with the binary node installer:
curl -sL https://raw.githubusercontent.com/rebeccapanel/Rebecca/master/scripts/rebecca/rebecca-node-binary.sh | sudo bash -s -- installThe binary installers create native systemd services and automatically download the matching Linux release asset for the server architecture. The master installer supports SQLite, MySQL, and MariaDB through its install options; the node installer installs only the node runtime and connects it to the master through the certificate/token flow in the panel.
Once the installation is complete:
Ctrl+C/opt/rebecca/opt/rebecca/.env (refer to configurations section to see variables)/var/lib/rebeccahttps://YOUR_DOMAIN:8000/dashboard/ (replace YOUR_DOMAIN with your actual domain)user@serverip with your actual SSH username and server IP and Run the command below:ssh -L 8000:localhost:8000 user@serveripFinally, you can enter the following link in your browser to access your Rebecca dashboard:
http://localhost:8000/dashboard/
You will lose access to the dashboard as soon as you close the SSH terminal. Therefore, this method is recommended only for testing purposes.
Next, you need to create a sudo admin for logging into the Rebecca dashboard by the following command
rebecca cli admin create --role full_accessThat's it! You can login to your dashboard using these credentials
Full access admins can only be created by another full access admin from the dashboard or by using the on-box
rebecca cli.
If you ever need to promote an existing sudo admin, runrebecca cli admin change-role --username YOUR_ADMIN --role full_access
To see the help message of the Rebecca script, run the following command
rebecca --helpIf you are eager to run the project using the source code, check the section below
Manual install (advanced)
Install xray on your machine
You can install it using Xray-install
curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh | bash -s -- installClone this project and build the dashboard and Go binaries:
git clone https://github.com/rebeccapanel/Rebecca.git
cd Rebecca
cd dashboard
npm ci
VITE_BASE_API=/api/ npm run build -- --outDir=build --assetsDir=statics
cp ./build/index.html ./build/404.html
cd ..
bash scripts/build_binary.shThen run the following command to run the Go database migrations:
./dist/rebecca-cli migrate upDowngrade migrations are not supported. Check the migration status with
./dist/rebecca-cli migrate status before upgrading a legacy database.
If you want to use the CLI globally, install the built Go CLI:
sudo install -m 755 ./dist/rebecca-cli /usr/local/bin/rebecca
rebecca cli --helpNow it's time to configuration
Make a copy of .env.example file, take a look and edit it using a text editor like nano.
You probably like to modify the admin credentials.
cp .env.example .env
nano .envCheck configurations section for more information
Eventually, launch the application using command below:
./dist/rebecca-serverFor source/manual installs, create a systemd unit that runs the Go server binary:
[Unit]
Description=Rebecca
After=network.target
[Service]
Type=simple
WorkingDirectory=/opt/rebecca
EnvironmentFile=/opt/rebecca/.env
ExecStart=/opt/rebecca/dist/rebecca-server
Restart=on-failure
RestartSec=5
[Install]
WantedBy=multi-user.targetThen enable it:
sudo systemctl daemon-reload
sudo systemctl enable --now rebeccaTo use with nginx
…or
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name rebecca.example.com;
ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
location / {
proxy_pass http://0.0.0.0:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}By default the app will be run on http://localhost:8000/dashboard. You can configure it by changing the UVICORN_HOST and UVICORN_PORT environment variables.
You can set settings below using environment variables or placing them in
.envfile.
| Variable | Description |
|---|---|
| SQLALCHEMY_DATABASE_URL | Database URL. The legacy name is still used by the Go runtime for compatibility. |
| UVICORN_HOST | Public gateway bind host (default: 0.0.0.0). |
| UVICORN_PORT | Public gateway bind port (default: 8000). |
| UVICORN_SSL_CERTFILE | TLS certificate path for the Go gateway. |
| UVICORN_SSL_KEYFILE | TLS private key path for the Go gateway. |
| UVICORN_SSL_CA_TYPE | Certificate authority type used by install scripts (public or private). |
| REBECCA_GATEWAY_ADDR | Optional full gateway listen address. Overrides UVICORN_HOST/UVICORN_PORT. |
| REBECCA_NODE_OPERATIONS_POLL_INTERVAL | Node operation queue polling interval. |
| REBECCA_USER_LIFECYCLE_INTERVAL | User lifecycle review interval. |
| REBECCA_USER_USAGE_RESET_INTERVAL | Periodic user usage reset interval. |
| REBECCA_USER_AUTODELETE_INTERVAL | Expired/limited user auto-delete job interval. |
| USERS_AUTODELETE_DAYS | Delete expired users after this many days. Negative values disable this feature. |
| USER_AUTODELETE_INCLUDE_LIMITED_ACCOUNTS | Whether auto-delete includes limited accounts. |
| USERS_LIST_TIMEOUT_SECONDS | Optional timeout for large user list queries. 0 disables the timeout. |
| REBECCA_CERT_BASE | Base directory for managed certificates. |
| REBECCA_CERTBOT_BIN | Optional Certbot executable override used by the SSL manager. |
| REBECCA_CONFIG_DIR | Configuration root included in full backup export/import. |
Telegram bot commands, reports, settings, and backup delivery are handled by the Go services and can be configured from the panel.
Webhook notifications are handled by the Go event worker and can be configured from the panel.
If you found Rebecca useful and would like to support its development, you can make a donation in one of the following crypto networks:
TGftLESDAeRncE7yMAHrTUCsixuUwPc6qp0x413eb47C430a3eb0E4262f267C1AE020E0C7F84DUQDNpA3SlFMorlrCJJcqQjix93ijJfhAwIxnbTwZTLiHZ0XaThank you for your support!
Made in [Unknown!] and published under AGPL-3.0.
We ❤️ contributors! If you'd like to contribute, please check out our Contributing Guidelines and feel free to submit a pull request or open an issue.
Check open issues to help the progress of this project.
Thanks to the all contributors who have helped improve Rebecca:
Made with contrib.rocks
暂无开放 Issues,或尚未同步最近议题。