Configuração

A configuração do ambiente de trabalho do bdot CLI é o primeiro passo após a instalação. O assistente conta com uma interface de terminal (TUI - Terminal User Interface) para execução interativa e intuitiva.

Para iniciar o assistente de configuração (primeiro acesso ou alterações posteriores), execute:

bdot setup

Para cenários de automação ou CI/CD, você também pode executar a configuração rápida de forma não-interativa:

bdot setup --fast-config

Primeira Configuração

O comando bdot setup é o ponto de entrada para preparar o arquivo .env e provisionar os segredos criptográficos necessários para o funcionamento dos containers.

Se nenhum arquivo .env for localizado no workspace, as seguintes opções serão exibidas no terminal:

Configuração rápida (Recomendado): Aplica instantaneamente valores padrão seguros, gera chaves e senhas de 32 caracteres via crypto/rand (salvas em ~/.bdot/.bdot_secrets/) e prepara todo o workspace.
Configuração avançada: Abre o editor visual organizado em grupos temáticos (Geral, Rede, Banco de Dados, SSO, Engine, Runners, etc.). Recomendado quando for necessário ajustar portas ou hostnames específicos antes da primeira execução.

Alteração de Configuração

Caso o arquivo .env já exista, o assistente exibirá o seguinte menu:

Iniciar o bdot: Salva a configuração atual e prossegue diretamente para a subida dos serviços (equivalente ao bdot up).
Editar configuração: Abre o editor visual preenchido com os valores atuais do .env. Apenas os parâmetros alterados são persistidos ao salvar.
Configuração rápida: Substitui a configuração atual gerando um novo arquivo .env com os valores padrão.
Configuração avançada: Abre o editor visual com acesso completo a todos os parâmetros da plataforma.
Reiniciar o bdot: Interrompe a plataforma e reinicia o fluxo de configuração.

Gerenciamento de Segredos (`.bdot_secrets/`)

Durante o processo de setup, a CLI gera automaticamente senhas e chaves efêmeras de 32 caracteres armazenadas na pasta de acesso restrito ~/.bdot/.bdot_secrets/:

bdot_server_id: UUID único do servidor.
bdot_db_admin_password: Senha do usuário administrador do PostgreSQL (admin).
bdot_db_apl_password: Senha do usuário da aplicação no PostgreSQL (admin_apl).
bdot_sso_admin_password: Senha do usuário administrador do SSO/Keycloak (admin).

Parâmetros Configuráveis (Configuração Avançada)

Abaixo estão todas as variáveis gerenciadas pelo arquivo .env (BDOT_CFG_*):

