Marzban/README-zh-cn.md at master · Gozargah/Marzban
AI 要約 · Qwen 要約は中国語 収録日
原文を読む 该 README 介绍了 Marzban 的功能、安装、配置、API、备份和 Telegram Bot 使用方法。
项目定位
- Marzban 是一个基于 Xray-core 的代理管理工具。
- 它使用 Python 和 Reactjs 构建，并提供简单易用的用户界面。
- 该工具可用于管理数百个代理账户。
主要功能
- 内置 Web 界面，并支持 REST API 后端。
- 支持 Vmess、VLESS、Trojan 和 Shadowsocks 协议。
- 支持流量限制、过期日期限制、周期性流量限制、订阅链接、二维码生成、系统监控和流量统计。
- 支持 TLS、自定义 Xray 配置、集成 Telegram Bot，并正在开发多管理员支持。
安装方式
- 可通过安装脚本使用 SQLite、MySQL 或 MariaDB 数据库安装。
- 安装后文件位于 /opt/marzban，配置文件位于 /opt/marzban/.env，数据文件位于 /usr/lib/marzban。
- 出于安全原因，仪表盘不能通过 IP 直接访问，需要 SSL 证书和域名访问，也可使用 SSH 端口转发进行本地测试。
- 安装完成后需要创建 sudo 管理员账号以登录仪表盘。
手动安装
- 手动安装需要 Python 3.8 或更高版本，并先安装 Xray。
- 需要克隆仓库、安装依赖、运行数据库迁移脚本，并复制 .env.example 为 .env 进行配置。
- 可通过 python3 main.py 启动，也可使用 systemctl 管理。
- 文档提供了配合 nginx 使用 HTTPS 和反向代理的配置示例。
配置项
- 配置可通过环境变量或 .env 文件设置。
- 可配置管理员账号、数据库地址、Uvicorn 主机和端口、SSL 证书等。
- 可配置 Xray 配置文件、可执行文件路径、资源目录、订阅 URL 前缀和 fallbacks 入站标记。
- 可配置 Telegram Bot、JWT 过期时间、API 文档开关、Webhook 通知和自动删除策略。
API、备份与 Telegram
- Marzban 提供 REST API，设置 DOCS=True 后可在 /docs 和 /redoc 查看 API 文档。
- 备份建议复制 /var/lib/marzban 目录，并备份 env 文件和 Xray 配置文件。
- 备份服务支持 SQLite、MySQL 和 MariaDB，可将压缩后的备份发送到 Telegram Bot，并支持定时或即时备份。
- 集成 Telegram Bot 可用于服务器管理、用户创建和删除以及发送通知。