Bump version to v0.5.0

Gozargah · Jul 15, 2024 · 6b59661 · 6b59661
1 parent 4773a44
commit 6b59661
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 103 deletions.
diff --git a/README-fa.md b/README-fa.md
@@ -62,8 +62,8 @@
 
 ## فهرست مطالب
 - [بررسی اجمالی](#بررسی-اجمالی)
-	- [چرا مرزبان؟](#چرا-مرزبان)
-		- [امکانات](#امکانات)
+  - [چرا مرزبان؟](#چرا-مرزبان)
+    - [امکانات](#امکانات)
 - [راهنمای نصب](#راهنمای-نصب)
 - [تنظیمات](#تنظیمات)
 - [استفاده از API](#استفاده-از-api)
@@ -260,14 +260,18 @@ server {
 |                            مدت زمان انقضا توکن دسترسی به پنل مرزبان, `0` به معنای بدون تاریخ انقضا است (پیشفرض: `1440`) |                                           JWT_ACCESS_TOKEN_EXPIRE_MINUTES                                            |
 |                                                       فعال سازی داکیومنتیشن به آدرس `/docs` و `/redoc`(پیشفرض: `False`) |                                                         DOCS                                                         |
 |                                                                     فعالسازی حالت توسعه (development) (پیشفرض: `False`) |                                                        DEBUG                                                         |
-|                                                                                                         WEBHOOK_ADDRESS | آدرس webhook که تغییرات حالت یک کاربر به آن ارسال می‌شوند. اگر این متغیر مقدار داشته باشد، ارسال پیام‌ها انجام می‌شوند. |
-|                                                                                                          WEBHOOK_SECRET |                    متغیری که به عنوان `x-webhook-secret` در header ارسال می‌شود. (پیشفرض: `None`)                     |
+| آدرس webhook که تغییرات حالت یک کاربر به آن ارسال می‌شوند. اگر این متغیر مقدار داشته باشد، ارسال پیام‌ها انجام می‌شوند.    |                                                    WEBHOOK_ADDRESS                                                   |
+|                    متغیری که به عنوان `x-webhook-secret` در header ارسال می‌شود. (پیشفرض: `None`)                        |                                                    WEBHOOK_SECRET                                                    |
 |                             تعداد دفعاتی که برای ارسال یک پیام، در صورت تشخیص خطا در ارسال تلاش دوباره شود (پیشفرض `3`) |                                          NUMBER_OF_RECURRENT_NOTIFICATIONS                                           |
 |                                   مدت زمان بین هر ارسال دوباره پیام در صورت تشخیص خطا در ارسال به ثانیه (پیشفرض: `180`) |                                           RECURRENT_NOTIFICATIONS_TIMEOUT                                            |
 |                                    هنگام رسیدن مصرف کاربر به چه درصدی پیام اخطار به آدرس وبهوک ارسال شود (پیشفرض: `80`) |                                             NOTIFY_REACHED_USAGE_PERCENT                                             |
 |                                          چند روز مانده به انتهای سرویس پیام اخطار به آدرس وبهوک ارسال شود (پیشفرض: `3`) |                                                   NOTIFY_DAYS_LEFT                                                   |
 حذف خودکار کاربران منقضی شده (و بطور اختیاری محدود شده) پس از گذشت این تعداد روز (مقادیر منفی این قابلیت را به طور پیشفرض غیرفعال می کنند. پیشفرض: `-1`) |                                                   USERS_AUTODELETE_DAYS                                                   |
 تعیین اینکه کاربران محدودشده شامل حذف خودکار بشوند یا نه |                                                   USER_AUTODELETE_INCLUDE_LIMITED_ACCOUNTS                                 |
+| فعال کردن کانفیگ سفارشی JSON برای همه برنامه‌هایی که از آن پشتیبانی می‌کنند (پیش‌فرض: `False`)                                                   | USE_CUSTOM_JSON_DEFAULT |
+| فعال کردن کانفیگ سفارشی JSON فقط برای برنامه‌ی V2rayNG (پیش‌فرض: `False`)                                                            | USE_CUSTOM_JSON_FOR_V2RAYNG |
+| فعال کردن کانفیگ سفارشی JSON فقط برای برنامه‌ی Streisand (پیش‌فرض: `False`)                                                          | USE_CUSTOM_JSON_FOR_STREISAND |
+| فعال کردن کانفیگ سفارشی JSON فقط برای برنامه‌ی V2rayN (پیش‌فرض: `False`)                                                             | USE_CUSTOM_JSON_FOR_V2RAYN |
 
 
 # استفاده از API

diff --git a/README-ru.md b/README-ru.md
@@ -62,13 +62,13 @@
 ## Оглавление
 
 - [Введение](#введение)
-	- [Почему Marzban](#почему-marzban)
-		- [Функции](#функции)
+  - [Почему Marzban?](#почему-marzban)
+    - [Функции](#функции)
 - [Руководство по установке](#руководство-по-установке)
 - [Конфигурация](#конфигурация)
 - [API](#api)
 - [Backup](#backup)
-- [Telegram бот](#telegram-bot)
+- [Telegram Bot](#telegram-bot)
 - [Marzban CLI](#marzban-cli)
 - [Marzban Node](#marzban-node)
 - [Webhook уведомления](#webhook-уведомления)
@@ -262,38 +262,44 @@ server {
 
 > Ниже приведены настройки, которые можно задать с помощью переменных окружения поместив их в файл `.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`)                                      |
+| Перменная                                | Описание                                                                                                                       |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| 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`)                                                |
+| USERS_AUTODELETE_DAYS                    | Delete expired (and optionally limited users) after this many days (Negative values disable this feature, default: `-1`)       |
+| USER_AUTODELETE_INCLUDE_LIMITED_ACCOUNTS | Weather to include limited accounts in the auto-delete feature (default: `False`)                                              |
+| USE_CUSTOM_JSON_DEFAULT                  | Enable custom JSON config for ALL supported clients (default: `False`)                                                         |
+| USE_CUSTOM_JSON_FOR_V2RAYNG              | Enable custom JSON config only for V2rayNG (default: `False`)                                                                  |
+| USE_CUSTOM_JSON_FOR_STREISAND            | Enable custom JSON config only for Streisand (default: `False`)                                                                |
+| USE_CUSTOM_JSON_FOR_V2RAYN               | Enable custom JSON config only for V2rayN (default: `False`)                                                                   |
 
 # API