Configuração
Variáveis de ambiente, definições da framework, e configuração por módulo.
Nesta página
ConfiguraĆ§Ć£o
VariƔveis de ambiente
Copie .env.example para .env e preencha os seus prĆ³prios valores - lidos em qualquer parte da aplicaĆ§Ć£o via getSystemSetting( "VAR_NAME", "default" ):
| VariĆ”vel | PropĆ³sito |
|---|---|
APPNAME | Nome de exibiĆ§Ć£o da aplicaĆ§Ć£o |
ENVIRONMENT | development ou production |
ASSET_URL | Prefixo de URL pĆŗblico para os assets de produĆ§Ć£o do Vite (predefiniĆ§Ć£o /includes) |
BOXLANG_DEBUG | Ativa a saĆda de depuraĆ§Ć£o do BoxLang |
DB_CONNECTIONSTRING | Cadeia de ligaĆ§Ć£o JDBC completa |
DB_DRIVER | Driver de base de dados, em minĆŗsculas, correspondendo a um mĆ³dulo de driver JDBC bx-* (mysql para MySQL ou MariaDB, mssql, postgresql, h2, oracle, sqlite) - o onServerInitialInstall do server.json instala o bx-${DB_DRIVER} no primeiro arranque do servidor |
DB_HOST / DB_PORT / DB_DATABASE | Detalhes de ligaĆ§Ć£o Ć base de dados |
DB_SCHEMA | Esquema visado pelo executor de migraƧƵes (.cbmigrations.json); deixe em branco para motores sem esquema |
DB_USER / DB_PASSWORD | Credenciais da base de dados |
JWT_SECRET | Chave de assinatura para o suporte de JWT do cbsecurity |
COOKIE_ENCRYPTION_KEY | Chave de encriptaĆ§Ć£o para o armazenamento de cookies do cbstorages. SĆ³ importa depois de useEncryption estar ativado (desativado por predefiniĆ§Ć£o) - defina-a antes de o fazer, ou a chave regenera-se a cada arranque e invalida silenciosamente os cookies previamente encriptados |
CBFS_ASSETS_DISK_PATH | Caminho no sistema de ficheiros para o disco assets do cbfs, que guarda os avatares e o logĆ³tipo de marca (predefiniĆ§Ć£o <app-root>/.cbfs) |
COLDBOX_REINIT_PASSWORD | Palavra-passe exigida por ?fwreinit. NĆ£o definida significa um valor aleatĆ³rio novo a cada arranque, pelo que a reinicializaĆ§Ć£o fica fechada - veja ImplantaĆ§Ć£o |
COLDBOX_SESSION_TIMEOUT | Tempo limite da cache de sessĆ£o, em minutos, para o armazenamento de sessĆ£o do cbstorages (predefiniĆ§Ć£o 60) |
DefiniƧƵes da framework (app/config/Coldbox.bx)
| DefiniĆ§Ć£o | Valor |
|---|---|
defaultEvent | Auth.login ā os visitantes nĆ£o autenticados aterram na pĆ”gina de inĆcio de sessĆ£o |
requestStartHandler | Main.onRequestStart |
applicationStartHandler | Main.onAppInit |
exceptionHandler | Main.onException |
modulesExternalLocation | ["/modules"] |
autoMapModels | true |
jsonPayloadToRC | true |
reinitPassword | COLDBOX_REINIT_PASSWORD, ou um novo UUID aleatĆ³rio a cada arranque quando nĆ£o estĆ” definida |
Uma sobreposiĆ§Ć£o do ambiente development() ativa o template de erro Whoops, a recarga de singletons do WireBox, o modo de depuraĆ§Ć£o do ColdBox, e limpa o reinitPassword, para que ?fwreinit=1 funcione localmente sem uma palavra-passe. O LogBox estĆ” configurado com um appender de consola mais um appender de ficheiro rotativo, que escreve em app/logs.
DefiniƧƵes da aplicaĆ§Ć£o vs. configuraĆ§Ć£o da framework
Duas coisas diferentes residem ambas sob app/config/, e Ʃ fƔcil confundi-las:
A configuraĆ§Ć£o da framework (Coldbox.bx, Router.bx, WireBox.bx, CacheBox.bx, Scheduler.bx) Ć© estĆ”tica, baseada em ficheiros, e as alteraƧƵes sĆ³ tĆŖm efeito no prĆ³ximo ?fwreinit.
As definiƧƵes da aplicaĆ§Ć£o (cbAppName, cbAllowRegistration, cbMinPasswordLength, ...) sĆ£o guardadas na base de dados, editĆ”veis pelo administrador em /settings, definidas em SettingService.static.DEFAULTS, e colocadas em cache com um TTL de 2 horas.
SettingService.preFlightCheck() (chamado a partir de Main.onAppInit) semeia na base de dados, no arranque, qualquer predefiniĆ§Ć£o em falta, pelo que adicionar uma nova chave a DEFAULTS jĆ” Ć© suficiente para que ela apareƧa. Uma definiĆ§Ć£o tambĆ©m pode ser substituĆda de duas outras formas, ambas lidas por loadConfigOverrides()/loadEnvironmentOverrides():
- Qualquer chave com o prefixo
cb*colocada emvariables.settingsdoColdbox.bx - Qualquer variƔvel de ambiente com o prefixo
genesis_*
ConfiguraĆ§Ć£o de mĆ³dulos
Cada mĆ³dulo instalado tem o seu prĆ³prio ficheiro de definiƧƵes em app/config/modules/:
| MĆ³dulo | DefiniƧƵes principais |
|---|---|
| cbsecurity | fornecedor cbauth, CSRF (rotativo, 30 min), firewall com deteĆ§Ć£o de anotaƧƵes @secured, cabeƧalhos de seguranƧa, JWT (HS512, 60 min) ā veja SeguranƧa e PermissƵes |
| cbauth | UserService como fornecedor de identidade, armazenamento de sessĆ£o baseado em cache |
| cbmailservices | protocolo BXMail em produĆ§Ć£o, protocolo de ficheiros em desenvolvimento ā veja E-mail |
| cborm | injeĆ§Ć£o de entidades ativada, paginaĆ§Ć£o maxRows: 25 / maxRowsLimit: 500 |
| cbfs | disco assets (fornecedor Local por predefiniĆ§Ć£o, caminho a partir de CBFS_ASSETS_DISK_PATH) - guarda os avatares e o logĆ³tipo de marca, servidos em stream por Assets.bx ā veja Frontend |
| cbstorages | armazenamento em cache (cache de sessƵes, tempo limite a partir de COLDBOX_SESSION_TIMEOUT, predefiniĆ§Ć£o 60 min), armazenamento de cookies (encriptaĆ§Ć£o desativada por predefiniĆ§Ć£o) |
| cbsecurity-passkeys | configuraĆ§Ć£o de relying party WebAuthn para inĆcio de sessĆ£o com passkey - relyingPartyId/allowedOrigins sĆ£o valores placeholder de localhost que tem de alterar antes de ir para produĆ§Ć£o, veja ImplantaĆ§Ć£o |
| mementifier | datas ISO8601, auto-inclusƵes do ORM, conversĆ£o para UTC |