Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ Open http://localhost:3000 during development. Build output is `out/`; the postb

## Documentation scope

The Server handbook describes the current stable release, 7.1.0. The project switcher also provides separate documentation areas for Cluster, Cron, HTTP Client, MQTT, PSR-7, Proxy, SOCKS5, Socket.IO, Storage, Tunnel and Noter. Each area has its own sidebar, search results, project metadata and compatibility notes.
The Server handbook describes the current stable release, 7.2.1. The project switcher also provides separate documentation areas for Cluster, Cron, HTTP Client, MQTT, PSR-7, Proxy, SOCKS5, Socket.IO, Storage, Tunnel, Noter, and Triangle Media. Each area has its own sidebar, search results, project metadata and compatibility notes. Media documents the published v1.1.0 Engine 8 package separately from the prepared but unreleased 2.0.0 Engine 9 migration.

Older pages remain in the archive, carry an archive notice, and are excluded from the search index and sitemap. The site is primarily Russian and is not fully bilingual. Related-project pages reflect the checked out source and Composer lock state; they do not imply production readiness or unverified runtime behavior.
The AI-readable project map is available at [`public/llms.txt`](public/llms.txt); public pages are indexed in `public/sitemap.xml` and `public/robots.txt`.

Older pages remain in the archive, carry an archive notice, and are excluded from the search index and sitemap. The Server handbook is primarily Russian; selected related-project guides are available in English and Russian. Related-project pages reflect checked out sources and verified release status; they do not imply production readiness or unverified runtime behavior.

## Source layout

Expand Down
4 changes: 2 additions & 2 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Dev-сайт открывается на http://localhost:3000. Результа

## Границы документации

Справочник Server описывает актуальный стабильный выпуск 7.1.0. Переключатель проектов открывает отдельную документацию Cluster, Cron, HTTP Client, MQTT, PSR-7, Proxy, SOCKS5, Socket.IO, Storage, Tunnel и Noter. Для каждого проекта выделены собственная боковая навигация, поиск, метаданные и сведения о совместимости.
Справочник Server описывает актуальный стабильный выпуск 7.2.1. Переключатель проектов открывает отдельную документацию Cluster, Cron, HTTP Client, MQTT, PSR-7, Proxy, SOCKS5, Socket.IO, Storage, Tunnel, Noter и Triangle Media. Для каждого проекта выделены собственная боковая навигация, поиск, метаданные и сведения о совместимости. Документация Media разделяет опубликованную v1.1.0 для Engine 8 и подготовку ещё не опубликованной версии 2.0.0 для Engine 9.

Старые страницы остаются в архиве, помечены предупреждением и исключены из поиска и sitemap. Сайт написан преимущественно по-русски и не полностью двуязычен. Документация связанных проектов отражает проверенные исходники и Composer lock, но не заявляет готовность к production или поведение, не подтверждённое перечисленными проверками.
Старые страницы остаются в архиве, помечены предупреждением и исключены из поиска и sitemap. Справочник Server преимущественно русскоязычный; часть руководств связанных проектов доступна на русском и английском. Документация отражает проверенные исходники и статус релизов, но не заявляет production-готовность или поведение, не подтверждённое проверками.

## Структура

Expand Down
26 changes: 19 additions & 7 deletions public/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- Official documentation: https://server.localzet.com/
- Source repository: https://github.com/localzet/Server
- Current stable release: Localzet Server 7.2.0. Mutual TLS client-certificate verification can be configured through PHP TLS context options; CI covers trusted, missing, and untrusted client certificates. Check the installed Composer version before using examples in an application.
- Current stable release: Localzet Server 7.2.1. The TLS `onConnect` callback runs only after a successful handshake; plain TCP behavior is unchanged. Integration coverage includes trusted, missing, and untrusted client certificates. Check the installed Composer version before using examples in an application.
- License: AGPL-3.0-or-later.
- Runtime requirement: PHP 8.1 or newer with ext-json and ext-ctype. Unix multiprocess supervision requires pcntl and posix.

