diff --git a/.dockerignore b/.dockerignore index f407ec7..bbdf077 100644 --- a/.dockerignore +++ b/.dockerignore @@ -8,3 +8,5 @@ **/secrets **/appsettings.Development.json artifacts +**/*.env +**/*.env.* diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..872ab64 --- /dev/null +++ b/.env.example @@ -0,0 +1,7 @@ +# Runtime variables for Timeweb App Platform. This file contains no real secrets. +ASPNETCORE_ENVIRONMENT=Production +ASPNETCORE_HTTP_PORTS=8080 +Firebase__Enabled=false +ConnectionStrings__GovorDbContext=Host=;Port=5432;Database=default_db;Username=gen_user;Password=;SSL Mode=VerifyFull;Root Certificate=/app/certs/postgres-ca.crt +JwtAccessOption__SecretKey= +EncryptionOption__Secret= diff --git a/.gitignore b/.gitignore index 03dfe2d..e7df860 100644 --- a/.gitignore +++ b/.gitignore @@ -47,6 +47,9 @@ appsettings.*.json logs/ uploads/ secrets/ +.env +.env.* +!.env.example ## Папки для публикации publish/ diff --git a/Govor.API/Govor.API.csproj b/Govor.API/Govor.API.csproj index efc281e..38d5ae4 100644 --- a/Govor.API/Govor.API.csproj +++ b/Govor.API/Govor.API.csproj @@ -4,6 +4,7 @@ disable enable net10.0 + govor-api-742b3993-52cf-4b70-81db-df98b99374ce @@ -37,6 +38,7 @@ + diff --git a/Govor.API/Program.cs b/Govor.API/Program.cs index 86f58fc..cff9cb5 100644 --- a/Govor.API/Program.cs +++ b/Govor.API/Program.cs @@ -21,6 +21,20 @@ builder.AddLogger();// Serilog builder.Configuration.AddJsonFile("configs/ban_usernames.json", optional: false, reloadOnChange: true); +if (!builder.Environment.IsDevelopment()) +{ + if (string.IsNullOrWhiteSpace(configuration.GetConnectionString(nameof(GovorDbContext)))) + throw new InvalidOperationException("Set ConnectionStrings__GovorDbContext in the application runtime environment."); + + if (!migrateOnly) + { + if (Encoding.UTF8.GetByteCount(configuration["JwtAccessOption:SecretKey"] ?? "") < 32) + throw new InvalidOperationException("Set JwtAccessOption__SecretKey to a private key of at least 32 bytes."); + if (string.IsNullOrWhiteSpace(configuration["EncryptionOption:Secret"])) + throw new InvalidOperationException("Set EncryptionOption__Secret in the application runtime environment."); + } +} + if (!migrateOnly && configuration.GetValue("Firebase:Enabled", true)) { @@ -169,6 +183,21 @@ app.MapControllers(); app.MapGet("/server/ping", () => Results.Ok()); +app.MapGet("/server/ready", async (GovorDbContext db, CancellationToken cancellationToken) => +{ + try + { + if (!await db.Database.CanConnectAsync(cancellationToken) || + (await db.Database.GetPendingMigrationsAsync(cancellationToken)).Any()) + return Results.StatusCode(StatusCodes.Status503ServiceUnavailable); + return Results.Ok(); + } + catch (Exception) when (!cancellationToken.IsCancellationRequested) + { + return Results.StatusCode(StatusCodes.Status503ServiceUnavailable); + } +}); + app.MapHub("/hubs/chats", options => options.CloseOnAuthenticationExpiration = true); app.MapHub("/hubs/friends", options => options.CloseOnAuthenticationExpiration = true); app.MapHub("/hubs/profiles", options => options.CloseOnAuthenticationExpiration = true); diff --git a/Govor.API/Properties/launchSettings.json b/Govor.API/Properties/launchSettings.json index bdcb24a..b00f3fe 100644 --- a/Govor.API/Properties/launchSettings.json +++ b/Govor.API/Properties/launchSettings.json @@ -5,7 +5,7 @@ "commandName": "Project", "dotnetRunMessages": true, "launchBrowser": false, - "applicationUrl": "http://0.0.0.0:8080;http://localhost:7155", + "applicationUrl": "http://localhost:7155", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } @@ -14,7 +14,7 @@ "commandName": "Project", "dotnetRunMessages": true, "launchBrowser": true, - "applicationUrl": "https://0.0.0.0:8080;", + "applicationUrl": "https://localhost:7156;http://localhost:7155", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } diff --git a/Govor.API/appsettings.Development.json b/Govor.API/appsettings.Development.json index 0ee7820..7141b02 100644 --- a/Govor.API/appsettings.Development.json +++ b/Govor.API/appsettings.Development.json @@ -1,23 +1,8 @@ { "Logging": { "LogLevel": { - "Default": "Information", - "Microsoft.AspNetCore": "Warning" + "Microsoft.AspNetCore": "Warning", + "Default": "Information" } - }, - "ConnectionStrings": { - "GovorDbContext": "Host=77.233.214.72;Port=5432;Database=default_db;Username=gen_user;Password=_H1@?S-{~DLb}@;" - }, - "UseMySql": false, - "AllowedHosts": "*", - "JwtAccessOption": { - "SecretKey": "Q89eY7zP7C4+TqLmHF4kw9xkF1E8Ru4Zpg+up9wFt9g=", - "Minutes": 10 - }, - "JwtRefreshOption": { - "RefreshTokenLifetimeDays": 30 - }, - "EncryptionOption": { - "Secret": "8B2j9kkw9xP5m7nQwE2zY3A-=Q8zP7C4+TqLZpg" } } diff --git a/Govor.API/appsettings.json b/Govor.API/appsettings.json index 4f44a02..e49b90c 100644 --- a/Govor.API/appsettings.json +++ b/Govor.API/appsettings.json @@ -6,22 +6,25 @@ } }, "ConnectionStrings": { - "GovorDbContext": "Host=77.233.214.72;Port=5432;Database=default_db;Username=gen_user;Password=_H1@?S-{~DLb}@;" + "GovorDbContext": "" }, "UseMySql": false, "AllowedHosts": "*", "JwtAccessOption": { - "SecretKey": "Q89eY7zP7C4+TqLmHF4kw9xkF1E8Ru4Zpg+up9wFt9g=", + "SecretKey": "", "Minutes": 10 }, "JwtRefreshOption": { "RefreshTokenLifetimeDays": 30 }, "EncryptionOption": { - "Secret": "8B2j9kkw9xP5m7nQwE2zY3A-=Q8zP7C4+TqLZpg" + "Secret": "" }, "MessageEditingOptions": { "Enabled": true, "MaxEditTimeMinutes": 15 + }, + "Firebase": { + "Enabled": false } } diff --git a/Govor.API/certs/postgres-ca.crt b/Govor.API/certs/postgres-ca.crt new file mode 100644 index 0000000..f411ee5 --- /dev/null +++ b/Govor.API/certs/postgres-ca.crt @@ -0,0 +1,27 @@ +-----BEGIN CERTIFICATE----- +MIIEqTCCAxGgAwIBAgIURrz1bzHoED7eWQfikj3tGxR3/MkwDQYJKoZIhvcNAQEL +BQAwgYMxCzAJBgNVBAYTAlJVMRkwFwYDVQQIDBBTYWludC1QZXRlcnNidXJnMRkw +FwYDVQQHDBBTYWludC1QZXRlcnNidXJnMRYwFAYDVQQKDA1UaW1ld2ViIENsb3Vk +MSYwJAYDVQQDDB1tYW5hZ2VkLXNlcnZpY2UudGltZXdlYi5jbG91ZDAeFw0yNTA1 +MjAxMjIyNDVaFw00MDA1MTYxMjIyNDVaMIGDMQswCQYDVQQGEwJSVTEZMBcGA1UE +CAwQU2FpbnQtUGV0ZXJzYnVyZzEZMBcGA1UEBwwQU2FpbnQtUGV0ZXJzYnVyZzEW +MBQGA1UECgwNVGltZXdlYiBDbG91ZDEmMCQGA1UEAwwdbWFuYWdlZC1zZXJ2aWNl +LnRpbWV3ZWIuY2xvdWQwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCh +1DLVEy6fHyfqwLj2o24wXedeuOQ4L+hBIvDIWPL/4CRhTd6xVrlCzC+50otIaowZ +3IneM1/y4m4EC8zv15ViMzBJVnvkbWI3o8hcD1VrykRU42ZyWiVSizYpQW77Bti5 +FXZQwaLfBbDeuvgOLFDJBDPwz2dSojf1BTz7Om+zLQdeQ+yDzfvwwXSkrDbGxBz4 +uG9MHgSwA291wkNz/QONBLRQVYCL9RV4aoNJcedDJE5Bdlf9cJrJfHod5PR7+aLZ +ACfg74D6QMnmK5ITkqY83pTZTBqIGcp7HR/NKr+vX6EYFHJGX1zSyHMdg4mzLa0q +CjmZPNXYwhl2V7alDgyfT3xK0U88wB5kEab/+WV+hlDPLiIiLJL+NkzpNEczBcz9 +TuilfbhGtg9EYMbIgX/57Vv/HtEK7Wxuv9GLAZCqghVuHfSXXT+Yo7nrSjm5cqbI +sQavUU12/26pMehTOzvs0ZRusjGFfmYkAPScVFs3uJSUtKg5VXkNlKNaWobLbF8C +AwEAAaMTMBEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAYEAR5Xy ++bOYqW1khzbtq1PPW89cyYVpdpfOqBaHZlM8AhXek53y9I6kVYX1FxHyTJUqRib/ +5WSQYa2cSQwT+yRWqvH9mdW6L+h6dDdHYHskKVrnSYhIkC2GsHGaT6zyykqYeBKt +n8ld3WZSbUXuku1/dI75pj/vHHcjoxKYD5U4W5DlvlDynBCE7TKZSVrZrXUGamDY +GS8PzIBWgk8EgbjNMMF8raHRbUXluJ5aTU5hx/7HFC5F5BM/l8NTZD3OYjqzLFzB +bR0XeckS6uJuXhAgScMQAC0jQCCrYxOj6EYZQ0e155kp1a6Qjm5ZotTWcpZft+sL +79v24ujuOm7cNmXMeaSoHZZol/j73T/2lI/ZeP22TygJWtvPNBGzS36RhZ5xj3Mp +XVCo3+JK2zJoFwV1L+GeiLdwlOFE22JW/qQ8kCqdYAemTQaZqVLbCfdj2VNHdiXD +FEwHd3k3L3bF2QCp4a0g5IBX9eadhhaSjOx/8pTTp7eocXX0gsKQMqf749km +-----END CERTIFICATE----- diff --git a/Govor.API/secrets/firebase-adminsdk.json b/Govor.API/secrets/firebase-adminsdk.json deleted file mode 100644 index 7595b9b..0000000 --- a/Govor.API/secrets/firebase-adminsdk.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "type": "service_account", - "project_id": "govor-ad008", - "private_key_id": "dc49ff3b29359c0e65ee9c1c1e0e4e825928e16b", - "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDFUuoGpZxXiEVN\nBlfWCUEnwjyev+rcPb2oMo1jKcKJh24/cHfaToThEMO6G53CpatpoB2/TFSE3hxM\ncjSy/wmCngAmqy8xKaVeg8YL4jxLlHVormgPzP1Dmoe77YSEItf7RlR13tyNzXgj\ncHHvfaaDCffwLsUF7vTleNS9w9CF03+8VfjfT2Ggu7WChpsxWrF5EUboWltNIAbQ\nmOBWCnWRbas/sMA5ijKpcg2g8f6Xj2OdUeK+229xgtBFogMgS3/U54WCKCQtDSQo\nP7a1w93nFzL3bMs7lACKBkb00VnzSQN/FoHyQRoQrwlkr309u8ZRAK142m4yFugR\nSYnDnnXRAgMBAAECggEAIPvyKLhIQQ2DYBO+XQXhAU9jqLm1/ajIajRBFCFn5mtg\nD3SyZCiZ57FQtmxlW6Mr2xUrw81zl141ZsX0bzNYmJ/msJAO7G3kub7XPSdNIukn\nEx+MP4/pigJrzAsxCpF0fwlLlwRw47dD7NCgCwN68Q6ahmibAJnoD++5yBrSYXwk\n7a1nJQhNg5AWnXSk8vCxFyhrKzMa0yh0BtWYeMVY74rSNIlvgkw8dzZEuLdnRn7f\nL4jUbyHmCIiSGt5VLTs273YqOrN5t5UW8lJUCdL8wOMJH01uWJVzKjrRLmhp3fKp\n6NZHyLpaPWbkKo0X6+PQV84RUl5+0/CkJ469G5Zz0QKBgQDtjDmsKxXoa0i1tgRq\nEnZd4WU1aEf22zcm+nWODQoFEDFYAJLGabqTuPo1oJVEo8DeQiSRUaao+ac4HHd5\nhnieTJzD12CgLSwVwy6pJN2Sbiw0sa36V7m3s+0kqPyyv+ybFbGJR3C3IAO8c0F5\nJc0bDReXNXJs/dw1fF/GMaT4BQKBgQDUptBbUojRzR5yzhdvmAqsWVBFG0Em3QAN\nKg/9GVuhKQahc7RHom+JLEYeFVgThohyXyA7iAZ0k1Mnubxa0+KIq5NqdauIsflA\n4lZ4zLjOemUjp2OAMumYvXfoAqaKfvHx8iovfTgehf1bWdtSbKwKXCJEK/7Xtw69\nU5PqommsXQKBgQCalzkpHFkDil4lMzEoPp+ddQPCf/zlX8BCs5gxO7cbmHAkTys1\nyLTNUgIzSDAcHV10xyK5F6QYL3BtickO4z439q/Gm7GcTAl2mDETjpRLqTtHh6Ir\nW0/Xh1Z7FyZsxY4bV0DUkBOAeWs1BuTDDKCwTBLgKr4uw/69KBXEC6bKaQKBgQDP\n/SilaaBws9MoLvM1Ltyhnemo7fNXc6jtN0rUHs1EX8Agge6+cd3tqOQb4Hx4/IjQ\ndMIt9+l4c/BNVpknrT5QtqBE7DqORKSqFbbGCFZpfcUWjk3/wcxAnHB++LizlV5H\narhgInWVRTB8/PJLOAc9SsgpLW7gxicgfnKad6gr8QKBgAQIQEC9HPzdFikoxOmW\nlOYaWqDl2P294C2ESGv8ti6Boxx9PsE8k2CrFYXensvk5b4+vV9XTe67PTZ2ZGJS\nLkN77+iDbP8zCysnDWyxCAwJeEmK/eVvBtMA7Juzf3ikF5FxmwXPvSRY4oPd+2cs\neejPkHyvPWNRrZryc5e+9dSJ\n-----END PRIVATE KEY-----\n", - "client_email": "firebase-adminsdk-fbsvc@govor-ad008.iam.gserviceaccount.com", - "client_id": "115697205969744490044", - "auth_uri": "https://accounts.google.com/o/oauth2/auth", - "token_uri": "https://oauth2.googleapis.com/token", - "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", - "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-fbsvc%40govor-ad008.iam.gserviceaccount.com", - "universe_domain": "googleapis.com" -} diff --git a/docs/timeweb-deployment.md b/docs/timeweb-deployment.md index 9ef1db4..982cc1b 100644 --- a/docs/timeweb-deployment.md +++ b/docs/timeweb-deployment.md @@ -1,61 +1,77 @@ -# Deployment to Timeweb App Platform +# Развёртывание Govor в Timeweb App Platform -Use the repository root as the build context and select the **Dockerfile** framework. -The Dockerfile publishes the API and starts `dotnet Govor.API.dll`, listening on port 8080. -Set the health check path to `/server/ping` and use the technical HTTPS domain from the dashboard. +## Настройки и секреты -## Runtime variables +appsettings.json содержит общие параметры без паролей. launchSettings.json действует +только локально: HTTP localhost:7155, HTTPS localhost:7156. Timeweb собирает Dockerfile +из корня репозитория. Контейнер слушает HTTP 8080; HTTPS клиентов обеспечивает Timeweb. -- `ASPNETCORE_ENVIRONMENT=Production` -- `ASPNETCORE_HTTP_PORTS=8080` -- `ConnectionStrings__GovorDbContext=Host=;Port=5432;Database=;Username=;Password=` -- `JwtAccessOption__SecretKey=` -- `EncryptionOption__Secret=` -- `Firebase__Enabled=true` -- `Firebase__CredentialsJson=` (a secret runtime variable) +Локальные секреты находятся в .NET User Secrets проекта Govor.API вне Git и +автоматически загружаются в Development. Это локальный JSON, а не зашифрованное +хранилище. Управлять им можно через Rider → Manage User Secrets. -Alternatively, mount the service-account file and set `Firebase__CredentialsPath` or -`GOOGLE_APPLICATION_CREDENTIALS` to its container path. Relative paths are resolved -against the API content root. Never put credentials into the image or Git repository. -Replace any Firebase private key that was previously committed to a public repository. +В Timeweb задайте переменные окружения только этого приложения, без флажка +«Сохранить как глобальную». Имена есть в .env.example: -Use the database private address only if the application is connected to the same -Timeweb private network. Use the database TLS settings supplied by Timeweb; do not -disable certificate validation. Keep existing encryption secrets when migrating -an existing database, because changing them can make existing encrypted values unreadable. +- ASPNETCORE_ENVIRONMENT=Production +- ASPNETCORE_HTTP_PORTS=8080 +- Firebase__Enabled=false +- ConnectionStrings__GovorDbContext — строка подключения с новым паролем +- JwtAccessOption__SecretKey — случайный закрытый ключ не короче 32 байт +- EncryptionOption__Secret — закрытый HMAC-ключ для refresh-токенов -## Apply migrations +Переменные окружения переопределяют appsettings. Двойное подчёркивание обозначает +вложенный параметр: ConnectionStrings__GovorDbContext → ConnectionStrings:GovorDbContext. +Не помещайте секреты в Dockerfile, аргументы сборки или Git. Пустые обязательные +секреты в Production останавливают сервер с указанием имени настройки. -First check the target database and back up existing data. The latest group migration -removes a legacy column, consolidates duplicate memberships and removes orphan rows. +## PostgreSQL и TLS -Run this command **inside the deployed container/network**, with the same database -runtime variable as the API: +Используйте домен из GovorDB → Подключение и сертификат Timeweb: + +```text +Host=<домен-БД>;Port=5432;Database=default_db;Username=gen_user;Password=<новый-пароль>;SSL Mode=VerifyFull;Root Certificate=/app/certs/postgres-ca.crt +``` + +Публичный CA находится в Govor.API/certs/postgres-ca.crt и включён в образ. +Локально укажите абсолютный путь к этому файлу. После включения TLS дождитесь +доступности домена в DNS; не отключайте проверку сертификата. + +Приватный IP работает при общей приватной сети приложения и БД — публичный IP +БД тогда не нужен. Для приложения без этой сети используйте публичное подключение +с TLS и firewall с учётом адресов приложения и разработчика. Мобильный клиент +обращается к API по HTTPS, а не непосредственно к PostgreSQL. + +## Миграции + +Перед обновлением существующей БД проверьте назначение подключения и сделайте бэкап. +Миграция групп удаляет старую колонку и очищает дубли/осиротевшие записи. +Запускайте из контейнера с теми же переменными окружения: ```sh dotnet Govor.API.dll --migrate-only ``` -This applies pending EF Core migrations and exits without starting the HTTP server -or push worker. Firebase credentials are not required for this command. A failure -returns a nonzero exit status; do not start the deployment until it succeeds. -The normal API startup does not automatically modify the database schema. +Команда применяет только отсутствующие миграции и завершает процесс. HTTP и push +не запускаются; Firebase не нужен. Ошибка возвращает ненулевой код. Обычный запуск +не меняет схему. При запуске опубликованного сервера на компьютере передайте +настройки через окружение: User Secrets в Production не загружаются. -If using EF tooling from the source checkout instead, use version 10.x: +## Проверка -```sh -dotnet ef database update --project Govor.Domain --startup-project Govor.API -``` +- Путь проверки Timeweb: /server/ping. HTTP 200 означает, что API запущен. +- /server/ready возвращает 200, когда доступна БД и нет неприменённых миграций, + либо 503 без реквизитов подключения при проблемах БД/схемы. +- Затем проверьте вход и SignalR по HTTPS/WSS. +- Для uploads требуется постоянное хранилище: пересоздание контейнера может удалить файлы. -For EF tooling, set `Firebase__Enabled=false` in the tooling process only, or supply -valid Firebase credentials. The database must be reachable from that process. +## Ранее опубликованные ключи -## Verify +Удаление значения из файла не удаляет его из истории Git. Смените опубликованные +пароль PostgreSQL и JWT-ключ. Смена EncryptionOption:Secret делает старые refresh-токены +недействительными и требует повторного входа; этот параметр не шифрует сообщения. +Отзовите опубликованный ключ Firebase в Google Cloud, даже если Firebase отключён. -Confirm that the app log reports `Now listening on: http://[::]:8080` (or an equivalent -8080 listener) and has no database errors. Request `https:///server/ping` and -expect HTTP 200. Then check an authenticated API request and SignalR connections. -An HTTP ping alone does not verify database schema or Firebase delivery. - -The API stores media under `uploads` on disk. Configure persistent storage before -relying on uploads surviving container replacement. +Чтобы вернуть push позже, выпустите новый ключ вне репозитория и задайте +Firebase__Enabled=true вместе с Firebase__CredentialsJson либо Firebase__CredentialsPath +к смонтированному файлу. Старый ключ использовать нельзя.