Referentie

Instellingen van de images

Beide images worden ingesteld via omgevingsvariabelen. De namen van de API gebruiken een dubbele underscore tussen niveaus, zoals Smtp__Host. Een instelling die je weglaat, behoudt haar standaardwaarde. De starterkits op Hosten met Docker, Hosten op Kubernetes en Hosten op AKS stellen al alles in wat een normale installatie nodig heeft; deze pagina is er om er een te wijzigen, of voor een eigen opstelling (De images draaien).

API: databases

InstellingWat het doet
ConnectionStrings__DefaultConnectionDe database waarin de data van de standaardwerkruimte staat, zoals Host=postgres;Database=omnicore-db;Username=archestack;Password=.... Verplicht.
ConnectionStrings__CoreDe metadata van de standaardwerkruimte: entiteiten, pagina's, scripts. Database omnicore-core. Verplicht.
ConnectionStrings__IdentityGebruikers, werkruimtes en sleutels, gedeeld door elke werkruimte. Database omnicore-identity. Verplicht.
ConnectionStrings__KeycloakAlleen bij het overzetten van gebruikers uit Keycloak. Laat het anders leeg.
ConnectionStrings__ClusterHoe meerdere API-instanties elkaar over wijzigingen inlichten. Standaard de identitydatabase; zet het op PostgreSQL zelf wanneer er een connection pooler zoals PgBouncer tussen zit.
Database__CreateMissingtrue maakt de datadatabase aan wanneer die ontbreekt; de andere twee worden hoe dan ook aangemaakt. Standaard false; de kits zetten true.

De gebruiker in deze strings heeft het recht nodig om databases aan te maken: elke nieuwe werkruimte krijgt er twee van zichzelf, genoemd naar de basisnamen hierboven.

API: adressen

InstellingWat het doet
ASPNETCORE_URLSWaar de API luistert in de container: http://+:8080.
ASPNETCORE_ENVIRONMENTAltijd Production. Al het andere toont foutdetails aan iedereen.
Http__PathBaseHet pad waaronder de API bediend wordt, zoals /archestack. Leeg op de root.
Identity__AppBaseUrlHet adres van de builder, zoals https://apps.example.com/archestack. Links in uitnodigingen en wachtwoordresets wijzen hierheen.
ForwardedHeaders__TrustedProxiesDe adressen van de proxy's ervoor, waarvan X-Forwarded-For geloofd wordt. De standaard dekt privénetwerken; zonder de juiste lijkt elke bezoeker de proxy en delen ze allemaal één rate limit.
Tenancy__HostSuffixBedient elke werkruimte op een eigen hostnaam, <label>.<suffix>, en laat werkruimtes eigen domeinen toevoegen. Standaard leeg.

API: aanmelden

InstellingWat het doet
Identity__ProviderBuiltin: Archestack meldt mensen zelf aan. Standaard.
Identity__InitialAdminEmail, Identity__InitialAdminPasswordDe eerste admin, aangemaakt bij de eerste start wanneer er nog geen gebruiker is. Eén keer gebruikt: wijzig het wachtwoord daarna in Archestack. Laat beide weg om de admin in plaats daarvan in de builder aan te maken.
Identity__AllowCompanySignuptrue laat iedereen een eigen bedrijf aanmaken op /register. Standaard false. De admins van een bedrijf kunnen scripts op de server draaien, dus laat het uit tenzij je een openbare dienst draait.
Identity__AccessTokenMinutesHoe lang een aanmeldtoken meegaat voordat het vernieuwd wordt. Standaard 15.
Identity__RefreshTokenDaysHoe lang iemand aangemeld blijft zonder Archestack te gebruiken. Standaard 30.
Identity__MinimumPasswordLengthStandaard 8.
Identity__MaxFailedLogins, Identity__LockoutMinutesNa zoveel foute wachtwoorden wordt een account zo lang vergrendeld. Standaard 10 en 15.

API: mail

InstellingWat het doet
Smtp__Host, Smtp__Port, Smtp__UseSslDe mailserver voor uitnodigingen en wachtwoordresets. Standaard poort 587 en SSL. Zonder host krijgt de admin die een uitnodiging verstuurt de link om door te geven.
Smtp__Username, Smtp__PasswordDe aanmeldgegevens van de mailserver.
Smtp__From, Smtp__FromNameDe afzender die die mails tonen.

De mail die applicaties versturen, gaat via de mailaccounts die elke werkruimte in haar builder instelt.

API: bestanden en back-ups

