Configure the instance
Every Excubius installation ships with every capability. Settings › Instance decides which of them the installation shows, and under which name, logo and theme. Changes apply to everyone at once and are written to the audit log. This guide shows how to switch features, apply a preset and set the branding.
Before you begin
- You need the Super admin role. The screen is not shown to anyone else.
- Some features also need configuration on the server, such as a Slack token or Jira credentials. Switching a feature on shows it; it does not configure it.
Open the screen
- Select Settings, then Instance.
- Find the Presets, Features and Branding sections described below. At the bottom, the screen tells you whether switched-off features are only hidden or also refused by the API, and when the last change was made.
The server's names and TLS have their own screen, linked from the top as Server names and HTTPS. See Set up names and TLS.
Start from a preset
A preset is a named starting point: a set of feature switches plus branding. Each one is shown as a card with its description. The general-purpose presets are:
| Preset | Content |
|---|---|
enterprise | Everything on; the default for a new installation |
databases | Infrastructure, alerts, the status page and the database modules |
core | Infrastructure, alerts and the status page |
Selecting a preset card applies it at once. It replaces all feature switches and the branding with the preset's. Note your branding before you apply one, and adjust single switches afterwards.
Even in enterprise, the Defender for Cloud and Wazuh sources stay off until you switch them on.
Switch a feature on or off
- Under Features, find the feature in its group: Sources, Monitoring, Security, Collaboration, Access or Interface. Each line shows the feature's key, what it does and, when it has one, the feature it requires.
- Use its switch.
The change applies at once.
- A feature that requires another is greyed out while that one is off. Switching a requirement off switches its dependants off too; for example, switching off
securityalso switches offsecurity.defenderandsecurity.wazuh. - Switching off a feature that owns catalog modules removes those modules from the catalog listing.
- Hiding is presentational by default: navigation, screens and widgets follow the switches, while collection, storage and the API keep working. When you switch a feature back on, its history is there. To make the API refuse switched-off features as well, set
EXCUBIUS_FEATURES_ENFORCE_API=truein the server's configuration; their endpoints then answer404. - Some switches are enforced in any case. With
access.google_loginoff, Google sign-in is refused.
Features that other guides refer to:
| Feature | What it controls |
|---|---|
monitoring.databases | SQL Server (including availability groups), Azure SQL, Managed Instance and PostgreSQL modules |
monitoring.updates | The Updates & advisories page and its checks |
security | The Security posture page, the findings and the security score |
security.defender, security.wazuh | Collection from Microsoft Defender for Cloud and from Wazuh. Off by default |
security.recommendations | Shows Defender for Cloud recommendations next to findings |
collab.jira | Create Jira ticket on alerts and findings; requires collab.assign |
access.google_login | Sign-in with Google |
access.directory_groups | Roles for Microsoft Entra ID groups |
ui.public_status_page | Public status pages |
ui.i18n | Languages other than English, in the console and in Slack messages |
ui.themes | Colour themes beyond light and dark |
Set the branding
-
Under Branding, fill in the fields:
Field Effect Product name The browser title, the header, the sign-in page, the installed app's name, and the prefix and label of Jira issues. Up to 60 characters Tagline Shown next to the name on wide screens and in the installed app's description. Up to 120 characters Logo None, the Built-in mark, or an Image URL: an httpsaddress or a path on this server starting with/Default theme The theme of the sign-in page and of new users. People can still choose their own Show "powered by" line A footer credit, shown only with the built-in mark -
Select Save.
With Logo set to None, a neutral icon is used everywhere, including the browser tab and the installed app, so nothing in the browser names the product. Slack messages and public status pages never name the product, whatever the branding.
The themes are Midnight, Daylight, Slate and amber, Ops room (high contrast), Okabe–Ito (colour-blind safe) and Paper. With ui.themes off, the installation offers light and dark only.
A client's branch can have its own default theme and logo; see Set a branch appearance.
Do it with the API
Every request needs the Super admin role and is audited.
| Task | Request |
|---|---|
| Read the full configuration, presets and feature registry | GET /api/v1/instance/admin |
| Apply a preset | POST /api/v1/instance/preset with {"name": "databases"} |
| Switch features | PATCH /api/v1/instance/features with {"changes": {"collab.jira": false}} |
| Change the branding | PATCH /api/v1/instance/branding with any of product_name, tagline, logo, show_powered_by, theme_default |
GET /api/v1/instance needs no sign-in: it returns the branding and the switches as the caller sees them, which is what the console reads when it loads.