Referência

Definições das imagens

Ambas as imagens são configuradas através de variáveis de ambiente. Os nomes da API usam um duplo underscore entre níveis, como Smtp__Host. Uma definição omitida mantém o seu valor predefinido. Os kits iniciais de Alojamento com Docker, Alojamento no Kubernetes e Alojamento no AKS já definem tudo o que uma instalação normal precisa; esta página serve para alterar uma, ou para uma configuração própria (Executar as imagens).

API: bases de dados

DefiniçãoO que faz
ConnectionStrings__DefaultConnectionA base de dados onde vivem os dados do espaço de trabalho predefinido, como Host=postgres;Database=omnicore-db;Username=archestack;Password=.... Obrigatória.
ConnectionStrings__CoreOs metadados do espaço de trabalho predefinido: entidades, páginas, scripts. Base de dados omnicore-core. Obrigatória.
ConnectionStrings__IdentityUtilizadores, espaços de trabalho e chaves, partilhados por todos os espaços de trabalho. Base de dados omnicore-identity. Obrigatória.
ConnectionStrings__KeycloakSó ao migrar utilizadores a partir do Keycloak. Caso contrário, deixe-a vazia.
ConnectionStrings__ClusterComo várias instâncias da API se avisam umas às outras de alterações. Por predefinição, a base de dados identity; defina-a para o próprio PostgreSQL quando houver um connection pooler como o PgBouncer pelo meio.
Database__CreateMissingtrue cria a base de dados dos dados quando falta; as outras duas são criadas de qualquer forma. Predefinição false; os kits definem true.

O utilizador nestas strings precisa do direito de criar bases de dados: cada novo espaço de trabalho recebe duas próprias, com nomes derivados dos nomes base acima.

API: endereços

DefiniçãoO que faz
ASPNETCORE_URLSOnde a API escuta dentro do contentor: http://+:8080.
ASPNETCORE_ENVIRONMENTSempre Production. Qualquer outro valor mostra detalhes dos erros a qualquer pessoa.
Http__PathBaseO caminho sob o qual a API é servida, como /archestack. Vazio na raiz.
Identity__AppBaseUrlO endereço do builder, como https://apps.example.com/archestack. As ligações de convite e de reposição de palavra-passe apontam para aqui.
ForwardedHeaders__TrustedProxiesOs endereços dos proxies à frente, cujo X-Forwarded-For é aceite. A predefinição cobre as redes privadas; sem o valor certo, todos os visitantes parecem ser o proxy e partilham um só rate limit.
Tenancy__HostSuffixServe cada espaço de trabalho num hostname próprio, <label>.<suffix>, e permite aos espaços de trabalho acrescentar domínios próprios. Vazio por predefinição.

API: início de sessão

DefiniçãoO que faz
Identity__ProviderBuiltin: o Archestack inicia a sessão das pessoas por si. Predefinição.
Identity__InitialAdminEmail, Identity__InitialAdminPasswordO primeiro admin, criado no primeiro arranque quando ainda não há nenhum utilizador. Usadas uma só vez: depois altere a palavra-passe no Archestack. Omita ambas para criar o admin no builder.
Identity__AllowCompanySignuptrue permite a qualquer pessoa criar uma empresa própria em /register. Predefinição false. Os admins de uma empresa podem correr scripts no servidor, por isso deixe-a desligada, a menos que gira um serviço público.
Identity__AccessTokenMinutesQuanto tempo dura um token de sessão antes de ser renovado. Predefinição 15.
Identity__RefreshTokenDaysQuanto tempo uma pessoa fica com a sessão iniciada sem usar o Archestack. Predefinição 30.
Identity__MinimumPasswordLengthPredefinição 8.
Identity__MaxFailedLogins, Identity__LockoutMinutesDepois deste número de palavras-passe erradas, uma conta fica bloqueada durante este tempo. Predefinições 10 e 15.

API: email

DefiniçãoO que faz
Smtp__Host, Smtp__Port, Smtp__UseSslO servidor de email para convites e reposições de palavra-passe. Porta 587 e SSL por predefinição. Sem host, o admin que envia um convite recebe a ligação para a passar.
Smtp__Username, Smtp__PasswordAs credenciais de acesso ao servidor de email.
Smtp__From, Smtp__FromNameO remetente que esses emails mostram.

O email que as aplicações enviam passa pelas contas de email que cada espaço de trabalho configura no seu builder.