Categoria	Atributo	Descrição	Valor Padrão	Permite Edição
Geral	`BDOT_CFG_LOG_LEVEL`	Nível de logs das aplicações (`DEBUG`, `INFO`, `WARN`, `ERROR`)	`INFO`	Sim
Geral	`BDOT_CFG_TIMEZONE`	Fuso horário dos containers	`America/Sao_Paulo`	Sim
Rede	`BDOT_CFG_HOSTNAME`	Hostname de acesso da aplicação (ex: `bdot.local`)	`bdot.local`	Sim
Rede	`BDOT_CFG_HTTP_PORT`	Porta HTTP exposta pelo Traefik	`81`	Sim
Rede	`BDOT_CFG_HTTPS_PORT`	Porta HTTPS exposta pelo Traefik (TLS autoassinado)	`443`	Sim
Banco de Dados	`BDOT_CFG_DB_ADMIN_USER`	Usuário administrador do PostgreSQL	`admin`	Sim
Banco de Dados	`BDOT_CFG_DB_APL_USER`	Usuário de aplicação no PostgreSQL	`admin_apl`	Sim
Banco de Dados	`BDOT_CFG_DB_HOST`	Host do container de banco de dados	`bdot-database`	Sim
Banco de Dados	`BDOT_CFG_DB_PORT`	Porta do banco de dados	`5432`	Sim
Banco de Dados	`BDOT_CFG_DB_APL_NAME`	Nome da base de dados da aplicação	`bdot_apl`	Sim
Banco de Dados	`BDOT_CFG_DB_STATS_NAME`	Nome da base de dados de observabilidade/métricas	`bdot_stats`	Sim
Autenticação (SSO)	`BDOT_CFG_SSO_ADMIN_USER`	Usuário administrador do Keycloak	`admin`	Sim
Autenticação (SSO)	`BDOT_CFG_SSO_APL_USER`	Usuário da aplicação no SSO	`bdot_local`	Sim
Autenticação (SSO)	`BDOT_CFG_SSO_CLIENT_ID`	Client-ID da aplicação no SSO	`bdot-web`	Sim
Imagens Docker	`BDOT_CFG_REGISTRY`	Registry do Docker onde as imagens estão hospedadas	`registry.bpx.dev.br`	Sim
Imagens Docker	`BDOT_CFG_APP_VERSION_DIST`	Distribuição da plataforma	`community`	Não
Imagens Docker	`BDOT_CFG_APP_VERSION`	Versão/Tag das imagens Docker	`1.0.0-beta`	Não
Mensageria	`BDOT_CFG_BROKER_URL`	URL do broker Kafka	`bdot-broker:9092`	Não
Cache	`BDOT_CFG_CACHE_GESTAO_URL`	URL de conexão do cache Redis de gestão	`cache-gestao:6379`	Não
Cache	`BDOT_CFG_CACHE_SESSAO_URL`	URL de conexão do cache Redis de sessão	`cache-sessao:6379`	Não
Cache	`BDOT_CFG_CACHE_IDENTITY_URL`	URL de conexão do cache Redis de identidade	`cache-identity:6379`	Não
Engine	`BDOT_CFG_ENGINE_AMBIENTE`	Código do ambiente de execução de fluxos	`local`	Sim
Engine	`BDOT_CFG_ENGINE_AMBIENTE_NOME`	Nome de exibição do ambiente de fluxos	`Local`	Sim
Runner (Auth)	`BDOT_CFG_RUNNER_AUTH_SERVER`	Endpoint de autenticação do SSO para os runners	`http://bdot-sso:8080/auth`	Sim
Runner (Auth)	`BDOT_CFG_RUNNER_AUTH_REALM`	Realm do SSO para autenticação	`local`	Sim
Runner (Cache)	`BDOT_CFG_RUNNER_CACHE_HOST`	Host de cache utilizado pelos runners	`cache-gestao:6379`	Sim
Runner (JDBC)	`BDOT_CFG_RUNNER_JDBC_MAX_SIZE`	Limite do pool de conexões JDBC	`20`	Sim
Runner (JDBC)	`BDOT_CFG_RUNNER_JDBC_USER`	Usuário de conexão JDBC no banco	`admin_apl`	Sim
Runner (JDBC)	`BDOT_CFG_RUNNER_JDBC_PASSWORD_SECRET`	Secret contendo a senha do banco para os runners	`bdot_db_apl_password`	Sim
Runner (JDBC)	`BDOT_CFG_RUNNER_JDBC_URL`	String de conexão JDBC PostgreSQL	`jdbc:postgresql://bdot-database:5432/bdot_apl`	Sim

Flags Globais e Escopo do Workspace

A CLI suporta as seguintes flags para ajustar o escopo do arquivo .env ou o comportamento do terminal:

Flag	Abreviação	Escopo	Descrição
`--config`	—	Global	Especifica um caminho customizado para o arquivo `.env` (padrão: `~/.bdot/.env`).
`--local`	`-l`	Global	Faz a CLI utilizar o diretório atual como workspace em vez de `~/.bdot/` (ideal para desenvolvimento do projeto).
`--verbose`	`-v`	Global	Reserva a saída detalhada no terminal para diagnóstico de erros.
`--silent`	`-s`	`up` e `down`	Oculta a TUI (modo headless / silencioso) durante os comandos de subida e parada (ideal para automações e CI).