InstellingWat het doet
Files__DirectoryWaar uploads en bestanden van werkruimtes terechtkomen, zoals /files. Zet er een volume: in een container zonder volume gaan bestanden verloren bij de volgende update.
Files__MaxFileBytesHet grootste afzonderlijke bestand. Standaard 100 MB.
Files__MaxWorkspaceBytesHoeveel één werkruimte mag bewaren. Standaard 0, geen limiet.
Backup__DirectoryWaar back-ups terechtkomen, zoals /backups. Ook een volume, en kopieer wat daar belandt ook ergens anders naartoe.
Backup__RetentionDaysHoe lang back-ups bewaard worden. Standaard 30.
Backup__CronScheduleWanneer de nachtelijke back-up draait, als Quartz-cron. Standaard 0 0 3 * * ?, 03:00.

API: schaal en limieten

InstellingWat het doet
Realtime__EntityChangesfalse zorgt ervoor dat schermen niet meer verversen wanneer een record elders wijzigt. Standaard true. Uitgeschakeld bedient één installatie veel meer mensen tegelijk; zie Capaciteit en dimensionering.
Cluster__EnabledLaat meerdere API-instanties als één werken. Standaard true; laat het aan.
RateLimiting__EnabledLimieten op verzoeken per aanroeper. Standaard true. De limieten gelden per API-instantie.
RateLimiting__PermitsPerMinuteVerzoeken die één persoon per minuut mag doen. Standaard 2000.
RateLimiting__AuthPermitsPerMinuteAanmeldpogingen per minuut vanaf één adres. Standaard 20.
RateLimiting__PublicPagePermitsPerMinuteWat een bezoeker zonder account per minuut van openbare pagina's mag vragen. Standaard 240.
Scripting__TypedData__EnabledBusiness entities als getypeerde sets in scripts (Db.Order). Standaard true.

API: sleutels

InstellingWat het doet
DataProtection__CertificatePath, DataProtection__CertificatePasswordEen certificaat dat de sleutels beschermt waarmee opgeslagen wachtwoorden versleuteld zijn. Zonder certificaat staan die sleutels onbeschermd in de identitydatabase, dus een kopie van die database bevat beide helften.
Push__VapidPublicKey, Push__VapidPrivateKey, Push__SubjectEén sleutelpaar voor browsermeldingen op elke werkruimte. Weggelaten maakt elke werkruimte haar eigen. Wijzig het nooit meer zodra mensen meldingen hebben toegestaan: hun abonnementen werken dan niet meer.

API: monitoring

InstellingWat het doet
Observability__EnabledVerstuurt traces, metrics en logs via OpenTelemetry. Standaard false.
Observability__OtlpEndpointWaarnaartoe, zoals http://otel-collector:4317.
Observability__Instance, Observability__EnvironmentGeeft deze installatie een naam in de dashboards.

De web-image

InstellingWat het doet
VITE_API_URLHet adres van de API zoals de browser het bereikt, zoals https://api.example.com. Leeg wanneer de API op hetzelfde adres onder /api staat.
BASE_PATHHet pad waaronder de image bediend wordt, zoals /archestack. Leeg op de root.
VITE_UI_MODEdashboard toont de builder op / en de gepubliceerde app onder /app. kiosk toont de gepubliceerde app op /, voor een adres dat alleen de app is.
VITE_DASHBOARD_URLMet kiosk, het adres van de builder wanneer die op een andere hostnaam staat.
VITE_APP_URLMet dashboard, het adres van de gepubliceerde app wanneer die op een andere hostnaam staat.
API_INTERNAL_URLHet adres van de API binnen het netwerk, zoals http://api:8080. Linkvoorbeelden in chatapps en de pagina's die zoekmachines lezen, komen daarvandaan. Schrijf in Kubernetes de volledige naam van de service, http://<service>.<namespace>.svc.cluster.local:8080.

De PostgreSQL-image

InstellingWat het doet
POSTGRES_USER, POSTGRES_PASSWORDDe gebruiker waarmee de API verbinding maakt. Het wachtwoord wordt ingesteld wanneer PostgreSQL voor het eerst start op een lege schijf; de variabele later wijzigen, wijzigt het niet in de database.
POSTGRES_DBpostgres. De API maakt zijn eigen databases aan.
PGDATAAlleen op een verse schijf waarvan de root lost+found bevat, zoals in Kubernetes: een map onder het koppelpunt, zoals /var/lib/postgresql/data/pgdata.

Geef de container 1 GB gedeeld geheugen, zoals De images draaien uitlegt.