Realm 管理工具集

一套便捷的 Realm 端口转发管理脚本 + Web 配置生成器（https://hellooe.github.io/realm-x/），支持一键安装、更新、卸载、动态添加/删除转发规则，并提供了友好的可视化界面生成命令。

---

✨ 功能特性

• 原子性规则添加：添加规则时先校验规则有效性，全部通过后才写入配置文件，避免与预期不一致。
• 智能检测：自动检测目标地址格式、端口是否冲突，支持快速排查远程连接可用性。
• 加密隧道：支持建立双端 tls / wss 加密隧道，可选自动签发 CA 证书。
• 负载均衡：支持 roundrobin 和 iphash 策略，权重可自定义。
• 定时测试与 Telegram 通知：可设置定时任务（每小时/每天/每周/自定义间隔）自动测试所有远程地址，失败时通过 Telegram 推送报告。
• Web 配置生成器：图形化界面，生成可直接执行的 shell 命令，批量添加/删除规则。
• 多 init 系统兼容：自动检测 Systemd 或 OpenRC，无缝适配主流 Linux 发行版。

---

🚀 快速开始

1. 安装 Realm

wget -O xm.sh https://raw.githubusercontent.com/hellooe/realm-x/refs/heads/master/xm.sh
chmod +x xm.sh
./xm.sh

进入交互式菜单，选择 1 即可。

===== Realm 管理菜单 =====
1. 安装 Realm
2. 更新 Realm
3. 卸载 Realm
4. 查看规则
5. 添加规则
6. 删除规则
7. 测试远程连通性
8. 配置 TG 推送
9. 设置定时测试
0. 退出

---

2. Telegram 通知与定时测试

配置 Telegram

在交互式菜单选择 8，按提示输入 Bot Token 和 Chat ID。配置保存在 /root/xm/conf/tg.json。

设置定时测试

选择菜单 9，可设置：

• 每小时
• 每天
• 每周
• 自定义小时数（例如 6 表示每 6 小时）
• 禁用定时任务

若 TG_NOTIFY=true 且已配置 TG，则测试完成后自动推送结果摘要。

---

3. 命令行模式（非交互）

通过环境变量 XM_ACTION 控制操作，适合自动化部署。

# 安装
XM_ACTION=install bash <(curl -Ls https://raw.githubusercontent.com/hellooe/realm-x/refs/heads/master/xm.sh)

# 更新
XM_ACTION=update bash <(curl -Ls ...)

# 卸载
XM_ACTION=uninstall bash <(curl -Ls ...)

# 添加规则（需配合 XM_ADD_JSON）
XM_ACTION=add XM_CLEAR=true ENABLE_TCP=true ENABLE_UDP=true XM_ADD_JSON='[{"listen":"0.0.0.0:10000","remote":"127.0.0.1:20000"}]' bash <(curl -Ls ...)

# 删除规则（支持逗号分隔和范围）
XM_ACTION=delete XM_DELETE_PORT="10001,10002,20001-20002" bash <(curl -Ls ...)

# 测试与定时自动化
XM_ACTION=test TG_BOT_TOKEN='123:ABC' TG_CHAT_ID='456' TG_NOTIFY='true' CRON_INTERVAL='0 */6 * * *' bash <(curl -Ls ...)

---

环境变量说明

变量名	用途	取值示例
XM_ACTION	操作类型	install / update / uninstall / add / delete / test
XM_ADD_JSON	添加规则（JSON 数组）	[{"listen":"0.0.0.0:10000","remote":"127.0.0.1:20000"}]
XM_CLEAR	添加前是否清空现有规则	true 或 false
XM_DELETE_PORT	要删除的端口（支持逗号和范围）	10001,10002,20001-20002
ENABLE_TCP	启用 TCP 转发	true / false
ENABLE_UDP	启用 UDP 转发	true / false
TG_NOTIFY	是否发送 Telegram 通知	true / false
TG_BOT_TOKEN	Telegram Bot Token	123456:ABC-DEF...
TG_CHAT_ID	Telegram Chat ID	123456789

注意：当 ENABLE_TCP=false 时，连通性测试会被跳过（包括添加时的检测和定时测试）。

---

📄 许可证

本项目基于 MIT 许可证开源，详情见 LICENSE 文件。

---

🤝 贡献

欢迎提交 Issue 和 Pull Request。如果你有改进建议或发现 bug，请随时联系。