Skip to content

Database Config

Database Configs live under a project. Create or select a project first, then add ClickHouse connections for that project’s environments. They are not a free-floating organisation-wide setting.

A Database Config is the ClickHouse connection Shield360 uses as its app store and default telemetry backend: host, port, database, credentials, environment label, and optional query params. Every project needs at least one before traces, dashboards, evals, or vault-backed features can load.

Before (deploy-time env)After (product Database Config)
INIT_DB_HOSTHost
INIT_DB_PORTPort
INIT_DB_DATABASEDatabase
INIT_DB_USERNAMEUsername
INIT_DB_PASSWORDPassword
(often a single shared connection)Config name + Environment per project
VariableRole today
INIT_DB_*Seed only — when the app first starts (or is seeded), Shield360 creates/updates a default Database Config if host and port are set. Changing these later does not automatically rewrite existing configs.
SQLITE_DATABASE_URLLocation of the Shield360 control-plane SQLite DB (users, projects, Database Config rows, bindings).
SHIELD360_DB_* / Compose secretsCredentials for the ClickHouse container itself in Docker/K8s — infrastructure, not the UI connection picker.
  1. Open Organisation → Project → Database configurations (or Connectors → ClickHouse).
  2. Edit or add a Database Config with the new host/port/database/credentials.
  3. Mark it active for your user in that project (header Databases switcher).
  4. Optionally keep INIT_DB_* in Compose only so new installs still seed a default — do not rely on them for day-2 connection changes.

Configs live on the current project. Shield360’s Organisation → Projects tab states this explicitly: select a project before managing its Database Config. In Connectors, ClickHouse also appears as the built-in connector.

Organisation Projects tab — Manage DB Config per project
Select a project

In the header, choose the project (and environment) that should own the configuration.

Open Database configurations

From Organisation → Projects, use Manage DB Config, or open Connectors → ClickHouse.

Add config

Enter Config Name, Environment, Username, Password, Host, Port, Database, and optional Query params.

Save and activate

Save, then mark the config active (list checkbox or header Databases switcher). Connectivity is verified when the config becomes active.

FieldDescription
Config NameFriendly label (unique per project + environment).
EnvironmentLogical env (for example production, staging) used with signal routing.
Host / PortClickHouse HTTP endpoint (commonly port 8123).
DatabaseClickHouse database name Shield360 queries.
Username / PasswordClickHouse credentials. Password is masked after save.
Query paramsOptional URL query string appended to the ClickHouse HTTP client.
  • Active Database Config is scoped to the current user + project — teammates can select different configs in the same project.
  • Switching projects changes the available configs; a config never crosses projects.
  • Creating a config seeds default signal bindings (traces, logs, metrics, intelligence) to that ClickHouse for the environment when none exist yet.

Use several Database Configs when you need separate ClickHouse clusters, retention tiers, or staging vs production without changing organisation. Pair each config’s Environment with connector bindings so telemetry routing stays consistent. See Environments.

A Database Config can be shared with teammates by email with separate edit, delete, and re-share permissions — useful when someone needs the connection without full project admin rights.

I changed INIT_DB_HOST in Docker — why is Shield360 still on the old host?

Runtime uses the Database Config row. Update the config in the UI (or create a new one and activate it). INIT_DB_* only seeds on first setup.

Can one Database Config be used by two projects?

No. Create a config in each project (they can point at the same ClickHouse cluster or database name).

Do I need ClickHouse if I only use Tempo + Loki + Prometheus?

Yes. External connectors serve raw telemetry reads. ClickHouse remains the app store for derived intelligence and vault-backed connector secrets.

Is the password visible after save?

No. It is masked in the API and UI; only submitting a new value overwrites it.