README
¶
XrayRP
A Xray backend framework that can easily support many panels.
当前版本
当前预发布版本：0.9.1-alpha
本版本的主要更新内容请见 CHANGELOG.md。
在 Xboard / NewV2board 的 machine mode 下，XrayRP 会按面板下发的 base_config.push_interval 自动上报整机 CPU、内存、Swap、磁盘和网络速率到服务器管理页，无需额外本地配置。
一个基于Xray的后端框架，支持V2Ray,Trojan,Shadowsocks协议，极易扩展，支持多面板对接。
如果您喜欢本项目，可以右上角点个star+watch，持续关注本项目的进展。
使用教程：详细使用教程
Xboard / NewV2board 的兼容范围、WebSocket、Machine 模式和配置说明：兼容性文档
架构导航
- CLI、配置加载与热重载：
cmd/ - Node runtime state 与 Authoritative snapshot synchronization：
service/controller/ - Specialized runtime lifecycle：
service/anytls/、service/tuic/、service/hysteria2/ - Panel transport mechanics 与适配器：
api/、api/internal/panelhttp/ - 证书获取、存储与续签：
common/mylego/
完整说明见 架构导航。
免责声明
本项目只是本人个人学习开发并维护，本人不保证任何可用性，也不对使用本软件造成的任何后果负责。
特点
- 永久开源且免费。
- 支持V2ray，Trojan， Shadowsocks多种协议。
- 支持Vless和XTLS等新特性。
- 支持单实例对接多面板、多节点，无需重复启动。
- 支持限制在线IP
- 支持节点端口级别、用户级别限速。
- 配置简单明了。
- 修改配置自动重启实例。
- 方便编译和升级，可以快速更新核心版本， 支持Xray-core新特性。
功能介绍
| 功能 | v2ray | trojan | shadowsocks |
|---|---|---|---|
| 获取节点信息 | √ | √ | √ |
| 获取用户信息 | √ | √ | √ |
| 用户流量统计 | √ | √ | √ |
| 服务器信息上报 | √ | √ | √ |
| 自动申请tls证书 | √ | √ | √ |
| 自动续签tls证书 | √ | √ | √ |
| 在线人数统计 | √ | √ | √ |
| 在线用户限制 | √ | √ | √ |
| 审计规则 | √ | √ | √ |
| 节点端口限速 | √ | √ | √ |
| 按照用户限速 | √ | √ | √ |
| 自定义DNS | √ | √ | √ |
支持前端
| 前端 | v2ray | trojan | shadowsocks |
|---|---|---|---|
| sspanel-uim | √ | √ | √ (单端口多用户和V2ray-Plugin) |
| v2board | √ | √ | √ |
| PMPanel | √ | √ | √ |
| ProxyPanel | √ | √ | √ |
| WHMCS (V2RaySocks) | √ | √ | √ |
| GoV2Panel | √ | √ | √ |
| BunPanel | √ | √ | √ |
软件安装
一键安装
bash <(curl -Ls https://raw.githubusercontent.com/Mtoly/XrayRPS/main/install.sh)
Xboard Machine Mode 一键安装
此脚本只生成 XrayRP MachineConfig 并安装/启动 XrayR 服务，不会在 Xboard 中创建或注册机器。请先在 Xboard 创建/绑定机器，并复制对应的 MachineID 和 Token。
MachineConfig 与静态 Nodes 配置互斥。启用机器模式时，/etc/XrayR/config.yml 不会生成静态 Nodes。
bash <(curl -Ls https://raw.githubusercontent.com/Mtoly/XrayRPS/main/install-machine.sh) \
--api-host https://panel.example.com \
--machine-id 1 \
--token "machine-token" \
--panel-type NewV2board \
--enable-ws
如果 /etc/XrayR/config.yml 已存在，脚本默认不会覆盖；确认要覆盖时添加 --force。
使用Docker部署软件
手动安装
配置文件及详细使用教程
Thanks
Licence
Mozilla Public License Version 2.0
Telegram
Stargazers over time
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal/panelrules
Package panelrules loads panel-neutral local detection rules.
|
Package panelrules loads panel-neutral local detection rules. |
|
Package app contains the third-party app used to replace the default app in xray-core
|
Package app contains the third-party app used to replace the default app in xray-core |
|
mydispatcher
Package mydispatcher implements a custom dispatcher with rate limiting and online device counting on top of the core Xray dispatcher.
|
Package mydispatcher implements a custom dispatcher with rate limiting and online device counting on top of the core Xray dispatcher. |
|
Package common contains common utilities that are shared among other packages.
|
Package common contains common utilities that are shared among other packages. |
|
limiter
Package limiter is to control the links that go into the dispatcher
|
Package limiter is to control the links that go into the dispatcher |
|
rule
Package rule controls audit-rule matching and result draining.
|
Package rule controls audit-rule matching and result draining. |
|
internal
|
|
|
appliednode
Package appliednode owns the deep-clone contract for Applied node values.
|
Package appliednode owns the deep-clone contract for Applied node values. |
|
Package service contains all the services used by XrayR To implement a service, one needs to implement the interface below.
|
Package service contains all the services used by XrayR To implement a service, one needs to implement the interface below. |
|
controller
Package controller Package generate the InboundConfig used by add inbound
|
Package controller Package generate the InboundConfig used by add inbound |
Click to show internal directories.
Click to hide internal directories.