Skip to content

Configuration Reference

LiMon is DB-backed after setup. The Admin UI and configuration API are the normal way to change servers, applications, sites, SMTP, tools, report settings, privacy behavior, and monitoring defaults.

config.yml still matters, but it is no longer the main day-to-day configuration surface. Treat it as the bootstrap/base shape and as a portable export/import format for backup, migration, and support workflows.

Configuration Sources

LiMon builds effective configuration in layers:

  1. defaults.yml provides shipped defaults and should not be edited.
  2. config.yml provides bootstrap/customer base values, including startup-only settings.
  3. DB-backed settings written by the Setup Wizard, Admin UI, or configuration API override the base configuration where present.

Routine Admin UI changes are written to the database. The monitor reloads configuration on its next polling cycle, and the API hot-reloads its active settings. Restart services only for genuine startup-only changes such as database credentials, listening ports, package/image upgrades, or recovery from a hung service.

Note

Advanced operators can still edit config.yml, but DB-managed values win for keys the Admin UI owns. File changes are read on process start, so they are not the fastest or safest way to make routine changes.

Export And Import

Use configuration export/import when you need a backup artifact or want to move settings between environments.

Action Endpoint Notes
Export current configuration POST /api/v1/config/export Generates YAML from the current effective configuration.
Import configuration POST /api/v1/config/import Reads a YAML payload and updates DB-backed configuration.

These endpoints require the API key header:

X-API-KEY: <your-api-key>

Useful Sections

This is a compact operator reference, not a full dump of defaults.yml.

Section What it controls
database MariaDB host, port, user, password, database name, and pool size. Usually startup-only.
api API bind host/port, API key, command directory, log level, cache TTL, and log import limits.
monitoring Instance name, timezone, collection interval, retention windows, reports folder, warning thresholds, and expiration notification intervals.
smtp Email host, port, sender, username, password, TLS/SSL behavior. Prefer Admin UI settings.
ldap AD/LDAP provider, directory type, server, base DN, bind user, batch size, timeout, and attribute overrides.
tools Vendor utility paths for FlexLM, RLM, LM-X, and DSLS. Prefer Admin UI validation.
servers Bootstrap server lists by vendor. After setup, manage servers from Admin UI.
sites Optional location/site metadata used for rollups and reports.
applications Optional product definitions and feature groupings.
feature_ignore Vendor-specific and global feature tokens excluded from monitoring/reporting noise.
reports Report styling, output directory, retention, scheduler behavior, and report-specific thresholds.
privacy Username/workstation masking and anonymization behavior for privacy-sensitive reporting.
compliance Compliance ledger enablement and signing-key path.

Common Defaults

Key Default Notes
api.cache_ttl_seconds 90 Default cache duration for selected API responses.
monitoring.collection_interval 10 Polling interval in seconds unless changed in Admin UI.
monitoring.reports_folder /opt/limon/reports Generated dashboard/output artifacts and Prometheus files live below this folder.
monitoring.raw_data_retention_weeks 52 Raw data retention window.
smtp.port 587 Default SMTP submission port.
reports.output.directory /opt/limon/reports/intelligence Intelligence report output directory.
reports.money.currency EUR Default report currency.

Example YAML Shape

The export/import format still looks like the bootstrap YAML. For example, the server section groups license servers by vendor and uses port@hostname values with optional descriptions and site codes:

servers:
  flexlm:
    - server: "[email protected]"
      description: "Engineering CAD Licenses"
      site_code: "US-NYC"
    - server: "[email protected]"
      description: "Simulation Software Licenses"
      site_code: "UK-LDN"

  rlm:
    - server: "[email protected]"
      description: "Development Tools"

  lmx:
    - server: "[email protected]"
      description: "Analysis Software"

  dsls:
    - server: "[email protected]"
      description: "CATIA Licenses"

This shape is useful for bootstrap, support, backup, and migration. After setup, the database-backed Admin UI remains authoritative for normal server changes.

Startup-Only Changes

Use service restarts for changes that affect process startup, such as database connection details or API bind settings. For normal operational changes, use /admin/ or the /api/v1/config/* endpoints instead.