From 8491f5183cb43827c2f899c03504cf4d46cb4a5f Mon Sep 17 00:00:00 2001 From: Samat Gilmanov <113612352+Rightarion@users.noreply.github.com> Date: Mon, 8 Jun 2026 12:39:32 -0400 Subject: [PATCH] Document rate limits as bits per second --- docs/Architecture/API/API.md | 12 ++++++------ docs/Config_params/CONFIG_PARAMS.en.md | 2 +- docs/Config_params/CONFIG_PARAMS.ru.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/Architecture/API/API.md b/docs/Architecture/API/API.md index 9266aad..230cde9 100644 --- a/docs/Architecture/API/API.md +++ b/docs/Architecture/API/API.md @@ -212,8 +212,8 @@ Notes: | `max_tcp_conns` | `usize` | no | Per-user concurrent TCP limit. | | `expiration_rfc3339` | `string` | no | RFC3339 expiration timestamp. | | `data_quota_bytes` | `u64` | no | Per-user traffic quota. | -| `rate_limit_up_bps` | `u64` | no | Per-user upload rate limit in bytes per second. | -| `rate_limit_down_bps` | `u64` | no | Per-user download rate limit in bytes per second. | +| `rate_limit_up_bps` | `u64` | no | Per-user upload rate limit in bits per second. | +| `rate_limit_down_bps` | `u64` | no | Per-user download rate limit in bits per second. | | `max_unique_ips` | `usize` | no | Per-user unique source IP limit. | | `enabled` | `bool` | no | User enable flag. Missing means enabled. `false` persists a disabled override. | @@ -225,8 +225,8 @@ Notes: | `max_tcp_conns` | `usize|null` | no | Per-user concurrent TCP limit; `null` removes the per-user override. | | `expiration_rfc3339` | `string|null` | no | RFC3339 expiration timestamp; `null` removes the expiration. | | `data_quota_bytes` | `u64|null` | no | Per-user traffic quota; `null` removes the per-user quota. | -| `rate_limit_up_bps` | `u64|null` | no | Per-user upload rate limit in bytes per second; `null` removes the upload direction limit. | -| `rate_limit_down_bps` | `u64|null` | no | Per-user download rate limit in bytes per second; `null` removes the download direction limit. | +| `rate_limit_up_bps` | `u64|null` | no | Per-user upload rate limit in bits per second; `null` removes the upload direction limit. | +| `rate_limit_down_bps` | `u64|null` | no | Per-user download rate limit in bits per second; `null` removes the download direction limit. | | `max_unique_ips` | `usize|null` | no | Per-user unique source IP limit; `null` removes the per-user override. | | `enabled` | `bool|null` | no | `false` disables the user. `true` or `null` removes the disabled override, so the user is enabled. | @@ -1217,8 +1217,8 @@ JA3 follows the Salesforce ClientHello field order. JA4 follows the FoxIO TLS-cl | `max_tcp_conns` | `usize?` | Optional max concurrent TCP limit. | | `expiration_rfc3339` | `string?` | Optional expiration timestamp. | | `data_quota_bytes` | `u64?` | Optional data quota. | -| `rate_limit_up_bps` | `u64?` | Optional upload rate limit in bytes per second. | -| `rate_limit_down_bps` | `u64?` | Optional download rate limit in bytes per second. | +| `rate_limit_up_bps` | `u64?` | Optional upload rate limit in bits per second. | +| `rate_limit_down_bps` | `u64?` | Optional download rate limit in bits per second. | | `max_unique_ips` | `usize?` | Optional unique IP limit. | | `current_connections` | `u64` | Current live connections. | | `active_unique_ips` | `usize` | Current active unique source IPs. | diff --git a/docs/Config_params/CONFIG_PARAMS.en.md b/docs/Config_params/CONFIG_PARAMS.en.md index e0af301..8fcb7d8 100644 --- a/docs/Config_params/CONFIG_PARAMS.en.md +++ b/docs/Config_params/CONFIG_PARAMS.en.md @@ -3127,7 +3127,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p ## user_rate_limits - **Constraints / validation**: Table `username -> { up_bps, down_bps }`. At least one direction must be non-zero. - - **Description**: Per-user bandwidth caps in bytes/sec for upload (`up_bps`) and download (`down_bps`). + - **Description**: Per-user bandwidth caps in bits/sec for upload (`up_bps`) and download (`down_bps`). - **Example**: ```toml diff --git a/docs/Config_params/CONFIG_PARAMS.ru.md b/docs/Config_params/CONFIG_PARAMS.ru.md index 39bc2a3..7d473d8 100644 --- a/docs/Config_params/CONFIG_PARAMS.ru.md +++ b/docs/Config_params/CONFIG_PARAMS.ru.md @@ -3123,7 +3123,7 @@ ## user_rate_limits - **Ограничения / валидация**: Таблица `username -> { up_bps, down_bps }`. Должно быть ненулевое значение хотя бы в одном направлении. - - **Описание**: Персональные лимиты скорости по пользователям в байтах/сек для отправки (`up_bps`) и получения (`down_bps`). + - **Описание**: Персональные лимиты скорости по пользователям в битах/сек для отправки (`up_bps`) и получения (`down_bps`). - **Example**: ```toml