Files
Govor/docs/README.md
T
Artemy 632ac04b56 Add forwarding, friend controls, and benefits
Add message forwarding and reply lookup, friend removal and blocking endpoints, and database-backed Govor+ privileges with customizable profile tags. Include migrations, integration tests, and updated API and operations documentation.
2026-10-31 18:29:40 +07:00

40 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Govor — документация сервера
Govor — мессенджер с сервером ASP.NET Core и отдельным клиентом .NET MAUI. Здесь описаны запуск сервера, HTTP API, SignalR, шифрование, восстановление доступа и эксплуатация.
Документация сверена с серверным `master`, коммит `a3401ce`, 30 октября 2026 года. Описанное поведение относится к этой версии; установленный сервер может быть старше. Адреса и секреты в примерах условные.
## С чего начать
| Задача | Раздел |
| --- | --- |
| Запустить API локально | [Быстрый старт](getting-started.md) |
| Подключить собственный клиент | [Путь интеграции](client-integration.md), [карта HTTP API](api-reference.md) |
| Разобраться с входом и токенами | [Аутентификация](endpoints/authentication/README.md) |
| Восстановить историю или сменить пароль | [Пароли и восстановление](password-recovery.md) |
| Понять шифрование | [E2EE](e2ee.md), [API устройств и архивов](endpoints/e2ee.md) |
| Настроить сервер на Timeweb | [VPS](vps-deployment.md) или [App Platform](timeweb-deployment.md) |
| Найти причину ошибки | [Диагностика](diagnostics.md), [частые вопросы](faq.md) |
| Проверить изменения | [Тестирование](testing.md) |
## Возможности
- Регистрация по приглашению, вход с доказательством пароля SRP, access/refresh токены и управление сессиями.
- Друзья, заявки, личные чаты, группы и каналы с отдельными ролями, приглашениями и модерацией.
- История, отправка и редактирование сообщений, прочтение, удаление, реакции и паки.
- E2EE сообщений и вложений, сертификаты устройств, ротация ключей, зашифрованный архив и восстановление по паролю/коду.
- Профили, аватары, присутствие, SignalR-события и очередь push через Firebase.
- PostgreSQL, миграции, Docker и GitHub Actions для развёртывания.
## Что важно знать до интеграции
`userId` — пользователь, `sessionId` — сеанс входа, `chatId` — чат. Для личного сообщения `recipientId` означает **PrivateChat.Id**, а не ID собеседника. `recipientType`: `0` — личный чат, `1` — группа/канал.
HTTP загружает состояние, SignalR передаёт команды и события. После переподключения клиент перечитывает состояние через HTTP. События могут повторяться или пропускаться; push не подтверждает прочтение.
E2EE реализовано прикладным протоколом JOSE. Он не предоставляет forward secrecy, post-compromise security и прозрачность ключей; первая встреча и состав групп доверяют серверу. [Модель доверия](e2ee.md) обязательна к прочтению перед реализацией другого клиента.
В проверке этой ревизии прошли 735 серверных тестов на SQLite. Это не подтверждение доставки Firebase на устройство или состояния production-инсталляции. [Ограничения проверки](testing.md).
Исходный код: [Govor, a3401ce](https://github.com/stalcker2288969/Govor/tree/a3401ceedf30c2eb6167f7ef6e4ae820883d2de2).