mirror of
https://github.com/Govor-team/Govor.git
synced 2026-11-18 05:15:06 +00:00
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.
This commit is contained in:
+40
-33
@@ -1,55 +1,62 @@
|
||||
# Запуск и конфигурация
|
||||
# Быстрый старт
|
||||
|
||||
## Требования
|
||||
|
||||
.NET SDK 10 с корректной feature band, PostgreSQL, доступ к NuGet, файл `libs/SmartRes.dll`, каталог `Govor.API/configs` и Firebase service account в `Govor.API/secrets/firebase-adminsdk.json`.
|
||||
Нужны .NET SDK 10, доступ к NuGet и отдельная PostgreSQL с созданной БД для разработки. `global.json` задаёт SDK `10.0.100` с `rollForward: latestFeature`; подходит установленный SDK `10.0.400`. В репозитории уже есть `libs/SmartRes.dll` и `Govor.API/configs/ban_usernames.json`.
|
||||
|
||||
В `global.json` записана некорректная версия SDK `10.0.0`; замените её в отдельном исправлении на установленную версию, например `10.0.400`. Во время диагностики SDK 10.0.400 всё же собрал отдельный проект API.
|
||||
Firebase для локального запуска не требуется: в `appsettings.json` он выключен. Секреты БД и приложения задаются отдельно.
|
||||
|
||||
## Команды из корня репозитория
|
||||
## 1. Настроить окружение
|
||||
|
||||
PowerShell, из корня серверного репозитория. Подставьте реквизиты своей **локальной** БД. Переменные действуют в текущем терминале.
|
||||
|
||||
```powershell
|
||||
dotnet restore Govor.API/Govor.API.csproj
|
||||
dotnet build Govor.API/Govor.API.csproj --no-restore
|
||||
dotnet ef database update --project Govor.Domain --startup-project Govor.API
|
||||
dotnet run --project Govor.API/Govor.API.csproj
|
||||
$env:ASPNETCORE_ENVIRONMENT = 'Development'
|
||||
$env:ConnectionStrings__GovorDbContext = 'Host=127.0.0.1;Port=5432;Database=govor_dev;Username=postgres;Password=YOUR_LOCAL_PASSWORD'
|
||||
$env:JwtAccessOption__SecretKey = 'local-development-signing-key-change-before-deployment'
|
||||
$env:EncryptionOption__Secret = 'local-development-refresh-secret-change-before-deployment'
|
||||
$env:Firebase__Enabled = 'false'
|
||||
```
|
||||
|
||||
Команда миграции требует установленного инструмента dotnet-ef; она приведена как инструкция и не выполнялась на пользовательской БД. Перед обновлением существующей БД проверьте миграции и резервную копию.
|
||||
Эти строки предназначены для разработки. Для внешнего сервера используйте собственные случайные секреты и HTTPS. [Полный список параметров](configuration.md).
|
||||
|
||||
## Конфигурация
|
||||
## 2. Собрать сервер
|
||||
|
||||
| Ключ / ресурс | Назначение |
|
||||
| --- | --- |
|
||||
| ConnectionStrings:GovorDbContext | PostgreSQL connection string |
|
||||
| JwtAccessOption:SecretKey | Ключ подписи JWT |
|
||||
| JwtAccessOption:Minutes | Срок access token в минутах |
|
||||
| JwtRefreshOption:RefreshTokenLifetimeDays | Срок refresh-сессии |
|
||||
| MessageEditingOptions:Enabled | Применять ли срок редактирования |
|
||||
| MessageEditingOptions:MaxEditTimeMinutes | Срок редактирования; значение класса по умолчанию 15 |
|
||||
| configs/ban_usernames.json | UsernameModeration: BlockedExact, BlockedContains, Reserved |
|
||||
| secrets/firebase-adminsdk.json | Обязательные учётные данные Firebase при старте |
|
||||
| uploads/ | Файлы относительно ContentRootPath |
|
||||
```powershell
|
||||
dotnet --version
|
||||
dotnet restore Govor.Server.slnx
|
||||
dotnet build Govor.Server.slnx -c Release --no-restore
|
||||
```
|
||||
|
||||
Не переносите реальные ключи, пароли и service account в документацию или Git. Не рассчитывайте только на переменные окружения: Program.cs повторно добавляет appsettings.json после стандартных провайдеров, поэтому JSON может перекрыть их значения. Это нужно исправить.
|
||||
Решение включает API, прикладной и доменный слои, контракты и четыре действующих тестовых проекта. Старый консольный клиент в серверное решение не входит.
|
||||
|
||||
Firebase создаётся безусловно. Наличие NullPushProvider не даёт выключить Firebase конфигурацией в текущем DI.
|
||||
## 3. Применить миграции
|
||||
|
||||
## Развёртывание и проверка
|
||||
```powershell
|
||||
dotnet run --project Govor.API/Govor.API.csproj --no-launch-profile -- --migrate-only
|
||||
```
|
||||
|
||||
Dockerfile устарел: использует .NET 8 и ссылается на удалённые Govor.Core/Govor.Data. Solution также ссылается на внешний проект SmartRes. До исправления используйте сборку конкретного API-проекта.
|
||||
Команда применяет ожидающие EF Core миграции и завершается без HTTP API и Firebase. Обычный запуск **не применяет** миграции автоматически. Отдельный `dotnet-ef` для этого способа не нужен. Для существующей БД сначала сделайте резервную копию и изучите [обновление сервера](operations.md).
|
||||
|
||||
HTTPS redirection отключён; TLS и forwarded headers требуют отдельной настройки. SessionKeysController содержит RequireHttps, поэтому HTTP для его методов не подходит.
|
||||
## 4. Запустить и проверить
|
||||
|
||||
`GET /server/ping` — маршрут проверки доступности, но возвращает MVC OkResult из minimal API (предупреждение ASP0004); не считайте его полноценным health check БД и Firebase.
|
||||
```powershell
|
||||
dotnet run --project Govor.API/Govor.API.csproj --launch-profile http
|
||||
```
|
||||
|
||||
Swagger включён во всех окружениях. UseSwagger обслуживает документ через middleware; поздний MapSwagger.RequireAuthorization не является надёжным подтверждением защиты всех Swagger-маршрутов.
|
||||
API: `http://localhost:7155`, Swagger UI: `/swagger`. Для локального HTTPS используйте профиль `https` (`https://localhost:7156`) и доверенный сертификат разработки.
|
||||
|
||||
## Что проверено
|
||||
```powershell
|
||||
Invoke-WebRequest http://localhost:7155/server/ping
|
||||
Invoke-WebRequest http://localhost:7155/server/ready
|
||||
```
|
||||
|
||||
Обновление 24.10.2026: серверные тесты обновлены до .NET 10 и находятся в `tests`. `dotnet test Govor.Server.slnx -c Release` запускает все четыре проекта. Release-сборка и 710 тестов проходят на SQLite и отдельной PostgreSQL с применением миграций. Инструкции и ограничения — в [tests/README.md](../tests/README.md). Production, реальная доставка Firebase и контейнер в рамках этой проверки не запускались.
|
||||
`ping` проверяет процесс. `ready` возвращает `200`, если БД доступна и нет ожидающих миграций, иначе `503`. Они не проверяют Firebase, свободное место и доставку сообщений.
|
||||
|
||||
---
|
||||
Проверено по исходникам на 03.10.2026, commit `4603be9`. Описано текущее поведение; успешная сборка не означает проверку работающего сервера.
|
||||
## 5. Первый аккаунт
|
||||
|
||||
Источник: [Govor.API/Program.cs](https://github.com/Govor-team/Govor/blob/4603be9f714135e0af72d505d17f3d1709834bea/Govor.API/Program.cs).
|
||||
Регистрация требует кода приглашения. Для первого администратора оператор задаёт секрет `InvitationAdmin__Key` и использует `POST /api/admin/InviteUser/InvitationWithKey`: этот метод не требует JWT, но проверяет секрет из тела. Создайте ограниченное по сроку/числу регистраций приглашение с `isAdmin=true`, затем зарегистрируйтесь по полученному коду. [Точные поля и пример](endpoints/admin-and-groups.md).
|
||||
|
||||
Ключ задаётся до запуска API; без него метод возвращает 503. После первоначальной настройки уберите ключ из runtime и перезапустите API, если этот способ больше не нужен. Для обычных приглашений действующий администратор использует защищённый `/Invitation`. Для проверки кода без настройки настоящего аккаунта подходят [изолированные тесты](testing.md).
|
||||
|
||||
Далее: [интеграция клиента](client-integration.md), [вход](endpoints/authentication/README.md), [диагностика](diagnostics.md).
|
||||
|
||||
Reference in New Issue
Block a user