reality-ezpz 项目使用教程

reality-ezpz 项目使用教程

reality-ezpzInstall sing-box/xray and configure vless / tuic / hysteria2 for reality or tls (letsencrypt) over different transport protocols (tcp, http, grpc and websocket) with user management capability in CLI, TUI and Telegram bot by a single command in docker compose!项目地址:https://gitcode.com/gh_mirrors/re/reality-ezpz

1. 项目的目录结构及介绍

reality-ezpz 项目的目录结构如下：

reality-ezpz/
├── LICENSE
├── README.md
├── reality-ezpz.sh
├── tgbot.py
└── 其他文件及目录

• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目说明文档，包含项目的基本信息和使用指南。
• reality-ezpz.sh: 项目的启动脚本，用于安装和配置 vless 等服务。
• tgbot.py: 项目的 Telegram 机器人脚本，用于通过 Telegram 管理用户。

2. 项目的启动文件介绍

项目的启动文件是 reality-ezpz.sh，该脚本用于安装和配置 vless、tuic、hysteria2、shadowtls 等服务，并支持通过不同的传输协议（如 tcp、http、grpc 和 websocket）进行通信。

启动脚本功能

• 安装和配置 sing-box/xray。
• 配置 vless、tuic、hysteria2、shadowtls 等服务。
• 支持 reality 或 TLS（letsencrypt）。
• 提供用户管理功能，支持 CLI、TUI 和 Telegram 机器人。

使用方法

./reality-ezpz.sh

3. 项目的配置文件介绍

项目的配置文件主要包括 reality-ezpz.sh 和 tgbot.py 中的配置项。

reality-ezpz.sh 配置项

• 服务配置: 配置 vless、tuic、hysteria2、shadowtls 等服务的基本参数。
• 传输协议配置: 配置支持的传输协议（tcp、http、grpc、websocket）。
• 用户管理配置: 配置用户管理功能，包括添加、删除用户等。

tgbot.py 配置项

• Telegram Bot Token: 配置 Telegram 机器人的 Token。
• 用户管理: 配置通过 Telegram 进行用户管理的功能。

以上是 reality-ezpz 项目的基本使用教程，详细配置和使用方法请参考项目的 README.md 文件和相关脚本注释。

reality-ezpzInstall sing-box/xray and configure vless / tuic / hysteria2 for reality or tls (letsencrypt) over different transport protocols (tcp, http, grpc and websocket) with user management capability in CLI, TUI and Telegram bot by a single command in docker compose!项目地址:https://gitcode.com/gh_mirrors/re/reality-ezpz