Configuring LeakLens

LeakLens can be configured through the web UI or by editing config/server_config.yml directly.

Server Settings (admin only)

Navigate to Settings → Server Settings. Changes are written live to server_config.yml and take effect immediately.

Setting	Description
Server Name	Display name shown in the UI header
Business ID	Identifier for your organisation (informational)
Location	Physical or logical location label (informational)
Database IP	Host of your MariaDB instance
Database Port	MariaDB port (default 3306)
Backend DB	Database name used for users and auth data
Breaches DB	Database name used for breach data

Caution

Changing the database connection settings here restarts the in-memory config but does not migrate data. Only change these if you are moving to a new database instance.

Reloading record counts

The Update Record Counts button on Server Settings triggers a background scan of every breach table and updates the stored record counts. A progress bar shows each table as it is processed. Use this after bulk-importing data outside of the UI.

Account Settings

Navigate to Settings → Account Settings.

Setting	Description
Avatar	Upload a profile image (JPEG or PNG)
Username	Change your display name
Password	Change your login password

API Tokens

You can create long-lived API tokens to access the REST API without a session cookie.

1. Click Create Token and give it a name and expiry duration.
2. Copy the token immediately — it is shown only once.
3. Pass the token in the api-key request header for all API calls.

Tokens can be revoked at any time from the Account Settings page.

config/server_config.yml

The config file is the source of truth for all runtime settings:

database:
  host: 192.168.1.10
  port: 3306
  user: LeakLens
  password: <generated>
  breaches_db: breaches
  backend_db: backend

api:
  name: LeakLens
  business_id: myorg
  location: datacenter-1
  version: 1.6.0
  containers_to_monitor:
    - nginx_server
    - fastapi_server
    - mariadb_server

containers_to_monitor controls which Docker container names appear on the dashboard stats panel. Remove mariadb_server from this list if you are using BYODB mode.