Konfiguráció (appsettings.json)

Konfiguráció (appsettings.json)

Ezen az oldalon

Az induláshoz szükséges beállítások az alkalmazás mappájában lévő appsettings.json fájlban vannak (Dockerben a /app/appsettings.json helyre csatolva). A fájl megjegyzésekkel van ellátva. Azok a beállítások, amelyeket a rendszergazdák futás közben módosítanak, az App Konfiguráció oldalon találhatók (Alkalmazás konfiguráció).

  • A környezeti változók felülírják a fájlt. A szakaszok közé __ kerül, a tömbelemekhez __0, __1, például ConnectionStrings__InternalDb, HttpSettings__Urls__0, Serilog__MinimumLevel__Default.
  • Az időtartamok formátuma n.óó:pp:mm, például 60.00:00:00 60 nap.
  • Az alkalmazás minden induláskor, biztonsági másolat (appsettings.json.backup.<időbélyeg>) után hozzáadja az új kiadás által bevezetett beállításokat az alapértékükkel. A meglévő értékek megmaradnak. Írásvédett fájlhoz nem nyúl; ilyenkor az új beállítások a memóriában az alapértéküket használják.
  • A fájl módosítása után indítsa újra az alkalmazást. Minden szerveren ugyanazokat az értékeket használja.
Induláskor a környezeti változók felülírják az appsettings.json fájlt; az App Konfiguráció beállításai az adatbázisban vannak, és futás közben jutnak el minden szerverre.

Belső adatbázis#

jsonc
"ConnectionStrings": {
  "InternalDbType": 0,          // 0 SQLite | 1 SQL Server | 2 PostgreSQL | 3 MySQL
  "InternalDb": "Data Source=database.db;",
  "Schema": "",                 // SQLite és MySQL esetén üresnek kell maradnia
  "MySqlServerVersion": "8.0.28" // csak MySQL-hez
}

Kapcsolati karakterlánc példák:

Típus Kapcsolati karakterlánc
SQLite (0) Data Source=database.db;
SQL Server (1) Data Source=host;Initial Catalog=database;User id=user;Password=...;Connection Timeout=60;Encrypt=false;
PostgreSQL (2) Server=host;Port=5432;Database=worksmarthub;User id=user;Password=...;
MySQL (3) Server=host;Port=3306;Database=worksmarthub;Uid=user;Pwd=...;

Az adatbázist az alkalmazás induláskor létrehozza és migrálja. Ha a fájl az újabb InternalDatabaseSettings szakaszt használja, az elsőbbséget élvez a ConnectionStrings szakasszal és annak környezeti változóival szemben.

Cache#

CacheSettings.Type: InMemory (alapértelmezett, csak egy szerverhez), Redis (több szerverhez ajánlott, a RedisCacheSettings.Configuration beállítással), SqlServer, Postgres vagy MySql (egy tábla az adott adatbázisban), illetve None (OAuth mellett nem támogatott).

Nyilvános cím (PublicBaseUrl)#

Az a cím, amelyen a felhasználók megnyitják az alkalmazást, az esetleges útvonal-előtaggal együtt, például https://wsh.example.com/. Ebből készülnek azok a hivatkozások, amelyek az aktuális kérésen kívül is használatosak: az e-mailekben lévő hivatkozások (jelszó-visszaállítás, leiratkozás, az alkalmazásra mutató hivatkozás az értesítésekben, a háttérfolyamatok leveleiben is), a későbbi e-mailekhez eltárolt hivatkozások és a mobilaktiváló QR-kódban szereplő cím. Ha üres, ezek a hivatkozások az egyes kérések címéből készülnek, amelyet a kérés küldője befolyásolhat; az alkalmazás ilyenkor minden induláskor SECURITY: figyelmeztetést naplóz. Minden olyan telepítésen állítsa be, amelyet mások is elérnek.

Figyelési cím#

