Configurar a instância
Toda instalação do Excubius inclui todos os recursos. Settings › Instance decide quais deles a instalação mostra e com qual nome, logotipo e tema. As alterações se aplicam a todos imediatamente e são registradas no log de auditoria. Este guia mostra como ativar e desativar recursos, aplicar uma predefinição e definir a identidade visual.
Antes de começar
- Você precisa da função Super admin (Superadministrador). A tela não é exibida para mais ninguém.
- Alguns recursos também precisam de configuração no servidor, como um token do Slack ou credenciais do Jira. Ativar um recurso o exibe; não o configura.
Abrir a tela
- Selecione Settings e depois Instance.
- Localize as seções Presets, Features e Branding descritas abaixo. Na parte inferior, a tela informa se os recursos desativados estão apenas ocultos ou também são recusados pela API, e quando foi feita a última alteração.
Os nomes e o TLS do servidor têm uma tela própria, com um link no topo chamado Server names and HTTPS. Consulte Configurar nomes e TLS.
Começar a partir de uma predefinição
Uma predefinição é um ponto de partida com nome: um conjunto de opções de recurso mais a identidade visual. Cada uma aparece como um cartão com a descrição dela. As predefinições de uso geral são:
| Predefinição | Conteúdo |
|---|---|
enterprise | Tudo ativado; o padrão para uma nova instalação |
databases | Infraestrutura, alertas, a página de status e os módulos de banco de dados |
core | Infraestrutura, alertas e a página de status |
Selecionar o cartão de uma predefinição a aplica imediatamente. Ela substitui todas as opções de recurso e a identidade visual pelas da predefinição. Anote a sua identidade visual antes de aplicar uma e ajuste as opções individuais depois.
Mesmo em enterprise, as fontes Defender for Cloud e Wazuh permanecem desativadas até que você as ative.
Ativar ou desativar um recurso
- Em Features, localize o recurso no grupo dele: Sources, Monitoring, Security, Collaboration, Access ou Interface. Cada linha mostra a chave do recurso, o que ele faz e, quando houver, o recurso de que ele depende.
- Use a opção dele.
A alteração se aplica imediatamente.
- Um recurso que depende de outro fica esmaecido enquanto esse outro estiver desativado. Desativar um requisito também desativa os recursos que dependem dele; por exemplo, desativar
securitytambém desativasecurity.defenderesecurity.wazuh. - Desativar um recurso que tem módulos do catálogo remove esses módulos da listagem do catálogo.
- Por padrão, ocultar é apenas visual: a navegação, as telas e os widgets seguem as opções, enquanto a coleta, o armazenamento e a API continuam funcionando. Quando você reativa um recurso, o histórico dele está lá. Para que a API também recuse os recursos desativados, defina
EXCUBIUS_FEATURES_ENFORCE_API=truena configuração do servidor; os endpoints deles passam a responder404. - Algumas opções são aplicadas em qualquer caso. Com
access.google_logindesativado, a entrada com o Google é recusada.
Recursos citados em outros guias:
| Recurso | O que ele controla |
|---|---|
monitoring.databases | Os módulos de SQL Server (incluindo grupos de disponibilidade), Azure SQL, Managed Instance e PostgreSQL |
monitoring.updates | A página Updates & advisories e as verificações dela |
security | A página Security posture, as descobertas e a pontuação de segurança |
security.defender, security.wazuh | A coleta do Microsoft Defender for Cloud e do Wazuh. Desativados por padrão |
security.recommendations | Mostra as recomendações do Defender for Cloud ao lado das descobertas |
collab.jira | Create Jira ticket em alertas e descobertas; depende de collab.assign |
access.google_login | A entrada com o Google |
access.directory_groups | Funções para grupos do Microsoft Entra ID |
ui.public_status_page | Páginas de status públicas |
ui.i18n | Idiomas além do inglês, no console e nas mensagens do Slack |
ui.themes | Temas de cores além do claro e do escuro |
Definir a identidade visual
-
Em Branding, preencha os campos:
Campo Efeito Product name O título do navegador, o cabeçalho, a página de entrada, o nome do aplicativo instalado e o prefixo e o rótulo dos itens do Jira. Até 60 caracteres Tagline Exibido ao lado do nome em telas largas e na descrição do aplicativo instalado. Até 120 caracteres Logo None, o Built-in mark ou uma Image URL: um endereço httpsou um caminho neste servidor que comece com/Default theme O tema da página de entrada e dos novos usuários. As pessoas ainda podem escolher o próprio tema Show "powered by" line Um crédito no rodapé, exibido somente com a opção Built-in mark -
Selecione Save.
Com Logo definido como None, um ícone neutro é usado em todos os lugares, incluindo a guia do navegador e o aplicativo instalado, de modo que nada no navegador nomeia o produto. As mensagens do Slack e as páginas de status públicas nunca nomeiam o produto, qualquer que seja a identidade visual.
Os temas são Midnight, Daylight, Slate and amber, Ops room (high contrast), Okabe–Ito (colour-blind safe) e Paper. Com ui.themes desativado, a instalação oferece apenas o claro e o escuro.
O ramo de um cliente pode ter o próprio tema padrão e logotipo; consulte Definir a aparência de um ramo.
Fazer isso com a API
Cada solicitação exige a função Super admin e é auditada.
| Tarefa | Solicitação |
|---|---|
| Ler a configuração completa, as predefinições e o registro de recursos | GET /api/v1/instance/admin |
| Aplicar uma predefinição | POST /api/v1/instance/preset com {"name": "databases"} |
| Ativar ou desativar recursos | PATCH /api/v1/instance/features com {"changes": {"collab.jira": false}} |
| Alterar a identidade visual | PATCH /api/v1/instance/branding com qualquer um destes: product_name, tagline, logo, show_powered_by, theme_default |
GET /api/v1/instance não exige entrada: ele retorna a identidade visual e as opções como o chamador as vê, que é o que o console lê quando carrega.