gitscope
/
← marzneshin / Diff · 98e8748 → 98e8748
Changes 98e8748..98e8748
Patch commit
diff --git a/README-fa.md b/README-fa.md
deleted file mode 100755
index b92fe62..0000000
--- a/README-fa.md
+++ /dev/null
@@ -1,370 +0,0 @@
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-dark.png">
- <img width="160" height="160" src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-light.png">
- </picture>
- </a>
-</p>
-
-<h1 align="center"/>مرزبان</h1>
-
-<p align="center">
- راه حل یکپارچه برای مدیریت پروتکل های مختلف. قدرت گرفته از <a href="https://github.com/XTLS/Xray-core">Xray</a>
-</p>
-
-<br/>
-<p align="center">
- <a href="#">
- <img src="https://img.shields.io/github/actions/workflow/status/gozargah/marzban/build.yml?style=flat-square" />
- </a>
- <a href="https://hub.docker.com/r/gozargah/marzban" target="_blank">
- <img src="https://img.shields.io/docker/pulls/gozargah/marzban?style=flat-square&logo=docker" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/license/gozargah/marzban?style=flat-square" />
- </a>
- <a href="https://t.me/gozargah_marzban" target="_blank">
- <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/badge/twitter-commiunity-blue?style=flat-square&logo=twitter" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/stars/gozargah/marzban?style=social" />
- </a>
-</p>
-
-<p align="center">
- <a href="./README.md">
- English
- </a>
- /
- <a href="./README-fa.md">
- فارسی
- </a>
- /
- <a href="./README-zh-cn.md">
- 简体中文
- </a>
- /
- <a href="./README-ru.md">
- Русский
- </a>
-</p>
-
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer" >
- <img src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/preview.png" alt="Elk screenshots" width="600" height="auto">
- </a>
-</p>
-
-
-## فهرست مطالب
-- [بررسی اجمالی](#بررسی-اجمالی)
- - [چرا مرزبان؟](#چرا-مرزبان)
- - [امکانات](#امکانات)
-- [راهنمای نصب](#راهنمای-نصب)
-- [تنظیمات](#تنظیمات)
-- [استفاده از API](#استفاده-از-api)
-- [پشتیبان گیری از مرزبان](#پشتیبان-گیری-از-مرزبان)
-- [ربات تلگرام](#ربات-تلگرام)
-- [رابط خط فرمان (CLI) مرزبان](#رابط-خط-فرمان-cli-مرزبان)
-- [ارسال اعلان‌ها به آدرس وبهوک](#ارسال-اعلانها-به-آدرس-وبهوک)
-- [کمک مالی](#کمک-مالی)
-- [لایسنس](#لایسنس)
-- [مشارکت در توسعه](#مشارکت-در-توسعه)
-
-
-# بررسی اجمالی
-
-مرزبان یک نرم افزار (وب اپلیکیشن) مدیریت پروکسی است که امکان مدیریت چند صد حساب پروکسی را با قدرت و دسترسی بالا فراهم میکند. مرزبان از [Xray-core](https://github.com/XTLS/Xray-core) قدرت گرفته و با Python و React پیاده سازی شده است.
-
-## چرا مرزبان؟
-
-مرزبان دارای یک رابط کاربری ساده است که قابلیت های زیادی دارد. مرزبان امکان ایجاد چند نوع پروکسی برای کاربر ها را فراهم میکند بدون اینکه به تنظیمات پیچیده ای نیاز داشته باشید. به کمک رابط کاربری تحت وب مرزبان، شما میتوانید کاربران را مانیتور، ویرایش و در صورت نیاز، محدود کنید.
-
-### امکانات
-
-- **رابط کاربری تحت وب** آماده
-- به صورت **REST API** پیاده سازی شده
-- پشتیبانی از پروتکل های **Vmess**, **VLESS**, **Trojan** و **Shadowsocks**
-- امکان فعالسازی **چندین پروتکل** برای هر یوزر
-- امکان ساخت **چندین کاربر** بر روی یک inbound
-- پشتیبانی از **چندین inbound** بر روی **یک port** (به کمک fallbacks)
-- محدودیت بر اساس مصرف **ترافیک** و **تاریخ انقضا**
-- محدودیت **ترافیک دوره ای** (به عنوان مثال روزانه، هفتگی و غیره)
-- پشتیبانی از **Subscription link** سازگار با **V2ray** _(مثل نرم افزار های V2RayNG, OneClick, Nekoray و...)_ و **Clash**
-- ساخت **لینک اشتراک گذاری** و **QRcode** به صورت خودکار
-- مانیتورینگ منابع سرور و **مصرف ترافیک**
-- پشتیبانی از تنظیمات xray
-- پشتیبانی از **TLS**
-- **ربات تلگرام**
-- **رابط خط فرمان (CLI)** داخلی
-- قابلیت ایجاد **چندین مدیر** (تکمیل نشده است)
-
-# راهنمای نصب
-
-برای نصب کافیه دستور زیر رو اجرا کنید
-
-```bash
-sudo bash -c "$(curl -sL https://github.com/Gozargah/Marzban-scripts/raw/master/marzban.sh)" @ install
-```
-
-وقتی نصب تمام شد:
-
-- شما لاگ های مرزبان رو مشاهده میکنید که می‌توانید با بستن ترمینال یا فشار دادن `Ctrl+C` از آن خارج شوید
-- فایل های مرزبان در پوشه `/opt/marzban` قرار می‌گیرند
-- فایل تنظیمات در مسیر `/opt/marzban/.env` قرار می‌گیرد ([تنظیمات](#تنظیمات) را مشاهده کنید)
-- فایل های مهم (اطلاعات) مرزبان در مسیر `/usr/lib/marzban` قرار می‌گیرند
-- شما از طریق آدرس `http://YOUR_SERVER_IP:8000/dashboard/` می‌توانید وارد داشبورد مرزبان شوید (YOUR_SERVER_IP را با آیپی سرور خود عوض کنید)
-
-در مرحله بعد, باید یک ادمین سودو بسازید
-
-```bash
-marzban cli admin create --sudo
-```
-
-تمام! حالا با این اطلاعات می‌توانید وارد مرزبان شوید
-
-برای مشاهده راهنمای اسکریپت مرزبان دستور زیر را اجرا کنید
-
-```bash
-marzban --help
-```
-
-اگر مشتاق هستید که مرزبان رو با پایتون و به صورت دستی اجرا کنید، مراحل زیر را مشاهده کنید
-<details markdown="1">
-<summary><h3>نصب به صورت دستی (پیچیده)</h3></summary>
-
-لطفا xray را نصب کنید.
-شما میتواند به کمک [Xray-install](https://github.com/XTLS/Xray-install) این کار را انجام دهید.
-
-```bash
-bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ install
-```
-
-پروژه را clone کنید و dependency ها را نصب کنید. دقت کنید که نسخه پایتون شما Python>=3.8 باشد.
-
-```bash
-git clone https://github.com/Gozargah/Marzban.git
-cd Marzban
-wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 -
-python3 -m pip install -r requirements.txt
-```
-
-همچنین میتواند از , [Python Virtualenv](https://pypi.org/project/virtualenv/) هم استفاده کنید.
-
-سپس کامند زیر را اجرا کنید تا دیتابیس تنظیم شود.
-
-```bash
-alembic upgrade head
-```
-
-اگر می خواهید از `marzban-cli` استفاده کنید، باید آن را به یک فایل در `$PATH` خود لینک و قابل اجرا (executable) کنید. سپس تکمیل خودکار (auto-completion) آن را نصب کنید:
-
-```bash
-sudo ln -s $(pwd)/marzban-cli.py /usr/bin/marzban-cli
-sudo chmod +x /usr/bin/marzban-cli
-marzban-cli completion install
-```
-
-حالا یک کپی از `.env.example` با نام `.env` بسازید و با یک ادیتور آن را باز کنید و تنظیمات دلخواه خود را انجام دهید. یه عنوان مثال نام کاربری و رمز عبور را می توانید در این فایل تغییر دهید.
-
-```bash
-cp .env.example .env
-nano .env
-```
-
-> برای اطلاعات بیشتر بخش [تنظیمات](#تنظیمات) را مطالعه کنید.
-
-در انتها, مرزبان را به کمک دستور زیر اجرا کنید.
-
-```bash
-python3 main.py
-```
-
-اجرا با استفاده از systemctl در لینوکس
-```
-systemctl enable /var/lib/marzban/marzban.service
-systemctl start marzban
-```
-
-اجرا با nginx
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location ~* /(dashboard|api|docs|redoc|openapi.json) {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-or
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name marzban.example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location / {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-
-به صورت پیشفرض مرزبان در آدرس `http://localhost:8000/dashboard` اجرا میشود. شما میتوانید با تغییر `UVICORN_HOST` و `UVICORN_PORT`، هاست و پورت را تغییر دهید.
-</details>
-
-# تنظیمات
-
-> متغیر های زیر در فایل ‍`env` یا `.env` استفاده میشوند. شما می توانید با تعریف و تغییر آن ها، تنظیمات مرزبان را تغییر دهید.
-
-| توضیحات | متغیر |
-| ----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |
-| نام کاربری مدیر کل | SUDO_USERNAME |
-| رمز عبور مدیر کل | SUDO_PASSWORD |
-| آدرس دیتابیس ([بر اساس مستندات SQLAlchemy](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls)) | SQLALCHEMY_DATABASE_URL |
-| آدرس هاستی که مرزبان روی آن اجرا میشود (پیشفرض: `0.0.0.0`) | UVICORN_HOST |
-| پورتی که مرزبان روی آن اجرا میشود (پیشفرض: `8000`) | UVICORN_PORT |
-| اجرای مرزبان بر روی یک Unix domain socket | UVICORN_UDS |
-| آدرس گواهی SSL به جهت ایمن کردن پنل مرزبان | UVICORN_SSL_CERTFILE |
-| آدرس کلید گواهی SSL | UVICORN_SSL_KEYFILE |
-| مسیر فایل json تنظیمات xray (پیشفرض: `xray_config.json`) | XRAY_JSON |
-| مسیر باینری xray (پیشفرض: `/usr/local/bin/xray`) | XRAY_EXECUTABLE_PATH |
-| مسیر asset های xray (پیشفرض: `/usr/local/share/xray`) | XRAY_ASSETS_PATH |
-| پیشوند (یا هاست) آدرس های اشتراکی (زمانی کاربرد دارد که نیاز دارید دامنه subscription link ها با دامنه پنل متفاوت باشد) | XRAY_SUBSCRIPTION_URL_PREFIX |
-| تگ inboundای که به عنوان fallback استفاده میشود. | XRAY_FALLBACKS_INBOUND_TAG |
-| تگ های inbound ای که لازم نیست در کانفیگ های ساخته شده وجود داشته باشند. | XRAY_EXCLUDE_INBOUND_TAGS |
-| آدرس محل template های شخصی سازی شده کاربر | CUSTOM_TEMPLATES_DIRECTORY |
-| تمپلیت مورد استفاده برای تولید کانفیگ های Clash (پیشفرض: `clash/default.yml`) | CLASH_SUBSCRIPTION_TEMPLATE |
-| تمپلیت صفحه اطلاعات اشتراک کاربر (پیشفرض `subscription/index.html`) | SUBSCRIPTION_PAGE_TEMPLATE |
-| تمپلیت صفحه اول (پیشفرض: `home/index.html`) | HOME_PAGE_TEMPLATE |
-| توکن ربات تلگرام (دریافت از [@botfather](https://t.me/botfather)) | TELEGRAM_API_TOKEN |
-| آیدی عددی ادمین در تلگرام (دریافت از [@userinfobot](https://t.me/userinfobot)) | TELEGRAM_ADMIN_ID |
-| اجرای ربات از طریق پروکسی | TELEGRAM_PROXY_URL |
-| مدت زمان انقضا توکن دسترسی به پنل مرزبان, `0` به معنای بدون تاریخ انقضا است (پیشفرض: `1440`) | JWT_ACCESS_TOKEN_EXPIRE_MINUTES |
-| فعال سازی داکیومنتیشن به آدرس `/docs` و `/redoc`(پیشفرض: `False`) | DOCS |
-| فعالسازی حالت توسعه (development) (پیشفرض: `False`) | DEBUG |
-| WEBHOOK_ADDRESS | آدرس webhook که تغییرات حالت یک کاربر به آن ارسال می‌شوند. اگر این متغیر مقدار داشته باشد، ارسال پیام‌ها انجام می‌شوند. |
-| WEBHOOK_SECRET | متغیری که به عنوان `x-webhook-secret` در header ارسال می‌شود. (پیشفرض: `None`) |
-| تعداد دفعاتی که برای ارسال یک پیام، در صورت تشخیص خطا در ارسال تلاش دوباره شود (پیشفرض `3`) | NUMBER_OF_RECURRENT_NOTIFICATIONS |
-| مدت زمان بین هر ارسال دوباره پیام در صورت تشخیص خطا در ارسال به ثانیه (پیشفرض: `180`) | RECURRENT_NOTIFICATIONS_TIMEOUT |
-| هنگام رسیدن مصرف کاربر به چه درصدی پیام اخطار به آدرس وبهوک ارسال شود (پیشفرض: `80`) | NOTIFY_REACHED_USAGE_PERCENT |
-| چند روز مانده به انتهای سرویس پیام اخطار به آدرس وبهوک ارسال شود (پیشفرض: `3`) | NOTIFY_DAYS_LEFT |
-
-
-# استفاده از API
-مرزبان به توسعه دهندگانAPI REST ارائه می دهد. برای مشاهده اسناد API در قالب Swagger UI یا ReDoc، متغیر `DOCS=True` را در تنظیمات خود ست کنید و در مرورگر به مسیر `/docs` و `/redoc` بروید.
-
-
-# پشتیبان گیری از مرزبان
-بهتر است همیشه از فایل های مرزبان خود نسخه پشتیبان تهیه کنید تا در صورت خرابی سیستم یا حذف تصادفی اطلاعات از دست نروند. مراحل تهیه نسخه پشتیبان از مرزبان به شرح زیر است:
-
-1. به طور پیش فرض، تمام فایل های مهم مرزبان در `/var/lib/marzban` ذخیره می شوند (در نسخه داکر). کل پوشه `/var/lib/marzban` را در یک مکان پشتیبان مورد نظر خود، مانند هارد دیسک خارجی یا فضای ذخیره سازی ابری کپی کنید.
-2. علاوه بر این، مطمئن شوید که از فایل env خود که حاوی متغیرهای تنظیمات شما است و همچنین فایل پیکربندی Xray خود نسخه پشتیبان تهیه کنید.
-
-با انجام این مراحل، می توانید اطمینان حاصل کنید که از تمام فایل ها و داده های مرزبان خود یک نسخه پشتیبان تهیه کرده اید. به خاطر داشته باشید که نسخه های پشتیبان خود را به طور مرتب به روز کنید تا آنها را به روز نگه دارید.
-
-
-# ربات تلگرام
-مرزبان دارای یک ربات تلگرام داخلی است که می تواند مدیریت سرور، ایجاد و حذف کاربر و ارسال نوتیفیکیشن را انجام دهد. این ربات را می توان با انجام چند مرحله ساده به راحتی فعال کرد
-
-برای فعال کردن ربات تلگرام:
-
-1. در تنظیمات، متغیر`TELEGRAM_API_TOKEN` را به API TOKEN ربات تلگرام خود تنظیم کنید.
-2. همینطور، متغیر`TELEGRAM_ADMIN_ID` را به شناسه عددی حساب تلگرام خود تنظیم کنید. شما می‌توانید شناسه خود را از [@userinfobot](https://t.me/userinfobot) دریافت کنید.
-
-
-# رابط خط فرمان (CLI) مرزبان
-مرزبان دارای یک رابط خط فرمان (Command Line Interface / CLI) داخلی است که به مدیران اجازه می دهد با مرزبان ارتباط مستقیم داشته باشند.
-
-اگر از Docker برای مرزبان استفاده می کنید، بهتر است از دستور های `docker exec` یا `docker-compose exec` استفاده کنید تا به پوسته (shell) تعاملی کانتینر مرزبان دسترسی پیدا کنید.
-
-برای مثال، به پوشه ی `docker-compose.yml` مرزبان بروید و دستور زیر را اجرا کنید:
-
-```bash
-$ sudo docker-compose exec -it marzban bash
-```
-
-رابط خط فرمان (CLI) مرزبان از طریق دستور `marzban-cli` هرکجا در دسترس خواهد بود!
-
-برای کسب اطلاعات بیشتر می توانید [مستندات CLI مرزبان](./cli/README.md) را مطالعه کنید.
-
-
-# ارسال اعلان‌ها به آدرس وبهوک
-شما می‌توانید آدرسی را برای مرزبان فراهم کنید تا تغییرات کاربران را به صورت اعلان برای شما ارسال کند.
-
-اعلان‌ها به صورت یک درخواست POST به آدرسی که در `WEBHOOK_ADDRESS` فراهم شده به همراه مقدار تعیین شده در `WEBHOOK_SECRET` به عنوان `x-webhook-secret` در header درخواست ارسال می‌شوند.
-
-نمونه‌ای از درخواست ارسال شده توسط مرزبان:
-
-```
-Headers:
-Host: 0.0.0.0:9000
-User-Agent: python-requests/2.28.1
-Accept-Encoding: gzip, deflate
-Accept: */*
-Connection: keep-alive
-x-webhook-secret: something-very-very-secret
-Content-Length: 107
-Content-Type: application/json
-
-
-
-Body:
-{"username": "marzban_test_user", "action": "user_updated", "enqueued_at": 1680506457.636369, "tries": 0}
-```
-
-انواع مختلف actionهایی که مرزبان ارسال می‌کند: `user_created`, `user_updated`, `user_deleted`, `user_limited`, `user_expired`, `user_disabled`, `user_enabled`
-
-
-# کمک مالی
-اگر مرزبان را برای شما مفید بوده و می‌خواهید از توسعه آن حمایت کنید، می‌توانید در یکی از طریق یکی از شبکه های کریپتو زیر کمک مالی کنید:
-
-- شبکه TRON (TRX): `TX8kJoDcowQPBFTYHAJR36GyoUKP1Xwzkb`
-- شبکه ETH، BNB، MATIC: `0xFdc9ad32454FA4fc4733270FCc12ddBFb68b83F7`
-- شبکه بیت کوین: `bc1qpys2nefgsjjgae3g3gqy9crsv3h3rm96tlkz0v`
-- شبکه Dogecoin: `DJAocBAu8y6LwhDKUktLAyzV8xyoFeHH6R`
-- شبکه TON: `EQAVf-7hAXHlF-jmrKE44oBwN7HGQFVBLAtrOsev5K4qR4P8`
-
-
-از حمایت شما متشکرم!
-
-
-# لایسنس
-
-توسعه یافته شده در [ناشناس!] و منتشر شده تحت لایسنس [AGPL-3.0](./LICENSE).
-
-
-# مشارکت در توسعه
-این ❤️‍🔥 تقدیم به همه‌ی کسایی که در توسعه مرزبان مشارکت می‌کنند! اگر می‌خواهید مشارکت داشته باشید، لطفاً [دستورالعمل‌های مشارکت](CONTRIBUTING.md) ما را بررسی کنید و در صورت تمایل Pull Request ارسال کنید یا یک Issue باز کنید. همچنین از شما برای پیوستن به گروه [تلگرام](https://t.me/gozargah_marzban) ما برای حمایت یا کمک به راهنمایی استقبال می کنیم.
-
-لطفا اگر امکانش رو دارید، با بررسی [لیست کار ها](https://github.com/gozargah/marzban/issues) به ما در بهبود مرزبان کمک کنید. کمک های شما با آغوش باز پذیرفته میشه.
-
-<p align="center">
-با تشکر از همه همکارانی که به بهبود مرزبان کمک کردند:
-</p>
-<p align="center">
-<a href="https://github.com/Gozargah/Marzban/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=Gozargah/Marzban" />
-</a>
-</p>
-<p align="center">
- ساخته شده با <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a>
-</p>
-
diff --git a/README-ru.md b/README-ru.md
deleted file mode 100644
index bf058db..0000000
--- a/README-ru.md
+++ /dev/null
@@ -1,397 +0,0 @@
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-dark.png">
- <img width="160" height="160" src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-light.png">
- </picture>
- </a>
-</p>
-
-<h1 align="center"/>Marzban</h1>
-
-<p align="center">
- Унифицированное решение с графическим интерфейсом, устойчивое к цензуре, на базе <a href="https://github.com/XTLS/Xray-core">Xray</a>
-</p>
-
-<br/>
-<p align="center">
- <a href="#">
- <img src="https://img.shields.io/github/actions/workflow/status/gozargah/marzban/build.yml?style=flat-square" />
- </a>
- <a href="https://hub.docker.com/r/gozargah/marzban" target="_blank">
- <img src="https://img.shields.io/docker/pulls/gozargah/marzban?style=flat-square&logo=docker" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/license/gozargah/marzban?style=flat-square" />
- </a>
- <a href="https://t.me/gozargah_marzban" target="_blank">
- <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/badge/twitter-commiunity-blue?style=flat-square&logo=twitter" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/stars/gozargah/marzban?style=social" />
- </a>
-</p>
-
-<p align="center">
- <a href="./README.md">
- English
- </a>
- /
- <a href="./README-fa.md">
- فارسی
- </a>
- /
- <a href="./README-zh-cn.md">
- 简体中文
- </a>
- /
- <a href="./README-ru.md">
- Русский
- </a>
-</p>
-
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer" >
- <img src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/preview.png" alt="Marzban screenshots" width="600" height="auto">
- </a>
-</p>
-
-## Оглавление
-
-- [Введение](#введение)
- - [Почему Marzban](#почему-marzban)
- - [Функции](#функции)
-- [Руководство по установке](#руководство-по-установке)
-- [Конфигурация](#конфигурация)
-- [API](#api)
-- [Backup](#backup)
-- [Telegram бот](#telegram-bot)
-- [Marzban CLI](#marzban-cli)
-- [Marzban Node](#marzban-node)
-- [Webhook уведомления](#webhook-уведомления)
-- [Поддержка](#поддержка)
-- [Лицензия](#лицензия)
-- [Участники](#участники)
-
-# Введение
-
-Marzban (Персидское слово "Пограничник" - произносится /mærz'ban/) — это инструмент управления прокси-серверами, который предоставляет простой и удобный пользовательский интерфейс для управления сотнями учетных записей прокси на базе [Xray-core](https://github.com/XTLS/Xray-core) и созданный с использованием Python и ReactJS.
-
-## Почему Marzban?
-
-Marzban удобен в использовании, многофункционален и надежен. Он позволяет создавать различные прокси для пользователей без сложной настройки. С помощью встроенного веб-интерфейса можно контролировать, изменять и ограничивать пользователей.
-
-### Функции
-
-- Готовый **Web UI**
-- **REST API** бэкэнд
-- Поддержка [**множества узлов**](#marzban-node) (для распределения инфраструктуры и масштабируемости)
-- Поддержка протоколов **Vmess**, **VLESS**, **Trojan** и **Shadowsocks**
-- Возможность активации **нескольких протоколов** для каждого пользователя
-- **Несколько пользователей** на одном inbound
-- **Несколько inbound** на **одном порту** (поддержка fallbacks)
-- Ограничения на основе **количества трафика** и **срока действия**
-- Ограничение трафика по **периодам** (например выдавать трафик на день, неделю и т. д.)
-- Поддержка **ссылок-подписок** совместимых с **V2ray** _(такие как V2RayNG, OneClick, Nekoray, и др.)_, **Clash** и **ClashMeta**
-- Автоматическая генерация **Ссылок** и **QRcode**
-- Мониторинг ресурсов сервера и **использования трафика**
-- Настраиваемые конфигурации xray
-- Поддержка **TLS** и **REALITY**
-- Встроенный **Telegram Bot**
-- Встроенный **Command Line Interface (CLI)**
-- **Несколько языков**
-- Поддержка **Нескольких администраторов** (WIP)
-
-# Руководство по установке
-
-Выполните быструю установку с помощью следующей команды:
-
-```bash
-sudo bash -c "$(curl -sL https://github.com/Gozargah/Marzban-scripts/raw/master/marzban.sh)" @ install
-```
-
-Когда установка будет завершена:
-- Вы увидите логи, которые можно остановить, нажав `Ctrl+C` или закрыв терминал.
-- Файлы Marzban будут размещены по адресу `/opt/marzban`.
-- Файл конфигурации будет размещен по адресу `/opt/marzban/.env` (см. [Конфигурация](#конфигурация)).
-- Файлы с данными будут размещены по адресу `/var/lib/marzban`.
-- Вы можете получить доступ к панели управления, введя в адресной строке `http://YOUR_SERVER_IP:8000/dashboard/` (заменив YOUR_SERVER_IP на актуальный IP адрес вашего сервера).
-
-Далее, Вам нужно создать главного администратора для входа в панель управления Marzban, выполнив следующую команду:
-
-```bash
-marzban cli admin create --sudo
-```
-
-Готово! Теперь Вы можете войти, используя данные своей учетной записи.
-
-Для того, чтобы увидеть справочное сообщение от скрипта Marzban, выполните команду:
-
-```bash
-marzban --help
-```
-
-Если Вы хотите запустить проект, используя его исходный код, обратитесь к разделу ниже
-<details markdown="1">
-<summary><h3>Ручная установка</h3></summary>
-
-Установите xray на Ваш сервер.
-
-Вы можете сделать это, используя [Xray-install](https://github.com/XTLS/Xray-install):
-
-```bash
-bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ install
-```
-
-Клонируйте этот проект и установите зависимости (Вам нужен Python >= 3.8):
-
-```bash
-git clone https://github.com/Gozargah/Marzban.git
-cd Marzban
-wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 -
-python3 -m pip install -r requirements.txt
-```
-
-В качестве альтернативы для создания виртуальной среды можно использовать [Python Virtualenv](https://pypi.org/project/virtualenv/).
-
-Затем выполните следующую команду для запуска скрипта миграции базы данных:
-
-```bash
-alembic upgrade head
-```
-
-Если Вы хотите использовать `marzban-cli`, необходимо связать его с файлом в `$PATH`, сделать его исполняемым и установить:
-
-```bash
-sudo ln -s $(pwd)/marzban-cli.py /usr/bin/marzban-cli
-sudo chmod +x /usr/bin/marzban-cli
-marzban-cli completion install
-```
-
-Теперь настало время настройки.
-
-Создайте копию файла `.env.example`, посмотрите его и отредактируйте с помощью текстового редактора,например `nano`.
-
-Возможно, вам захочется изменить учетные данные администратора.
-
-```bash
-cp .env.example .env
-nano .env
-```
-
-> Проверьте раздел [Конфигурации](#конфигурация) для получения большей информации.
-
-В завершение запустите приложение с помощью следующей команды:
-
-```bash
-python3 main.py
-```
-
-Для запуска с помощью linux systemctl (скопируйте файл marzban.service в `/var/lib/marzban/marzban.service`):
-
-```
-systemctl enable /var/lib/marzban/marzban.service
-systemctl start marzban
-```
-
-Для использования с nginx:
-
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location ~* /(dashboard|api|docs|redoc|openapi.json) {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-
- # xray-core ws-path: /
- # client ws-path: /marzban/me/2087
- #
- # All traffic is proxed through port 443, and send to the xray port(2087, 2088 etc.).
- # The '/marzban' in location regex path can changed any characters by yourself.
- #
- # /${path}/${username}/${xray-port}
- location ~* /marzban/.+/(.+)$ {
- proxy_redirect off;
- proxy_pass http://127.0.0.1:$1/;
- proxy_http_version 1.1;
- proxy_set_header Upgrade $http_upgrade;
- proxy_set_header Connection "upgrade";
- proxy_set_header Host $http_host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-
-или:
-
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name marzban.example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location / {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-
-По умолчанию приложение будет запускаться на `http://localhost:8000/dashboard`. Вы можете настроить его, изменив переменные окружения `UVICORN_HOST` и `UVICORN_PORT`.
-</details>
-
-# Конфигурация
-
-> Ниже приведены настройки, которые можно задать с помощью переменных окружения поместив их в файл `.env`.
-
-| Перменная | Описание |
-| --------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| SUDO_USERNAME | Имя пользователя главного администратора |
-| SUDO_PASSWORD | Пароль главного администратора |
-| SQLALCHEMY_DATABASE_URL | Путь к файлу БД ([SQLAlchemy's docs](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls)) |
-| UVICORN_HOST | Привязка приложения к хосту (по умолчанию: `0.0.0.0`) |
-| UVICORN_PORT | Привязка приложения к порту (по умолчанию: `8000`) |
-| UVICORN_UDS | Привязка приложения к UNIX domain socket |
-| UVICORN_SSL_CERTFILE | Адрес файла сертификата SSL |
-| UVICORN_SSL_KEYFILE | Адрес файла ключа SSL |
-| XRAY_JSON | Адрес файла JSON конфигурации Xray. (по умолчанию: `xray_config.json`) |
-| XRAY_EXECUTABLE_PATH | Путь к бинарникам Xray (по умолчанию: `/usr/local/bin/xray`) |
-| XRAY_ASSETS_PATH | Путь к папке с рессурсными файлами для Xray (файлы geoip.dat и geosite.dat) (по умолчанию: `/usr/local/share/xray`) |
-| XRAY_SUBSCRIPTION_URL_PREFIX | Префикс адреса подписки |
-| XRAY_FALLBACKS_INBOUND_TAG | Если вы используете входящее соединение с несколькими резервными вариантами, укажите здесь его тег
-| XRAY_EXCLUDE_INBOUND_TAGS | Теги входящих соединений, которые не требуют управления и не должны быть включены в список прокси
-| CUSTOM_TEMPLATES_DIRECTORY | Путь к папке с пользовательскими шаблонами (по умолчанию: `app/templates`) |
-| CLASH_SUBSCRIPTION_TEMPLATE | Шаблон для создания конфигурации Clash (по умолчанию: `clash/default.yml`) |
-| SUBSCRIPTION_PAGE_TEMPLATE | Шаблон для страницы подписки (по умолчанию: `subscription/index.html`) |
-| HOME_PAGE_TEMPLATE | Шаблон главной страницы (по умолчанию: `home/index.html`) |
-| TELEGRAM_API_TOKEN | Токен Telegram-бота (полученный от [@botfather](https://t.me/botfather)) |
-| TELEGRAM_ADMIN_ID | Числовой идентификатор администратора в Telegram (полученный от [@userinfobot](https://t.me/userinfobot)) |
-| TELEGRAM_PROXY_URL | URL прокси для запуска Telegram-бота (если серверы Telegram заблокированы на вашем сервере). |
-| JWT_ACCESS_TOKEN_EXPIRE_MINUTES | Время истечения срока действия доступного токена в минутах, `0` означает "без истечения срока действия" (по умолчанию: `1440`) |
-| DOCS | Активация документации API по адресам `/docs` и `/redoc`. (по умолчанию: `False`) |
-| DEBUG | Активация режима разработки (development) (по умолчанию: `False`) |
-| WEBHOOK_ADDRESS | Адрес Webhook для отправки уведомлений. Уведомления Webhook будут отправляться, если это значение было установлено |
-| WEBHOOK_SECRET | Webhook secret будет передаваться с каждым запросом в виде `x-webhook-secret` в заголовке (по умолчанию: `None`) |
-| NUMBER_OF_RECURRENT_NOTIFICATIONS | Сколько раз повторять попытку отправки уведомления при обнаружении ошибки (по умолчанию: `3`) |
-| RECURRENT_NOTIFICATIONS_TIMEOUT | Тайм-аут между каждым повторным запросом при обнаружении ошибки в секундах (по умолчанию: `180`) |
-| NOTIFY_REACHED_USAGE_PERCENT | При каком проценте использования отправлять предупреждение (по умолчанию: `80`) |
-| NOTIFY_DAYS_LEFT | Когда отправлять предупреждение об истечении срока действия (по умолчанию: `3`) |
-
-# API
-
-Marzban предоставляет REST API, позволяющий разработчикам программно взаимодействовать с сервисами Marzban. Для просмотра документации по API в Swagger UI или ReDoc установите переменную `DOCS=True` и перейдите по ссылкам `/docs` и `/redoc`.
-
-# Backup
-
-Всегда полезно регулярно создавать резервные копии файлов Marzban, чтобы предотвратить потерю данных в случае системных сбоев или случайного удаления. Ниже приведены шаги для создания резервной копии Marzban:
-
-1. По умолчанию все важные файлы Marzban сохраняются в папке `/var/lib/marzban` (в версиях Docker). Скопируйте весь каталог `/var/lib/marzban` в выбранное вами место резервного копирования, например на внешний жесткий диск или в облачное хранилище.
-2. Кроме того, не забудьте сделать резервную копию файла env, содержащего переменные конфигурации, а также файла конфигурации Xray. Если вы устанавливали Marzban с помощью marzban-scripts (рекомендуемый подход к установке), то env и другие конфигурации должны находиться в каталоге `/opt/marzban/`.
-
-Выполнив эти действия, вы сможете обеспечить резервное копирование всех файлов и данных Marzban, а также переменных конфигурации и конфигурации Xray на случай, если в будущем потребуется их восстановить. Не забывайте регулярно обновлять резервные копии, чтобы поддерживать их в актуальном состоянии.
-
-# Telegram Bot
-
-Marzban поставляется с встроенным ботом Telegram, который может управлять сервером, создавать и удалять пользователей, а также отправлять уведомления. Этот бот можно легко включить, выполнив несколько простых шагов, и он предоставляет удобный способ взаимодействия с Marzban без необходимости каждый раз заходить на сервер.
-
-Чтобы включить Telegram-бота, выполните следующие действия:
-
-1. установите `TELEGRAM_API_TOKEN` в качестве API-токена вашего бота.
-2. установите `TELEGRAM_ADMIN_ID` в качестве цифрового ID вашего Telegram-аккаунта, который вы можете получить от [@userinfobot](https://t.me/userinfobot)
-
-# Marzban CLI
-
-Marzban поставляется с встроенным CLI под названием `marzban-cli`, который позволяет администраторам напрямую взаимодействовать с ним.
-
-Если вы установили Marzban с помощью скрипта установки, то доступ к командам cli можно получить, выполнив команду:
-
-```bash
-marzban cli [OPTIONS] COMMAND [ARGS]...
-```
-
-Для получения дополнительной информации можно ознакомиться с [документацией по Marzban CLI](./cli/README.md).
-
-# Marzban Node
-
-Проект Marzban представляет [Marzban-node](https://github.com/gozargah/marzban-node), который помогает Вам в распределении инфраструктуры. С помощью Marzban-node можно распределить инфраструктуру по нескольким узлам, получив такие преимущества, как высокая доступность, масштабируемость и гибкость. Marzban-node позволяет пользователям подключаться к различным серверам, предоставляя им гибкость в выборе, а не ограничиваться только одним сервером.
-Более подробная информация и инструкции по установке приведены в [официальной документации Marzban-node](https://github.com/gozargah/marzban-node).
-
-
-# Webhook уведомления
-
-Вы можете задать адрес webhook, и Marzban будет отправлять уведомления на этот адрес.
-
-Запросы будут отправляться в виде POST-запроса на адрес, указанный в `WEBHOOK_ADDRESS`, с `WEBHOOK_SECRET` в качестве `x-webhook-secret` в заголовках.
-
-Пример запроса, отправленного Marzban:
-
-```
-Headers:
-Host: 0.0.0.0:9000
-User-Agent: python-requests/2.28.1
-Accept-Encoding: gzip, deflate
-Accept: */*
-Connection: keep-alive
-x-webhook-secret: something-very-very-secret
-Content-Length: 107
-Content-Type: application/json
-
-
-
-Body:
-{"username": "marzban_test_user", "action": "user_updated", "enqueued_at": 1680506457.636369, "tries": 0}
-```
-
-Различные типы действий: `user_created`, `user_updated`, `user_deleted`, `user_limited`, `user_expired`, `user_disabled`, `user_enabled`
-
-# Поддержка
-
-Если вы нашли Marzban полезным и хотели бы поддержать его развитие, вы можете сделать пожертвование в одной из следующих криптовалютных сетей:
-
-- TRON network (TRC20): `TX8kJoDcowQPBFTYHAJR36GyoUKP1Xwzkb`
-- ETH, BNB, MATIC network (ERC20, BEP20): `0xFdc9ad32454FA4fc4733270FCc12ddBFb68b83F7`
-- Bitcoin network: `bc1qpys2nefgsjjgae3g3gqy9crsv3h3rm96tlkz0v`
-- Dogecoin network: `DJAocBAu8y6LwhDKUktLAyzV8xyoFeHH6R`
-- TON network: `EQAVf-7hAXHlF-jmrKE44oBwN7HGQFVBLAtrOsev5K4qR4P8`
-
-Спасибо за поддержку!
-
-# Лицензия
-
-Сделано в [Unknown!] и опубликовано под [AGPL-3.0](./LICENSE).
-
-# Участники
-
-Мы ❤️‍🔥 участников проекта! Если вы хотите внести свой вклад, пожалуйста, ознакомьтесь с нашим [Contributing Guidelines](CONTRIBUTING.md) и не стесняйтесь отправлять запросы на исправление ошибок или сообщить о проблеме. Мы также приглашаем вас присоединиться к нашей группе [Telegram](https://t.me/gozargah_marzban) для получения поддержки.
-
-Проверьте [open issues](https://github.com/gozargah/marzban/issues), чтобы помочь развитию этого проекта.
-
-<p align="center">
-Спасибо всем участникам, благодаря которым Marzban становится лучше:
-</p>
-<p align="center">
-<a href="https://github.com/Gozargah/Marzban/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=Gozargah/Marzban" />
-</a>
-</p>
-<p align="center">
- Made with <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a>
-</p>
diff --git a/README-zh-cn.md b/README-zh-cn.md
deleted file mode 100644
index 408d7ba..0000000
--- a/README-zh-cn.md
+++ /dev/null
@@ -1,340 +0,0 @@
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-dark.png">
- <img width="160" height="160" src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/logo-light.png">
- </picture>
- </a>
-</p>
-
-<h1 align="center"/>Marzban</h1>
-
-<p align="center">
- Unified GUI Censorship Resistant Solution Powered by <a href="https://github.com/XTLS/Xray-core">Xray</a>
-</p>
-
-<br/>
-<p align="center">
- <a href="#">
- <img src="https://img.shields.io/github/actions/workflow/status/gozargah/marzban/build.yml?style=flat-square" />
- </a>
- <a href="https://hub.docker.com/r/gozargah/marzban" target="_blank">
- <img src="https://img.shields.io/docker/pulls/gozargah/marzban?style=flat-square&logo=docker" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/license/gozargah/marzban?style=flat-square" />
- </a>
- <a href="https://t.me/gozargah_marzban" target="_blank">
- <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/badge/twitter-commiunity-blue?style=flat-square&logo=twitter" />
- </a>
- <a href="#">
- <img src="https://img.shields.io/github/stars/gozargah/marzban?style=social" />
- </a>
-</p>
-
-<p align="center">
- <a href="./README.md">
- English
- </a>
- /
- <a href="./README-fa.md">
- فارسی
- </a>
- /
- <a href="./README-zh-cn.md">
- 简体中文
- </a>
- /
- <a href="./README-ru.md">
- Русский
- </a>
-</p>
-
-<p align="center">
- <a href="https://github.com/gozargah/marzban" target="_blank" rel="noopener noreferrer" >
- <img src="https://github.com/Gozargah/Marzban-docs/raw/master/screenshots/preview.png" alt="Marzban screenshots" width="600" height="auto">
- </a>
-</p>
-
-
-## 目录
-- [概览](#概览)
- - [为什么要使用 Marzban?](#为什么要使用-marzban)
- - [特性](#特性)
-- [安装指南](#安装指南)
-- [配置](#配置)
-- [如何使用 API](#如何使用-api)
-- [如何备份 Marzban](#如何备份-marzban)
-- [Telegram bot](#telegram-bot)
-- [捐赠](#捐赠)
-- [许可](#许可)
-- [贡献者](#贡献者)
-
-
-# 概览
-
-Marzban（Marzban一词源自波斯语，意为“边境警卫”，发音为 /mærz'ban/）是一个代理管理工具，提供简单易用的用户界面，可管理数百个代理账户，由 [Xray-core](https://github.com/XTLS/Xray-core) 提供支持，使用 Python 和 Reactjs 构建。
-
-
-
-## 为什么要使用 Marzban?
-
-Marzban 是一个用户友好、功能丰富且可靠的工具。它让您可以为用户创建不同的代理，无需进行任何复杂的配置。通过其内置的 Web 界面，您可以监视、修改和限制用户。
-
-### 特性
-
-- 内置 **Web 界面**
-- 完全支持 **REST API** 的后端
-- 支持 **Vmess**、**VLESS**、**Trojan** 和 **Shadowsocks** 协议
-- 单用户的**多协议**支持
-- 单入站的**多用户**支持
-- 单端口的**多入站**支持（使用 fallbacks）
-- **流量**和**过期日期**限制
-- 周期性的流量限制（例如每天、每周等）
-- 兼容 **V2ray** 的**订阅链接**（例如 V2RayNG、OneClick、Nekoray 等）和 **Clash**
-- 自动化的**分享链接**和**二维码**生成器
-- 系统监控和**流量统计**
-- 可自定义的 xray 配置
-- **TLS** 支持
-- 集成的 **Telegram Bot**
-- **多管理员**支持（WIP）
-
-
-# 安装指南
-Run the following command
-
-```bash
-sudo bash -c "$(curl -sL https://github.com/Gozargah/Marzban-scripts/raw/master/marzban.sh)" @ install
-```
-
-Once the installation is complete:
-
-- You will see the logs that you can stop watching them by closing the terminal or pressing `Ctrl+C`
-- The Marzban files will be located at `/opt/marzban`
-- The configuration file can be found at `/opt/marzban/.env` (refer to [configurations](#configuration) section to see variables)
-- The data files will be placed at `/usr/lib/marzban`
-- 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)
-
-Next, you need to create a sudo admin for logging into the Marzban dashboard by the following command
-
-```bash
-marzban cli admin create --sudo
-```
-
-That's it! You can login to your dashboard using these credentials
-
-To see the help message of the Marzban script, run the following command
-
-```bash
-marzban --help
-```
-
-If you are eager to run the project using the source code, check the section below
-<details markdown="1">
-<summary><h3>手动安装（高级）</h3></summary>
-
-在您的机器上安装 xray
-
-您可以使用 [Xray-install](https://github.com/XTLS/Xray-install) 脚本进行安装：
-
-```bash
-bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ install
-```
-
-克隆项目并安装依赖项。
-
-您需要 Python>=3.8 版本。
-
-```bash
-git clone https://github.com/Gozargah/Marzban.git
-cd Marzban
-wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 -
-python3 -m pip install -r requirements.txt
-```
-
-另外，为了拥有一个隔离的环境，您可以使用 [Python Virtualenv](https://pypi.org/project/virtualenv/)。
-
-然后运行以下命令运行数据库迁移脚本：
-
-```bash
-alembic upgrade head
-```
-
-现在开始配置：
-
-复制 `.env.example` 文件，查看并使用文本编辑器（如`nano`）进行编辑。
-
-您可能想要修改管理员凭据。
-
-```bash
-cp .env.example .env
-nano .env
-```
-
-> 请查看[配置](#配置)部分以获取更多信息。
-
-最终，使用以下命令启动应用程序：
-
-```bash
-python3 main.py
-```
-
-也可使用 linux systemctl 启动：
-```
-systemctl enable /var/lib/marzban/marzban.service
-systemctl start marzban
-```
-
-配合 nginx 使用：
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location ~* /(dashboard|api|docs|redoc|openapi.json) {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-
- # xray-core ws-path: /
- # client ws-path: /marzban/me/2087
- #
- # 所有流量通过 443 端口进行代理，然后分发至真正的 xray 端口（2087、2088 等等）。
- # 路径中的 “/marzban” 可以改为任意合法 URL 字符.
- #
- # /${path}/${username}/${xray-port}
- location ~* /marzban/.+/(.+)$ {
- proxy_redirect off;
- proxy_pass http://127.0.0.1:$1/;
- proxy_http_version 1.1;
- proxy_set_header Upgrade $http_upgrade;
- proxy_set_header Connection "upgrade";
- proxy_set_header Host $http_host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-或
-```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name marzban.example.com;
-
- ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
-
- location / {
- proxy_pass http://0.0.0.0:8000;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
-```
-
-默认情况下，应用将在 `http://localhost:8000/dashboard` 上运行。您可以通过更改 `UVICORN_HOST` 和 `UVICORN_PORT` 环境变量来进行配置。
-</details>
-
-# 配置
-
-> 您可以使用环境变量或将其放置在 `env` 或 `.env` 文件中来设置以下设置。
-
-| 变量 | 描述 |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| SUDO_USERNAME | 管理员用户名（默认: admin） |
-| SUDO_PASSWORD | 管理员密码（默认: admin） |
-| SQLALCHEMY_DATABASE_URL | 数据库文档（[SQLAlchemy's docs](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls)） |
-| UVICORN_HOST | 绑定应用程序到此主机（默认为 `0.0.0.0`） |
-| UVICORN_PORT | 绑定应用程序到此端口（默认为 `8000`） |
-| UVICORN_UDS | 将应用程序绑定到一个 UNIX 域套接字 |
-| UVICORN_SSL_CERTFILE | SSL 证书文件路径 |
-| UVICORN_SSL_KEYFILE | SSL 密钥文件路径 |
-| XRAY_JSON | Xray 的 json 配置文件路径（默认: `xray_config.json`） |
-| XRAY_EXECUTABLE_PATH | Xray 的执行程序路径: `/usr/local/bin/xray`） |
-| XRAY_ASSETS_PATH | Xray 的资源目录: `/usr/local/share/xray`） |
-| XRAY_SUBSCRIPTION_URL_PREFIX | 订阅URL的前缀 |
-| XRAY_FALLBACKS_INBOUND_TAG | 包含 fallbacks 的入站标记, 在您需要使用 fallbacks 配置此项 |
-| XRAY_EXCLUDE_INBOUND_TAGS | 不需要此应用程序管理或在链接中包含的入站标记 |
-| CLASH_SUBSCRIPTION_TEMPLATE | 将用于生成冲突配置的模板（默认值：`clash/default.yml`） |
-| SUBSCRIPTION_PAGE_TEMPLATE | 用于生成订阅信息页面的模板（默认：`subscription/index.html`） |
-| HOME_PAGE_TEMPLATE | 诱饵页面模板（默认：`home/index.html`） |
-| TELEGRAM_API_TOKEN | Telegram bot API 令牌（可以从 [@botfather](https://t.me/botfather) 获取） |
-| TELEGRAM_ADMIN_ID | 管理员的 Telegram ID（可以使用 [@userinfobot](https://t.me/userinfobot) 查找您的 ID） |
-| TELEGRAM_PROXY_URL | 在代理下运行 Telegram bot。 |
-| JWT_ACCESS_TOKEN_EXPIRE_MINUTES | Access Tokens 的过期时间，以分钟为单位，`0` 表示无限期（默认为 `1440` 分钟） |
-| DOCS | API 文档是否应该在 `/docs` 和 `/redoc` 上提供（默认为 `False` |
-| DEBUG | 开发者调试模式（默认: `False`） |
-
-
-# 如何使用 API
-Marzban 提供了 REST API，使开发人员能够以编程方式与 Marzban 服务进行交互。要在 Swagger UI 或 ReDoc 中查看 API 文档，设置配置变量 `DOCS=True`，然后导航到 `/docs` 和 `/redoc`。
-
-
-# 如何备份 Marzban
-
-定期备份 Marzban 文件是预防系统故障或意外删除导致数据丢失的好习惯。以下是备份 Marzban 的步骤：
-
-1. 默认情况下，所有重要的 Marzban 文件都保存在 `/var/lib/marzban` ( Docker 版本)中。将整个 `/var/lib/marzban` 目录复制到您选择的备份位置，比如外部硬盘或云存储。
-2. 此外，请确保备份您的 `env` 文件，其中包含您的配置变量，以及您的 `Xray` 配置文件。
-
-按照这些步骤，您可以确保有备份所有 Marzban 文件和数据，以及您的配置变量和 Xray 配置，以备将来恢复使用。请记得定期更新备份，以保持它们的最新性。
-
-
-# Telegram bot
-
-Marzban 配备了一个集成的 Telegram bot，可以处理服务器管理、用户创建和删除，以及发送通知。通过几个简单的步骤，您可以轻松地启用这个机器人，并提供了一种方便的方式与 Marzban 交互，而不需要每次都登录到服务器上。
-
-启用 Telegram bot：
-
-1. 将 `TELEGRAM_API_TOKEN` 设置为您的 bot API Token。
-2. 将 `TELEGRAM_ADMIN_ID` 设置为您的 Telegram ID，您可以从 [@userinfobot](https://t.me/userinfobot) 中获取自己的 ID。
-
-
-# 捐赠
-
-如果您认为 Marzban 有用，并想支持其发展，可以在以下加密网络之一进行捐赠：
-
-- TRON(TRX) 网络：`TX8kJoDcowQPBFTYHAJR36GyoUKP1Xwzkb`
-- ETH、BNB、MATIC 网络：`0xFdc9ad32454FA4fc4733270FCc12ddBFb68b83F7`
-- 比特币网络：`bc1qpys2nefgsjjgae3g3gqy9crsv3h3rm96tlkz0v`
-- Dogecoin 网络：`DJAocBAu8y6LwhDKUktLAyzV8xyoFeHH6R`
-- TON 网络：`EQAVf-7hAXHlF-jmrKE44oBwN7HGQFVBLAtrOsev5K4qR4P8`
-
-
-感谢您的支持！
-
-# 许可
-
-制作于 [Unknown!] 并在 [AGPL-3.0](./LICENSE) 下发布。
-
-# 贡献者
-
-我们热爱贡献者！如果您想做出贡献，请查看我们的[贡献指南](CONTRIBUTING.md)并随时提交拉取请求或打开问题。我们也欢迎您加入我们的 [Telegram](https://t.me/gozargah_marzban) 群组，以获得支持或贡献指导。
-
-查看 [issues](https://github.com/gozargah/marzban/issues) 以帮助改进这个项目。
-
-
-
-<p align="center">
-感谢所有为改善 Marzban 做出贡献的贡献者们：
-</p>
-<p align="center">
-<a href="https://github.com/Gozargah/Marzban/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=Gozargah/Marzban" />
-</a>
-</p>
-<p align="center">
- Made with <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a>
-</p>
-