HttpSettings.Urls (alapérték http://localhost:5000). Ha ugyanazon a gépen fordított proxy áll előtte, hagyja az alapértéken. Külső kapcsolatok fogadásához http://+:5000 (portonként egy bejegyzés). Dockerben a HttpSettings__Urls__0=http://+:8080 beállítás kell. IIS alatt nem használt. Ez a szakasz csak a JSON fájlból, a parancssorból vagy környezeti változóból jöhet. A HttpSettings.Cors a más eredetről (origin) érkező hozzáférést szabályozza (csak akkor kell, ha egy másik webes eredetről hívják böngészőből az API-t).

Aláíró kulcsok#

Három kulcs írja alá a tokeneket és a hivatkozásokat. A kiadott fájlban nyilvánosan ismert alapértékek vannak; az első használat előtt mindegyiket cserélje le egy-egy különböző, hosszú, véletlenszerű értékre (például openssl rand -base64 48), amely minden szerveren azonos:

Beállítás Mit ír alá
LoginSettings.JwtAuthenticationSettings.SymmetricSecurityKey A bejelentkezési tokeneket és a személyes hozzáférési tokeneket. Az alapértékkel bárki hamisíthatna tokent. A módosítása minden munkamenetet és tokent érvénytelenít.
TicketAttachment.DownloadLink.SymmetricSecurityKey A mellékletek letöltési hivatkozásait
ImageConfiguration.ImageLink.SymmetricSecurityKey A komponensképek hivatkozásait

A két hivatkozás-aláíró kulcs későbbi módosítása érvényteleníti az addig feltöltött összes fájl hivatkozását. Amíg valamelyik kulcs a gyári értéken van, az alkalmazás induláskor SECURITY: figyelmeztetést naplóz.

Bejelentkezés#

A UserSettings.UserStore és a LoginSettings.AuthType határozza meg, honnan jönnek a felhasználók és hogyan jelentkeznek be; lásd: Hitelesítési lehetőségek. További bejelentkezési beállítások:

Beállítás Alapérték Jelentés
LoginSettings.SessionDuration 60.00:00:00 A munkamenet hossza, használat közben meghosszabbodik
LoginSettings.PasswordResetLinkDuration 30.00:00:00 A jelszó-visszaállító hivatkozások érvényessége
LoginSettings.CookieAuthenticationSettings.SecureCookie true Éles telepítésen true értéken kell maradnia (HTTPS)

E-mail (SMTP)#

Az EmailSettings szakaszt azok az e-mailek használják, amelyek nem értesítési csatornán mennek ki: az ügyfeleknek szóló levelek, a jelszó-visszaállítás, az új felhasználók adatai, a tétlenségi emlékeztetők, a készlet- és a szolgáltatásfelhasználói figyelmeztetések.

jsonc
"EmailSettings": {
  "SmtpHost": "smtp.example.com",
  "SmtpPort": 587,
  "SslEnabled": true,
  "SmtpUser": "...",
  "SmtpPassword": "...",
  "Timeout": 20,
  "FromEmail": "noreply@example.com",
  "FromName": "WorkSmartHub"
}

Feltöltések és képek#

Beállítás Alapérték Jelentés
TicketAttachment.UploadChunkSize 25mb A mellékletfeltöltés darabmérete. A fordított proxynak legalább ekkora kéréseket el kell fogadnia.
TicketAttachment.DownloadLink.TokenExpiration 3650 nap A mellékletek hivatkozásainak élettartama
ImageConfiguration.ImageChunkSize 25mb A képfeltöltés darabmérete
ImageConfiguration.MaxWidthHeight_Large/Medium/Small 512 / 256 / 128 A tárolt komponensképek méretei
ImageConfiguration.MaxPixels 40000000 A legnagyobb elfogadott kép

Naplózás#

A Serilog.WriteTo a konzolos és a fájlos naplózást írja le (Logs/log-.txt, naponta egy fájl). A fájlos naplózást hagyja bekapcsolva: a Naplófájlok oldal ezeket olvassa. Minimális szintek: Serilog:MinimumLevel:Default, valamint a Microsoft és System felülírások (beállítás nélkül Information), vagy az App Konfiguráció → Log Szintek felülírása.

Egyéb beállítások#

Beállítás Jelentés
Swagger.Enabled Be- (alapértelmezés) vagy kikapcsolja a Swagger felületet a /swagger címen (API használat)
UseDetailedExceptions A kezeletlen hibák részletei bekerülnek az API válaszaiba
ConfigSync.Enabled, ConfigSync.IntervalSettings.Interval Milyen gyakran veszik át a szerverek az App Konfiguráció módosításait (10 mp)
Notifications.Teams.ServiceUrl A Microsoft Teams szolgáltatás végpontja

A fájl védelme#

Az appsettings.json tartalmazza az aláíró kulcsokat és a kapcsolati jelszavakat. Csak a rendszergazdák és az alkalmazás fiókja olvashassa. Az erről és az adatbázisról készült mentések is titkos adatokat tartalmaznak (Frissítés, mentés és visszaállítás).

Nem találta, amit keresett?

Írjon nekünk, vagy foglaljon időpontot. Válaszolunk a funkciókkal, a telepítéssel és a licenceléssel kapcsolatos kérdésekre.

Kapcsolat