| 1 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 2 |
a47eb4c |
Dawsh |
2y ago |
<a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer"> |
| 3 |
a47eb4c |
Dawsh |
2y ago |
<picture> |
| 4 |
a47eb4c |
Dawsh |
2y ago |
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-dark.png"> |
| 5 |
a47eb4c |
Dawsh |
2y ago |
<img width="160" height="160" src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-light.png"> |
| 6 |
a47eb4c |
Dawsh |
2y ago |
</picture> |
| 7 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 8 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 9 |
a47eb4c |
Dawsh |
2y ago |
|
| 10 |
a47eb4c |
Dawsh |
2y ago |
<h1 align="center"/>Marzban</h1> |
| 11 |
a47eb4c |
Dawsh |
2y ago |
|
| 12 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 13 |
a47eb4c |
Dawsh |
2y ago |
Unified GUI Censorship Resistant Solution Powered by <a href="https://github.com/XTLS/Xray-core">Xray</a> |
| 14 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 15 |
a47eb4c |
Dawsh |
2y ago |
|
| 16 |
a47eb4c |
Dawsh |
2y ago |
<br/> |
| 17 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 18 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 19 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/github/actions/workflow/status/gozargah/marzban/build.yml?style=flat-square" /> |
| 20 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 21 |
a47eb4c |
Dawsh |
2y ago |
<a href="https://hub.docker.com/r/gozargah/marzban" target="_blank"> |
| 22 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/docker/pulls/gozargah/marzban?style=flat-square&logo=docker" /> |
| 23 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 24 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 25 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/github/license/gozargah/marzban?style=flat-square" /> |
| 26 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 27 |
a47eb4c |
Dawsh |
2y ago |
<a href="https://t.me/gozargah_marzban" target="_blank"> |
| 28 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" /> |
| 29 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 30 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 31 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/badge/twitter-commiunity-blue?style=flat-square&logo=twitter" /> |
| 32 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 33 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 34 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/github/stars/gozargah/marzban?style=social" /> |
| 35 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 36 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 37 |
a47eb4c |
Dawsh |
2y ago |
|
| 38 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 39 |
a47eb4c |
Dawsh |
2y ago |
<a href="./README.md"> |
| 40 |
a47eb4c |
Dawsh |
2y ago |
English |
| 41 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 42 |
a47eb4c |
Dawsh |
2y ago |
/ |
| 43 |
a47eb4c |
Dawsh |
2y ago |
<a href="./README-fa.md"> |
| 44 |
a47eb4c |
Dawsh |
2y ago |
فارسی |
| 45 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 46 |
a47eb4c |
Dawsh |
2y ago |
/ |
| 47 |
a47eb4c |
Dawsh |
2y ago |
<a href="./README-zh-cn.md"> |
| 48 |
a47eb4c |
Dawsh |
2y ago |
简体中文 |
| 49 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 50 |
a47eb4c |
Dawsh |
2y ago |
/ |
| 51 |
a47eb4c |
Dawsh |
2y ago |
<a href="./README-ru.md"> |
| 52 |
a47eb4c |
Dawsh |
2y ago |
Русский |
| 53 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 54 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 55 |
a47eb4c |
Dawsh |
2y ago |
|
| 56 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 57 |
a47eb4c |
Dawsh |
2y ago |
<a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer" > |
| 58 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/preview.png" alt="Marzban screenshots" width="600" height="auto"> |
| 59 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 60 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 61 |
a47eb4c |
Dawsh |
2y ago |
|
| 62 |
a47eb4c |
Dawsh |
2y ago |
|
| 63 |
a47eb4c |
Dawsh |
2y ago |
## 目录 |
| 64 |
a47eb4c |
Dawsh |
2y ago |
- [概览](#概览) |
| 65 |
a47eb4c |
Dawsh |
2y ago |
- [为什么要使用 Marzban?](#为什么要使用-marzban) |
| 66 |
a47eb4c |
Dawsh |
2y ago |
- [特性](#特性) |
| 67 |
a47eb4c |
Dawsh |
2y ago |
- [安装指南](#安装指南) |
| 68 |
a47eb4c |
Dawsh |
2y ago |
- [配置](#配置) |
| 69 |
a47eb4c |
Dawsh |
2y ago |
- [如何使用 API](#如何使用-api) |
| 70 |
a47eb4c |
Dawsh |
2y ago |
- [如何备份 Marzban](#如何备份-marzban) |
| 71 |
a47eb4c |
Dawsh |
2y ago |
- [Telegram bot](#telegram-bot) |
| 72 |
a47eb4c |
Dawsh |
2y ago |
- [捐赠](#捐赠) |
| 73 |
a47eb4c |
Dawsh |
2y ago |
- [许可](#许可) |
| 74 |
a47eb4c |
Dawsh |
2y ago |
- [贡献者](#贡献者) |
| 75 |
a47eb4c |
Dawsh |
2y ago |
|
| 76 |
a47eb4c |
Dawsh |
2y ago |
|
| 77 |
a47eb4c |
Dawsh |
2y ago |
# 概览 |
| 78 |
a47eb4c |
Dawsh |
2y ago |
|
| 79 |
a47eb4c |
Dawsh |
2y ago |
Marzban（Marzban一词源自波斯语，意为“边境警卫”，发音为 /mærz'ban/）是一个代理管理工具，提供简单易用的用户界面，可管理数百个代理账户，由 [Xray-core](https://github.com/XTLS/Xray-core) 提供支持，使用 Python 和 Reactjs 构建。 |
| 80 |
a47eb4c |
Dawsh |
2y ago |
|
| 81 |
a47eb4c |
Dawsh |
2y ago |
|
| 82 |
a47eb4c |
Dawsh |
2y ago |
|
| 83 |
a47eb4c |
Dawsh |
2y ago |
## 为什么要使用 Marzban? |
| 84 |
a47eb4c |
Dawsh |
2y ago |
|
| 85 |
a47eb4c |
Dawsh |
2y ago |
Marzban 是一个用户友好、功能丰富且可靠的工具。它让您可以为用户创建不同的代理，无需进行任何复杂的配置。通过其内置的 Web 界面，您可以监视、修改和限制用户。 |
| 86 |
a47eb4c |
Dawsh |
2y ago |
|
| 87 |
a47eb4c |
Dawsh |
2y ago |
### 特性 |
| 88 |
a47eb4c |
Dawsh |
2y ago |
|
| 89 |
a47eb4c |
Dawsh |
2y ago |
- 内置 **Web 界面** |
| 90 |
a47eb4c |
Dawsh |
2y ago |
- 完全支持 **REST API** 的后端 |
| 91 |
a47eb4c |
Dawsh |
2y ago |
- 支持 **Vmess**、**VLESS**、**Trojan** 和 **Shadowsocks** 协议 |
| 92 |
a47eb4c |
Dawsh |
2y ago |
- 单用户的**多协议**支持 |
| 93 |
a47eb4c |
Dawsh |
2y ago |
- 单入站的**多用户**支持 |
| 94 |
a47eb4c |
Dawsh |
2y ago |
- 单端口的**多入站**支持（使用 fallbacks） |
| 95 |
a47eb4c |
Dawsh |
2y ago |
- **流量**和**过期日期**限制 |
| 96 |
a47eb4c |
Dawsh |
2y ago |
- 周期性的流量限制（例如每天、每周等） |
| 97 |
a47eb4c |
Dawsh |
2y ago |
- 兼容 **V2ray** 的**订阅链接**（例如 V2RayNG、OneClick、Nekoray 等）和 **Clash** |
| 98 |
a47eb4c |
Dawsh |
2y ago |
- 自动化的**分享链接**和**二维码**生成器 |
| 99 |
a47eb4c |
Dawsh |
2y ago |
- 系统监控和**流量统计** |
| 100 |
a47eb4c |
Dawsh |
2y ago |
- 可自定义的 xray 配置 |
| 101 |
a47eb4c |
Dawsh |
2y ago |
- **TLS** 支持 |
| 102 |
a47eb4c |
Dawsh |
2y ago |
- 集成的 **Telegram Bot** |
| 103 |
a47eb4c |
Dawsh |
2y ago |
- **多管理员**支持（WIP） |
| 104 |
a47eb4c |
Dawsh |
2y ago |
|
| 105 |
a47eb4c |
Dawsh |
2y ago |
|
| 106 |
a47eb4c |
Dawsh |
2y ago |
# 安装指南 |
| 107 |
a47eb4c |
Dawsh |
2y ago |
Run the following command |
| 108 |
a47eb4c |
Dawsh |
2y ago |
|
| 109 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 110 |
a47eb4c |
Dawsh |
2y ago |
sudo bash -c "$(curl -sL https://github.com/Gozargah/Marzban-scripts/raw/master/marzban.sh)" @ install |
| 111 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 112 |
a47eb4c |
Dawsh |
2y ago |
|
| 113 |
a47eb4c |
Dawsh |
2y ago |
Once the installation is complete: |
| 114 |
a47eb4c |
Dawsh |
2y ago |
|
| 115 |
a47eb4c |
Dawsh |
2y ago |
- You will see the logs that you can stop watching them by closing the terminal or pressing `Ctrl+C` |
| 116 |
a47eb4c |
Dawsh |
2y ago |
- The Marzban files will be located at `/opt/marzban` |
| 117 |
a47eb4c |
Dawsh |
2y ago |
- The configuration file can be found at `/opt/marzban/.env` (refer to [configurations](#configuration) section to see variables) |
| 118 |
a47eb4c |
Dawsh |
2y ago |
- The data files will be placed at `/usr/lib/marzban` |
| 119 |
a47eb4c |
Dawsh |
2y ago |
- You can access the Marzban dashboard by opening a web browser and navigating to `http://YOUR_SERVER_IP:8000/dashboard/` (replace YOUR_SERVER_IP with the actual IP address of your server) |
| 120 |
a47eb4c |
Dawsh |
2y ago |
|
| 121 |
a47eb4c |
Dawsh |
2y ago |
Next, you need to create a sudo admin for logging into the Marzban dashboard by the following command |
| 122 |
a47eb4c |
Dawsh |
2y ago |
|
| 123 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 124 |
a47eb4c |
Dawsh |
2y ago |
marzban cli admin create --sudo |
| 125 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 126 |
a47eb4c |
Dawsh |
2y ago |
|
| 127 |
a47eb4c |
Dawsh |
2y ago |
That's it! You can login to your dashboard using these credentials |
| 128 |
a47eb4c |
Dawsh |
2y ago |
|
| 129 |
a47eb4c |
Dawsh |
2y ago |
To see the help message of the Marzban script, run the following command |
| 130 |
a47eb4c |
Dawsh |
2y ago |
|
| 131 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 132 |
a47eb4c |
Dawsh |
2y ago |
marzban --help |
| 133 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 134 |
a47eb4c |
Dawsh |
2y ago |
|
| 135 |
a47eb4c |
Dawsh |
2y ago |
If you are eager to run the project using the source code, check the section below |
| 136 |
a47eb4c |
Dawsh |
2y ago |
<details markdown="1"> |
| 137 |
a47eb4c |
Dawsh |
2y ago |
<summary><h3>手动安装（高级）</h3></summary> |
| 138 |
a47eb4c |
Dawsh |
2y ago |
|
| 139 |
a47eb4c |
Dawsh |
2y ago |
在您的机器上安装 xray |
| 140 |
a47eb4c |
Dawsh |
2y ago |
|
| 141 |
a47eb4c |
Dawsh |
2y ago |
您可以使用 [Xray-install](https://github.com/XTLS/Xray-install) 脚本进行安装： |
| 142 |
a47eb4c |
Dawsh |
2y ago |
|
| 143 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 144 |
a47eb4c |
Dawsh |
2y ago |
bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ install |
| 145 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 146 |
a47eb4c |
Dawsh |
2y ago |
|
| 147 |
a47eb4c |
Dawsh |
2y ago |
克隆项目并安装依赖项。 |
| 148 |
a47eb4c |
Dawsh |
2y ago |
|
| 149 |
a47eb4c |
Dawsh |
2y ago |
您需要 Python>=3.8 版本。 |
| 150 |
a47eb4c |
Dawsh |
2y ago |
|
| 151 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 152 |
a47eb4c |
Dawsh |
2y ago |
git clone https://github.com/Gozargah/Marzban.git |
| 153 |
a47eb4c |
Dawsh |
2y ago |
cd Marzban |
| 154 |
a47eb4c |
Dawsh |
2y ago |
wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 - |
| 155 |
a47eb4c |
Dawsh |
2y ago |
python3 -m pip install -r requirements.txt |
| 156 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 157 |
a47eb4c |
Dawsh |
2y ago |
|
| 158 |
a47eb4c |
Dawsh |
2y ago |
另外，为了拥有一个隔离的环境，您可以使用 [Python Virtualenv](https://pypi.org/project/virtualenv/)。 |
| 159 |
a47eb4c |
Dawsh |
2y ago |
|
| 160 |
a47eb4c |
Dawsh |
2y ago |
然后运行以下命令运行数据库迁移脚本： |
| 161 |
a47eb4c |
Dawsh |
2y ago |
|
| 162 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 163 |
a47eb4c |
Dawsh |
2y ago |
alembic upgrade head |
| 164 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 165 |
a47eb4c |
Dawsh |
2y ago |
|
| 166 |
a47eb4c |
Dawsh |
2y ago |
现在开始配置： |
| 167 |
a47eb4c |
Dawsh |
2y ago |
|
| 168 |
a47eb4c |
Dawsh |
2y ago |
复制 `.env.example` 文件，查看并使用文本编辑器（如`nano`）进行编辑。 |
| 169 |
a47eb4c |
Dawsh |
2y ago |
|
| 170 |
a47eb4c |
Dawsh |
2y ago |
您可能想要修改管理员凭据。 |
| 171 |
a47eb4c |
Dawsh |
2y ago |
|
| 172 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 173 |
a47eb4c |
Dawsh |
2y ago |
cp .env.example .env |
| 174 |
a47eb4c |
Dawsh |
2y ago |
nano .env |
| 175 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 176 |
a47eb4c |
Dawsh |
2y ago |
|
| 177 |
a47eb4c |
Dawsh |
2y ago |
> 请查看[配置](#配置)部分以获取更多信息。 |
| 178 |
a47eb4c |
Dawsh |
2y ago |
|
| 179 |
a47eb4c |
Dawsh |
2y ago |
最终，使用以下命令启动应用程序： |
| 180 |
a47eb4c |
Dawsh |
2y ago |
|
| 181 |
a47eb4c |
Dawsh |
2y ago |
```bash |
| 182 |
a47eb4c |
Dawsh |
2y ago |
python3 main.py |
| 183 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 184 |
a47eb4c |
Dawsh |
2y ago |
|
| 185 |
a47eb4c |
Dawsh |
2y ago |
也可使用 linux systemctl 启动： |
| 186 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 187 |
a47eb4c |
Dawsh |
2y ago |
systemctl enable /var/lib/marzban/marzban.service |
| 188 |
a47eb4c |
Dawsh |
2y ago |
systemctl start marzban |
| 189 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 190 |
a47eb4c |
Dawsh |
2y ago |
|
| 191 |
a47eb4c |
Dawsh |
2y ago |
配合 nginx 使用： |
| 192 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 193 |
a47eb4c |
Dawsh |
2y ago |
server { |
| 194 |
a47eb4c |
Dawsh |
2y ago |
listen 443 ssl http2; |
| 195 |
a47eb4c |
Dawsh |
2y ago |
listen [::]:443 ssl http2; |
| 196 |
a47eb4c |
Dawsh |
2y ago |
server_name example.com; |
| 197 |
a47eb4c |
Dawsh |
2y ago |
|
| 198 |
a47eb4c |
Dawsh |
2y ago |
ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; |
| 199 |
a47eb4c |
Dawsh |
2y ago |
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; |
| 200 |
a47eb4c |
Dawsh |
2y ago |
|
| 201 |
a47eb4c |
Dawsh |
2y ago |
location ~* /(dashboard|api|docs|redoc|openapi.json) { |
| 202 |
a47eb4c |
Dawsh |
2y ago |
proxy_pass http://0.0.0.0:8000; |
| 203 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header Host $host; |
| 204 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Real-IP $remote_addr; |
| 205 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; |
| 206 |
a47eb4c |
Dawsh |
2y ago |
} |
| 207 |
a47eb4c |
Dawsh |
2y ago |
|
| 208 |
a47eb4c |
Dawsh |
2y ago |
# xray-core ws-path: / |
| 209 |
a47eb4c |
Dawsh |
2y ago |
# client ws-path: /marzban/me/2087 |
| 210 |
a47eb4c |
Dawsh |
2y ago |
# |
| 211 |
a47eb4c |
Dawsh |
2y ago |
# 所有流量通过 443 端口进行代理，然后分发至真正的 xray 端口（2087、2088 等等）。 |
| 212 |
a47eb4c |
Dawsh |
2y ago |
# 路径中的 “/marzban” 可以改为任意合法 URL 字符. |
| 213 |
a47eb4c |
Dawsh |
2y ago |
# |
| 214 |
a47eb4c |
Dawsh |
2y ago |
# /${path}/${username}/${xray-port} |
| 215 |
a47eb4c |
Dawsh |
2y ago |
location ~* /marzban/.+/(.+)$ { |
| 216 |
a47eb4c |
Dawsh |
2y ago |
proxy_redirect off; |
| 217 |
a47eb4c |
Dawsh |
2y ago |
proxy_pass http://127.0.0.1:$1/; |
| 218 |
a47eb4c |
Dawsh |
2y ago |
proxy_http_version 1.1; |
| 219 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header Upgrade $http_upgrade; |
| 220 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header Connection "upgrade"; |
| 221 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header Host $http_host; |
| 222 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Real-IP $remote_addr; |
| 223 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; |
| 224 |
a47eb4c |
Dawsh |
2y ago |
} |
| 225 |
a47eb4c |
Dawsh |
2y ago |
} |
| 226 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 227 |
a47eb4c |
Dawsh |
2y ago |
或 |
| 228 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 229 |
a47eb4c |
Dawsh |
2y ago |
server { |
| 230 |
a47eb4c |
Dawsh |
2y ago |
listen 443 ssl http2; |
| 231 |
a47eb4c |
Dawsh |
2y ago |
listen [::]:443 ssl http2; |
| 232 |
a47eb4c |
Dawsh |
2y ago |
server_name marzban.example.com; |
| 233 |
a47eb4c |
Dawsh |
2y ago |
|
| 234 |
a47eb4c |
Dawsh |
2y ago |
ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; |
| 235 |
a47eb4c |
Dawsh |
2y ago |
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; |
| 236 |
a47eb4c |
Dawsh |
2y ago |
|
| 237 |
a47eb4c |
Dawsh |
2y ago |
location / { |
| 238 |
a47eb4c |
Dawsh |
2y ago |
proxy_pass http://0.0.0.0:8000; |
| 239 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header Host $host; |
| 240 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Real-IP $remote_addr; |
| 241 |
a47eb4c |
Dawsh |
2y ago |
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; |
| 242 |
a47eb4c |
Dawsh |
2y ago |
} |
| 243 |
a47eb4c |
Dawsh |
2y ago |
} |
| 244 |
a47eb4c |
Dawsh |
2y ago |
``` |
| 245 |
a47eb4c |
Dawsh |
2y ago |
|
| 246 |
a47eb4c |
Dawsh |
2y ago |
默认情况下，应用将在 `http://localhost:8000/dashboard` 上运行。您可以通过更改 `UVICORN_HOST` 和 `UVICORN_PORT` 环境变量来进行配置。 |
| 247 |
a47eb4c |
Dawsh |
2y ago |
</details> |
| 248 |
a47eb4c |
Dawsh |
2y ago |
|
| 249 |
a47eb4c |
Dawsh |
2y ago |
# 配置 |
| 250 |
a47eb4c |
Dawsh |
2y ago |
|
| 251 |
a47eb4c |
Dawsh |
2y ago |
> 您可以使用环境变量或将其放置在 `env` 或 `.env` 文件中来设置以下设置。 |
| 252 |
a47eb4c |
Dawsh |
2y ago |
|
| 253 |
a47eb4c |
Dawsh |
2y ago |
| 变量 | 描述 | |
| 254 |
a47eb4c |
Dawsh |
2y ago |
| ------------------------------- | ---------------------------------------------------------------------------------------------------- | |
| 255 |
a47eb4c |
Dawsh |
2y ago |
| SUDO_USERNAME | 管理员用户名（默认: admin） | |
| 256 |
a47eb4c |
Dawsh |
2y ago |
| SUDO_PASSWORD | 管理员密码（默认: admin） | |
| 257 |
a47eb4c |
Dawsh |
2y ago |
| SQLALCHEMY_DATABASE_URL | 数据库文档（[SQLAlchemy's docs](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls)） | |
| 258 |
a47eb4c |
Dawsh |
2y ago |
| UVICORN_HOST | 绑定应用程序到此主机（默认为 `0.0.0.0`） | |
| 259 |
a47eb4c |
Dawsh |
2y ago |
| UVICORN_PORT | 绑定应用程序到此端口（默认为 `8000`） | |
| 260 |
a47eb4c |
Dawsh |
2y ago |
| UVICORN_UDS | 将应用程序绑定到一个 UNIX 域套接字 | |
| 261 |
a47eb4c |
Dawsh |
2y ago |
| UVICORN_SSL_CERTFILE | SSL 证书文件路径 | |
| 262 |
a47eb4c |
Dawsh |
2y ago |
| UVICORN_SSL_KEYFILE | SSL 密钥文件路径 | |
| 263 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_JSON | Xray 的 json 配置文件路径（默认: `xray_config.json`） | |
| 264 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_EXECUTABLE_PATH | Xray 的执行程序路径: `/usr/local/bin/xray`） | |
| 265 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_ASSETS_PATH | Xray 的资源目录: `/usr/local/share/xray`） | |
| 266 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_SUBSCRIPTION_URL_PREFIX | 订阅URL的前缀 | |
| 267 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_FALLBACKS_INBOUND_TAG | 包含 fallbacks 的入站标记, 在您需要使用 fallbacks 配置此项 | |
| 268 |
a47eb4c |
Dawsh |
2y ago |
| XRAY_EXCLUDE_INBOUND_TAGS | 不需要此应用程序管理或在链接中包含的入站标记 | |
| 269 |
a47eb4c |
Dawsh |
2y ago |
| CLASH_SUBSCRIPTION_TEMPLATE | 将用于生成冲突配置的模板（默认值：`clash/default.yml`） | |
| 270 |
a47eb4c |
Dawsh |
2y ago |
| SUBSCRIPTION_PAGE_TEMPLATE | 用于生成订阅信息页面的模板（默认：`subscription/index.html`） | |
| 271 |
a47eb4c |
Dawsh |
2y ago |
| HOME_PAGE_TEMPLATE | 诱饵页面模板（默认：`home/index.html`） | |
| 272 |
a47eb4c |
Dawsh |
2y ago |
| TELEGRAM_API_TOKEN | Telegram bot API 令牌（可以从 [@botfather](https://t.me/botfather) 获取） | |
| 273 |
a47eb4c |
Dawsh |
2y ago |
| TELEGRAM_ADMIN_ID | 管理员的 Telegram ID（可以使用 [@userinfobot](https://t.me/userinfobot) 查找您的 ID） | |
| 274 |
a47eb4c |
Dawsh |
2y ago |
| TELEGRAM_PROXY_URL | 在代理下运行 Telegram bot。 | |
| 275 |
a47eb4c |
Dawsh |
2y ago |
| JWT_ACCESS_TOKEN_EXPIRE_MINUTES | Access Tokens 的过期时间，以分钟为单位，`0` 表示无限期（默认为 `1440` 分钟） | |
| 276 |
a47eb4c |
Dawsh |
2y ago |
| DOCS | API 文档是否应该在 `/docs` 和 `/redoc` 上提供（默认为 `False` | |
| 277 |
a47eb4c |
Dawsh |
2y ago |
| DEBUG | 开发者调试模式（默认: `False`） | |
| 278 |
a47eb4c |
Dawsh |
2y ago |
|
| 279 |
a47eb4c |
Dawsh |
2y ago |
|
| 280 |
a47eb4c |
Dawsh |
2y ago |
# 如何使用 API |
| 281 |
a47eb4c |
Dawsh |
2y ago |
Marzban 提供了 REST API，使开发人员能够以编程方式与 Marzban 服务进行交互。要在 Swagger UI 或 ReDoc 中查看 API 文档，设置配置变量 `DOCS=True`，然后导航到 `/docs` 和 `/redoc`。 |
| 282 |
a47eb4c |
Dawsh |
2y ago |
|
| 283 |
a47eb4c |
Dawsh |
2y ago |
|
| 284 |
a47eb4c |
Dawsh |
2y ago |
# 如何备份 Marzban |
| 285 |
a47eb4c |
Dawsh |
2y ago |
|
| 286 |
a47eb4c |
Dawsh |
2y ago |
定期备份 Marzban 文件是预防系统故障或意外删除导致数据丢失的好习惯。以下是备份 Marzban 的步骤： |
| 287 |
a47eb4c |
Dawsh |
2y ago |
|
| 288 |
a47eb4c |
Dawsh |
2y ago |
1. 默认情况下，所有重要的 Marzban 文件都保存在 `/var/lib/marzban` ( Docker 版本)中。将整个 `/var/lib/marzban` 目录复制到您选择的备份位置，比如外部硬盘或云存储。 |
| 289 |
a47eb4c |
Dawsh |
2y ago |
2. 此外，请确保备份您的 `env` 文件，其中包含您的配置变量，以及您的 `Xray` 配置文件。 |
| 290 |
a47eb4c |
Dawsh |
2y ago |
|
| 291 |
a47eb4c |
Dawsh |
2y ago |
按照这些步骤，您可以确保有备份所有 Marzban 文件和数据，以及您的配置变量和 Xray 配置，以备将来恢复使用。请记得定期更新备份，以保持它们的最新性。 |
| 292 |
a47eb4c |
Dawsh |
2y ago |
|
| 293 |
a47eb4c |
Dawsh |
2y ago |
|
| 294 |
a47eb4c |
Dawsh |
2y ago |
# Telegram bot |
| 295 |
a47eb4c |
Dawsh |
2y ago |
|
| 296 |
a47eb4c |
Dawsh |
2y ago |
Marzban 配备了一个集成的 Telegram bot，可以处理服务器管理、用户创建和删除，以及发送通知。通过几个简单的步骤，您可以轻松地启用这个机器人，并提供了一种方便的方式与 Marzban 交互，而不需要每次都登录到服务器上。 |
| 297 |
a47eb4c |
Dawsh |
2y ago |
|
| 298 |
a47eb4c |
Dawsh |
2y ago |
启用 Telegram bot： |
| 299 |
a47eb4c |
Dawsh |
2y ago |
|
| 300 |
a47eb4c |
Dawsh |
2y ago |
1. 将 `TELEGRAM_API_TOKEN` 设置为您的 bot API Token。 |
| 301 |
a47eb4c |
Dawsh |
2y ago |
2. 将 `TELEGRAM_ADMIN_ID` 设置为您的 Telegram ID，您可以从 [@userinfobot](https://t.me/userinfobot) 中获取自己的 ID。 |
| 302 |
a47eb4c |
Dawsh |
2y ago |
|
| 303 |
a47eb4c |
Dawsh |
2y ago |
|
| 304 |
a47eb4c |
Dawsh |
2y ago |
# 捐赠 |
| 305 |
a47eb4c |
Dawsh |
2y ago |
|
| 306 |
a47eb4c |
Dawsh |
2y ago |
如果您认为 Marzban 有用，并想支持其发展，可以在以下加密网络之一进行捐赠： |
| 307 |
a47eb4c |
Dawsh |
2y ago |
|
| 308 |
a47eb4c |
Dawsh |
2y ago |
- TRON(TRX) 网络：`TX8kJoDcowQPBFTYHAJR36GyoUKP1Xwzkb` |
| 309 |
a47eb4c |
Dawsh |
2y ago |
- ETH、BNB、MATIC 网络：`0xFdc9ad32454FA4fc4733270FCc12ddBFb68b83F7` |
| 310 |
a47eb4c |
Dawsh |
2y ago |
- 比特币网络：`bc1qpys2nefgsjjgae3g3gqy9crsv3h3rm96tlkz0v` |
| 311 |
a47eb4c |
Dawsh |
2y ago |
- Dogecoin 网络：`DJAocBAu8y6LwhDKUktLAyzV8xyoFeHH6R` |
| 312 |
a47eb4c |
Dawsh |
2y ago |
- TON 网络：`EQAVf-7hAXHlF-jmrKE44oBwN7HGQFVBLAtrOsev5K4qR4P8` |
| 313 |
a47eb4c |
Dawsh |
2y ago |
|
| 314 |
a47eb4c |
Dawsh |
2y ago |
|
| 315 |
a47eb4c |
Dawsh |
2y ago |
感谢您的支持！ |
| 316 |
a47eb4c |
Dawsh |
2y ago |
|
| 317 |
a47eb4c |
Dawsh |
2y ago |
# 许可 |
| 318 |
a47eb4c |
Dawsh |
2y ago |
|
| 319 |
a47eb4c |
Dawsh |
2y ago |
制作于 [Unknown!] 并在 [AGPL-3.0](./LICENSE) 下发布。 |
| 320 |
a47eb4c |
Dawsh |
2y ago |
|
| 321 |
a47eb4c |
Dawsh |
2y ago |
# 贡献者 |
| 322 |
a47eb4c |
Dawsh |
2y ago |
|
| 323 |
a47eb4c |
Dawsh |
2y ago |
我们热爱贡献者！如果您想做出贡献，请查看我们的[贡献指南](CONTRIBUTING.md)并随时提交拉取请求或打开问题。我们也欢迎您加入我们的 [Telegram](https://t.me/gozargah_marzban) 群组，以获得支持或贡献指导。 |
| 324 |
a47eb4c |
Dawsh |
2y ago |
|
| 325 |
a47eb4c |
Dawsh |
2y ago |
查看 [issues](https://github.com/gozargah/marzban/issues) 以帮助改进这个项目。 |
| 326 |
a47eb4c |
Dawsh |
2y ago |
|
| 327 |
a47eb4c |
Dawsh |
2y ago |
|
| 328 |
a47eb4c |
Dawsh |
2y ago |
|
| 329 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 330 |
a47eb4c |
Dawsh |
2y ago |
感谢所有为改善 Marzban 做出贡献的贡献者们： |
| 331 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 332 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 333 |
a47eb4c |
Dawsh |
2y ago |
<a href="https://github.com/Gozargah/Marzban/graphs/contributors"> |
| 334 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://contrib.rocks/image?repo=Gozargah/Marzban" /> |
| 335 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 336 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 337 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 338 |
a47eb4c |
Dawsh |
2y ago |
Made with <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a> |
| 339 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 340 |
a47eb4c |
Dawsh |
2y ago |
|