From 2c6b5a7ce296b97226899e7036d2c4ae3b4fb6b6 Mon Sep 17 00:00:00 2001 From: ospab Date: Thu, 18 Jun 2026 02:25:21 +0300 Subject: [PATCH] docs: update docs for v0.3.1, add FAQ, remove ostp-control mentions --- CONTRIBUTING.md | 17 ++++------------- CONTRIBUTING.ru.md | 17 ++++------------- README.md | 2 +- README.ru.md | 2 +- ostp-flutter/pubspec.yaml | 2 +- ostp-gui/src-tauri/tauri.conf.json | 2 +- ostp-wiki/configuration_guide.md | 2 +- 7 files changed, 13 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4644468..29a54e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,8 +21,8 @@ By contributing to this project, you agree to abide by our code of conduct and l To build and test OSTP locally, you will need: -* **Rust Toolchain (1.75+)**: Install via [rustup](https://rustup.rs/). -* **Node.js (18+) & npm**: Required to build the frontend control panel (`ostp-control`) and compile Tauri GUI resources. +* **Rust Toolchain**: Install via [rustup](https://rustup.rs/) (stable channel). +* **Node.js (18+) & npm**: Required to compile Tauri GUI resources. * **Git**: For version control. ### Building the Project @@ -33,15 +33,7 @@ To build and test OSTP locally, you will need: cd ostp ``` -2. **Build the control panel frontend**: - ```bash - cd ostp-control - npm install - npm run build - cd .. - ``` - -3. **Build the entire Cargo workspace**: +2. **Build the entire Cargo workspace**: ```bash cargo build ``` @@ -59,8 +51,7 @@ The repository is organized as a Cargo workspace containing the following crates * [`ostp-core/`](file:///d:/ospab-projects/ostp/ostp-core): Core protocol logic, including packet formatting, serialization, selective ACK/NACK (ARQ) state machine, and the Noise protocol (`Noise_NNpsk0_25519_ChaChaPoly_BLAKE2s`) handshake. * [`ostp-client/`](file:///d:/ospab-projects/ostp/ostp-client): Client implementations, including SOCKS5/HTTP local proxies, `tun2socks` integration, native TUN interface routing, and split-tunneling bypass mechanisms. -* [`ostp-server/`](file:///d:/ospab-projects/ostp/ostp-server): Server logic, session dispatcher, anti-probing fallback server proxying, access key database, and the REST API for control panel communication. -* [`ostp-control/`](file:///d:/ospab-projects/ostp/ostp-control): A modern web dashboard for server administration (user management, real-time metrics, bandwidth limits). +* [`ostp-server/`](file:///d:/ospab-projects/ostp/ostp-server): Server logic, session dispatcher, anti-probing fallback server proxying, access key database, and the REST API. * [`ostp-gui/`](file:///d:/ospab-projects/ostp/ostp-gui): Tauri-based desktop GUI application for Windows and Linux. * [`ostp-flutter/`](file:///d:/ospab-projects/ostp/ostp-flutter): Mobile client code for Android platforms. diff --git a/CONTRIBUTING.ru.md b/CONTRIBUTING.ru.md index 4b38904..79cdbb3 100644 --- a/CONTRIBUTING.ru.md +++ b/CONTRIBUTING.ru.md @@ -21,8 +21,8 @@ Для локальной сборки и тестирования OSTP вам понадобятся: -* **Rust Toolchain (1.75+)**: Рекомендуется установить через [rustup](https://rustup.rs/). -* **Node.js (18+) и npm**: Необходимы для сборки веб-панели управления (`ostp-control`) и сборки интерфейса Tauri. +* **Rust Toolchain**: Установите через [rustup](https://rustup.rs/) (stable канал). +* **Node.js (18+) и npm**: Необходимы для сборки интерфейса Tauri. * **Git**: Для контроля версий. ### Сборка проекта @@ -33,15 +33,7 @@ cd ostp ``` -2. **Соберите веб-интерфейс панели управления**: - ```bash - cd ostp-control - npm install - npm run build - cd .. - ``` - -3. **Соберите весь Cargo-workspace**: +2. **Соберите весь Cargo-workspace**: ```bash cargo build ``` @@ -59,8 +51,7 @@ * [`ostp-core/`](file:///d:/ospab-projects/ostp/ostp-core): Базовая логика протокола: форматирование пакетов, сериализация, конечный автомат выборочного подтверждения (ARQ/ACK/NACK) и рукопожатие Noise (`Noise_NNpsk0_25519_ChaChaPoly_BLAKE2s`). * [`ostp-client/`](file:///d:/ospab-projects/ostp/ostp-client): Клиентская часть: локальные SOCKS5/HTTP прокси-серверы, интеграция с драйвером `wintun` / `tun2socks` и реализация раздельного туннелирования для прямого обхода трафика. -* [`ostp-server/`](file:///d:/ospab-projects/ostp/ostp-server): Серверная часть: диспетчеризация сессий, маскировка под классические веб-серверы при активном сканировании, база данных ключей доступа и REST API панели управления. -* [`ostp-control/`](file:///d:/ospab-projects/ostp/ostp-control): Панель администратора (пользователи, статистика трафика в реальном времени, лимиты скорости и объема данных). +* [`ostp-server/`](file:///d:/ospab-projects/ostp/ostp-server): Логика сервера, диспетчер сессий, защита от пробинга, база данных ключей и REST API. * [`ostp-gui/`](file:///d:/ospab-projects/ostp/ostp-gui): Настольное приложение-клиент для Windows и Linux на платформе Tauri. * [`ostp-flutter/`](file:///d:/ospab-projects/ostp/ostp-flutter): Мобильный клиент для платформы Android. diff --git a/README.md b/README.md index a685aeb..717f851 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Download pre-built binaries for your platform from [GitHub Releases](https://git | **Multi-Listener** | Bind to multiple addresses simultaneously (dual-stack IPv4/IPv6, multi-port). | | **TUN Mode** | Full-system VPN via native `smoltcp` network stack without external dependencies. All traffic transparently routed through the tunnel. | | **xHTTP Stealth (UoT)** | UDP-over-TCP tunnel that completely hides traffic. Since all data is fully encrypted and length-prefixed, it bypasses DPI filters that block unknown UDP traffic by riding over a plain TCP connection. | -| **Mobile & Web Apps** | Beautiful cross-platform mobile client (Flutter) and a modern Web Control Panel (React/Vite) for effortless server and client management. | +| **Mobile Apps** | Beautiful cross-platform mobile client (Flutter) for effortless client management. | | **TURN Relay** | RFC 5766 TURN support for environments where direct UDP is blocked. | | **Hot-Reload** | Runtime config reload without restart (access keys, exclusions, mux settings). | | **Structured Logging** | `tracing`-based logging with `RUST_LOG` filtering. JSON/file/syslog output support. | diff --git a/README.ru.md b/README.ru.md index 8bebdd3..847e225 100644 --- a/README.ru.md +++ b/README.ru.md @@ -28,7 +28,7 @@ | **Бесшовный роуминг** | Клиент может менять сети (WiFi ↔ 4G) без разрыва сессии — сервер отслеживает session-ID, а не IP-адрес. | | **TUN-режим** | Полносистемный VPN без внешних зависимостей (встроенный network stack на базе `smoltcp`). | | **xHTTP Стелс (UoT)** | Туннель UDP-over-TCP, который полностью скрывает трафик. Поскольку все данные полностью зашифрованы и имеют префикс длины, он обходит DPI фильтры, блокирующие неизвестный UDP трафик, передавая всё по обычному TCP соединению. | -| **Мобильные и Web приложения** | Красивый кроссплатформенный мобильный клиент (Flutter) и современная Web панель управления (React/Vite) для удобного администрирования. | +| **Мобильные приложения** | Красивый кроссплатформенный мобильный клиент (Flutter) для удобного администрирования. | | **TURN Relay** | RFC 5766 TURN для окружений, где прямой UDP заблокирован. | | **Hot-Reload** | Перезагрузка конфига в рантайме без перезапуска (ключи, исключения, mux, TURN). | | **Кросс-платформа** | Windows, Linux, macOS, Android. Один бинарник, без зависимостей. | diff --git a/ostp-flutter/pubspec.yaml b/ostp-flutter/pubspec.yaml index 869f7be..d88b40c 100644 --- a/ostp-flutter/pubspec.yaml +++ b/ostp-flutter/pubspec.yaml @@ -16,7 +16,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html # In Windows, build-name is used as the major, minor, and patch parts # of the product and file versions while build-number is used as the build suffix. -version: 0.3.2+16 +version: 0.3.4+17 environment: sdk: ^3.11.4 diff --git a/ostp-gui/src-tauri/tauri.conf.json b/ostp-gui/src-tauri/tauri.conf.json index e0305f8..bb85acb 100644 --- a/ostp-gui/src-tauri/tauri.conf.json +++ b/ostp-gui/src-tauri/tauri.conf.json @@ -1,7 +1,7 @@ { "$schema": "https://schema.tauri.app/config/2", "productName": "ostp-gui", - "version": "0.3.3", + "version": "0.3.4", "identifier": "com.ospab.ostp", "build": { "frontendDist": "../src" diff --git a/ostp-wiki/configuration_guide.md b/ostp-wiki/configuration_guide.md index e9d03dd..2da282a 100644 --- a/ostp-wiki/configuration_guide.md +++ b/ostp-wiki/configuration_guide.md @@ -86,7 +86,7 @@ --- ### 3. REST API Управления (`api`) -Используется для интеграции с панелью управления `ostp-control`. +Используется для программного управления сервером и интеграции с внешними панелями. - **`enabled`** (логический): Включение встроенного веб-сервера API. - **`bind`** (строка): Интерфейс и порт для прослушивания (например, `"127.0.0.1:9090"`). - **`token`** (строка): Bearer-токен для авторизации администратора. Автоматически генерируется сервером при команде `ostp --init server`.