API: ficheiros e backups

DefiniçãoO que faz
Files__DirectoryPara onde vão os uploads e os ficheiros dos espaços de trabalho, como /files. Ponha lá um volume: num contentor sem volume, os ficheiros perdem-se na próxima atualização.
Files__MaxFileBytesO maior ficheiro individual. Predefinição 100 MB.
Files__MaxWorkspaceBytesQuanto um espaço de trabalho pode guardar. Predefinição 0, sem limite.
Backup__DirectoryPara onde vão os backups, como /backups. Também um volume, e copie o que lá chega para outro sítio.
Backup__RetentionDaysQuanto tempo os backups são guardados. Predefinição 30.
Backup__CronScheduleQuando corre o backup noturno, como cron do Quartz. Predefinição 0 0 3 * * ?, às 03:00.

API: escala e limites

DefiniçãoO que faz
Realtime__EntityChangesfalse impede que os ecrãs se atualizem quando um registo muda noutro lado. Predefinição true. Desligado, uma instalação serve muito mais pessoas em simultâneo; consulte Capacidade e dimensionamento.
Cluster__EnabledPermite que várias instâncias da API trabalhem como uma só. Predefinição true; deixe-a ligada.
RateLimiting__EnabledLimites de pedidos por chamador. Predefinição true. Os limites aplicam-se por instância da API.
RateLimiting__PermitsPerMinutePedidos que uma pessoa pode fazer por minuto. Predefinição 2000.
RateLimiting__AuthPermitsPerMinuteTentativas de início de sessão por minuto a partir de um endereço. Predefinição 20.
RateLimiting__PublicPagePermitsPerMinuteO que um visitante sem conta pode pedir às páginas públicas por minuto. Predefinição 240.
Scripting__TypedData__EnabledAs Business Entities como conjuntos tipados nos scripts (Db.Order). Predefinição true.

API: chaves

DefiniçãoO que faz
DataProtection__CertificatePath, DataProtection__CertificatePasswordUm certificado que protege as chaves com que as palavras-passe guardadas são cifradas. Sem ele, essas chaves ficam desprotegidas na base de dados identity, por isso uma cópia dessa base de dados contém as duas metades.
Push__VapidPublicKey, Push__VapidPrivateKey, Push__SubjectUm só par de chaves para as notificações do browser em todos os espaços de trabalho. Se for omitido, cada espaço de trabalho cria o seu. Nunca o altere depois de as pessoas terem permitido notificações: as suas subscrições deixam de funcionar.

API: monitorização

DefiniçãoO que faz
Observability__EnabledEnvia traces, métricas e logs por OpenTelemetry. Predefinição false.
Observability__OtlpEndpointPara onde, como http://otel-collector:4317.
Observability__Instance, Observability__EnvironmentO nome desta instalação nos dashboards.

A imagem web

DefiniçãoO que faz
VITE_API_URLO endereço da API tal como o browser a alcança, como https://api.example.com. Vazio quando a API está no mesmo endereço em /api.
BASE_PATHO caminho sob o qual é servida, como /archestack. Vazio na raiz.
VITE_UI_MODEdashboard mostra o builder em / e a aplicação publicada em /app. kiosk mostra a aplicação publicada em /, para um endereço que é só a aplicação.
VITE_DASHBOARD_URLCom kiosk, o endereço do builder quando está noutro hostname.
VITE_APP_URLCom dashboard, o endereço da aplicação publicada quando está noutro hostname.
API_INTERNAL_URLO endereço da API dentro da rede, como http://api:8080. As pré-visualizações de ligações nas aplicações de chat e as páginas que os motores de busca leem vêm daí. No Kubernetes, escreva o nome completo do service, http://<service>.<namespace>.svc.cluster.local:8080.

A imagem PostgreSQL

DefiniçãoO que faz
POSTGRES_USER, POSTGRES_PASSWORDO utilizador com que a API se liga. A palavra-passe é definida quando o PostgreSQL arranca pela primeira vez num disco vazio; alterar a variável depois não a altera na base de dados.
POSTGRES_DBpostgres. A API cria as suas próprias bases de dados.
PGDATASó num disco novo cuja raiz contém lost+found, como no Kubernetes: uma pasta abaixo do ponto de montagem, como /var/lib/postgresql/data/pgdata.

Dê ao contentor 1 GB de memória partilhada, como explica Executar as imagens.