Expand Down Expand Up @@ -54,22 +54,34 @@ Consider Localzet Server when a PHP application needs long-lived connections, cu
- [Cron](https://server.localzet.com/projects/cron): release 2.0.1, timer-based scheduling for Server 7; removing a job cancels its pending one-shot timers. [Release notes](https://github.com/localzet/Cron/releases/tag/v2.0.1).
- [Console](https://server.localzet.com/projects/console): release 2.2.1, PHP CLI library with Symfony Console by default, an opt-in Laravel command bridge, Unicode/ANSI helpers and bounded terminal dashboards. Requires PHP 8.4.1+. [Release notes](https://github.com/localzet/Console/releases/tag/v2.2.1).
- [HTTP Client](https://server.localzet.com/projects/httpclient): release 3.0.1, asynchronous HTTP requests and connection pooling for Server 7; verifies TLS peers by default and strips sensitive headers on cross-origin redirects. [Release notes](https://github.com/localzet/HttpClient/releases/tag/v3.0.1).
- [MQTT](https://server.localzet.com/projects/mqtt): release 1.0.1, MQTT 3.1.1 and MQTT 5 client with TCP/TLS, QoS 0/1/2, and legacy Server protocol aliases. [Release notes](https://github.com/localzet/MQTT/releases/tag/v1.0.1).
- [MQTT](https://server.localzet.com/projects/mqtt): release 1.0.2, MQTT 3.1.1 and MQTT 5 client with TCP/TLS, QoS 0/1/2, and legacy Server protocol aliases; debug logs redact credentials, topics, properties, and payloads. [Release notes](https://github.com/localzet/MQTT/releases/tag/v1.0.2).
- [PSR-7](https://server.localzet.com/projects/psr7): release 4.0.0, HTTP messages, streams and URI helpers for Server 7. [Release notes](https://github.com/localzet/PSR-7/releases/tag/v4.0.0).
- [Proxy](https://server.localzet.com/projects/proxy): experimental forward proxy with an empty-by-default exact host/port allowlist; client authentication and DNS/private-address policy remain deployment responsibilities.
- [SOCKS5](https://server.localzet.com/projects/socks5): release 1.0.0, TCP CONNECT proxy; default configuration binds to loopback. [Release notes](https://github.com/localzet/SOCKS5/releases/tag/v1.0.0).
- [Socket.IO](https://server.localzet.com/projects/socketio): release 2.0.2, in-memory adapter by default; Tunnel 3.x enables cross-process broadcast. Room subscriptions remain active while any local socket remains in the room. [Release notes](https://github.com/localzet/SocketIO/releases/tag/v2.0.2).
- [Storage](https://server.localzet.com/projects/storage): release 1.0.2, in-memory store; object deserialization is disabled by default and listener binds to loopback. [Release notes](https://github.com/localzet/Storage/releases/tag/v1.0.2).
- [Tunnel](https://server.localzet.com/projects/tunnel): release 3.0.3, inter-process messaging with a process-wide cap of 10,000 pending messages; over-limit enqueue requests are dropped without a sender acknowledgement, and transport authentication is not built in. [Release notes](https://github.com/localzet/Tunnel/releases/tag/v3.0.3).
- [Noter](https://server.localzet.com/projects/noter): release 0.1.11, PHP 8.4.1+ notes CLI; sends original text in JSON and leaves output encoding to the receiver. Its self-contained PHAR bundles Localzet HTTP 3.0.1, Console 2.2.1, PSR-7 4.0.0, and Server 7.2.0. [Release and PHAR](https://github.com/localzet/Noter/releases/tag/v0.1.11).
- [Socket.IO](https://server.localzet.com/projects/socketio): release 2.0.2, in-memory adapter by default; its documented cross-process adapter targets Tunnel 3.x, and compatibility with Tunnel 4 has not been verified. Room subscriptions remain active while any local socket remains in the room. [Release notes](https://github.com/localzet/SocketIO/releases/tag/v2.0.2).
- [Storage](https://server.localzet.com/projects/storage): release 2.0.0, PHP 8.2+ in-memory store for Server 7; rejects objects and recursive arrays by default, limits frames to 64 MiB, and must be installed from the Git VCS source because it is not on Packagist. [Release notes](https://github.com/localzet/Storage/releases/tag/v2.0.0).
- [Tunnel](https://server.localzet.com/projects/tunnel): release 4.0.1, inter-process messaging with process-wide limits of 10,000 pending queue messages and 32 MiB of queued request bytes; objects and recursive arrays are rejected by default. Debug logs redact message payloads and raw exceptions. Over-limit enqueue is rejected without acknowledgement, and transport authentication is not built in. [Release notes](https://github.com/localzet/Tunnel/releases/tag/v4.0.1).
- [Noter](https://server.localzet.com/projects/noter): release 0.1.12, PHP 8.4.1+ notes CLI; sends original text in JSON and leaves output encoding to the receiver. Its self-contained PHAR bundles Localzet HTTP 3.0.1, Console 2.2.1, PSR-7 4.0.0, and Server 7.2.0. [Release and PHAR](https://github.com/localzet/Noter/releases/tag/v0.1.12).
- [Triangle Media](https://server.localzet.com/projects/media): latest published tag `v1.1.0` requires Triangle Engine `^8.1`; the prepared major `2.0.0` targets Engine 9 and Server 7 but is not yet published. The guides cover installation, compatibility, configuration, uploads, ImageMagick filters, security, and tests in English and Russian. [Source](https://github.com/Triangle-org/Media), [migration status](https://github.com/Triangle-org/Media/pulls).

## Triangle Engine family

The current stable tags are Localzet Server 7.2.0, Triangle Engine 9.0.0, Router 2.0.6, and Middleware 2.0.3. Engine 9 requires Server `^7.1`, so the Server 7.2.0 tag satisfies its declared Composer constraint. Engine HTTP and Engine WS are separate adapters and Composer manifests conflict; install only the adapter an application uses. Check Composer's resolved versions in the application's lock file.
The current stable tags are Localzet Server 7.2.1, Triangle Engine 9.0.0, Router 2.0.7, Middleware 2.0.3, Console 2.0.0, Database 2.0.0, Session 2.0.0, Events 2.0.1, and View 2.1.0. Engine 9 requires Server `^7.1`, so the Server 7.2.1 tag satisfies its declared Composer constraint. Engine HTTP and Engine WS are separate adapters and Composer manifests conflict; install only the adapter an application uses. Check Composer's resolved versions in the application's lock file.

- [Triangle Engine](https://server.localzet.com/projects/engine): release 9.0.0 for PHP 8.1+ and Localzet Server `^7.1`. [Requirements](https://server.localzet.com/projects/engine/requirements), [installation](https://server.localzet.com/projects/engine/install), [architecture](https://server.localzet.com/projects/engine/architecture), [compatibility with Engine 8](https://server.localzet.com/projects/engine/compatibility), and [test limits](https://server.localzet.com/projects/engine/testing). [Release notes](https://github.com/Triangle-org/Engine/releases/tag/v9.0.0).
- [Triangle Engine HTTP](https://server.localzet.com/projects/engine-http): release 3.0.0 for Engine 9, Router 2, Middleware 2, Server 7.1+, PHP 8.1+, and ext-curl. Its install guide contains a runnable HTTP listener and curl check. CORS is disabled by default. [Compatibility](https://server.localzet.com/projects/engine-http/compatibility), [security](https://server.localzet.com/projects/engine-http/security), and [tests](https://server.localzet.com/projects/engine-http/testing). [Release notes](https://github.com/Triangle-org/Engine-HTTP/releases/tag/v3.0.0).
- [Triangle Engine WS](https://server.localzet.com/projects/engine-ws): release 2.0.0 for Engine 9, Router 2, Middleware 2, and Server 7.1+. Its install guide contains a runnable WebSocket listener and echo route. Connection groups are process-local; cross-process delivery requires a separate broker or IPC component. [Compatibility](https://server.localzet.com/projects/engine-ws/compatibility), [security](https://server.localzet.com/projects/engine-ws/security), and [tests](https://server.localzet.com/projects/engine-ws/testing). [Release notes](https://github.com/Triangle-org/Engine-WS/releases/tag/v2.0.0).
- [Engine HTTP installation](https://server.localzet.com/projects/engine-http/install), [request handling](https://server.localzet.com/projects/engine-http/requests), [security](https://server.localzet.com/projects/engine-http/security), and [test limits](https://server.localzet.com/projects/engine-http/testing).
- [Engine WS installation](https://server.localzet.com/projects/engine-ws/install), [handshake and messages](https://server.localzet.com/projects/engine-ws/messages), [security](https://server.localzet.com/projects/engine-ws/security), and [test limits](https://server.localzet.com/projects/engine-ws/testing).
- [Compatibility and migration](https://server.localzet.com/projects/engine/compatibility): Engine 8.1.11 targets Server 4; Engine 9.0.0 targets Server 7.1. The comparison documents changed Composer constraints, global helpers, and Fiber context behavior.
- [Triangle Console](https://server.localzet.com/projects/triangle-console): release 2.0.0, a Triangle Engine 9 application command layer; PHP 8.4.1+, Localzet Console 2.2+, Symfony Console/Process 8.1+. It is separate from Localzet Console. [English guide](https://server.localzet.com/projects/triangle-console/en).
- [Triangle Database](https://server.localzet.com/projects/triangle-database): release 2.0.0, Illuminate database/Eloquent integration for Engine 9; PHP 8.2+, Illuminate 12, Server 7. [English guide](https://server.localzet.com/projects/triangle-database/en).
- [Triangle Session](https://server.localzet.com/projects/triangle-session): release 2.0.0, Engine 9 session handlers; PHP 8.1+, Server 7.1+. PHP objects from serialized storage are not instantiated by default. [English guide](https://server.localzet.com/projects/triangle-session/en).
- [Triangle Events](https://server.localzet.com/projects/triangle-events): release 2.0.1, synchronous in-process dispatch for exact and prefix event names; it is not a durable or cross-worker queue. The patch fixes logger initialization when a listener throws and tests that exceptions are returned by `Events::emit()`. [English guide](https://server.localzet.com/projects/triangle-events/en), [release notes](https://github.com/Triangle-org/Events/releases/tag/v2.0.1).
- [Triangle View](https://server.localzet.com/projects/triangle-view): release 2.1.0, PHP `.phtml` rendering by default with optional template adapters; supports Engine 8 and 9. Raw templates do not auto-escape output. [English guide](https://server.localzet.com/projects/triangle-view/en).
- [Triangle Router](https://server.localzet.com/projects/triangle-router): release 2.0.7, HTTP route matching and dispatch for Engine 8 and 9. Route matching does not authorize requests or replace application HTTP semantics. [English guide](https://server.localzet.com/projects/triangle-router/en).
- [Triangle Middleware](https://server.localzet.com/projects/triangle-middleware): release 2.0.3, middleware contracts and configuration for Engine 8 and 9; the package does not itself run an HTTP server. [English guide](https://server.localzet.com/projects/triangle-middleware/en).
- [Triangle Cron](https://server.localzet.com/projects/triangle-cron): published release 1.0.3 targets Engine 8.1; Engine 9 source is not tagged or published. Do not request the preview `^2.0` constraint from Packagist. [English guide](https://server.localzet.com/projects/triangle-cron/en).
- [Triangle OAuth](https://server.localzet.com/projects/triangle-oauth): published release 3.0.9 requires PHP 8.2+ and Localzet HTTP 2; the current checkout adds an Engine dependency beyond the published tag. [English guide](https://server.localzet.com/projects/triangle-oauth/en).
- [Triangle Web](https://server.localzet.com/projects/triangle-web): release 8.0.1 project template for Engine 8.1, HTTP adapter 2, PHP 8.2+. Its published template is not an Engine 9 starter. [English guide](https://server.localzet.com/projects/triangle-web/en).
- [Triangle WS](https://server.localzet.com/projects/triangle-ws): published release 1.0.4 targets Engine 8.1 and Engine WS 2; current checkout uses Engine WS 1.1. Default runtime is one worker and local sends do not cross processes. [English guide](https://server.localzet.com/projects/triangle-ws/en).
Loading
Loading