Skip to main content

Server configuration

The server reads YAML configuration from app-server/config.yml by default. Pass a different path to the server CLI with --config.

server:
  database:
    location: bin/data/database.db
  services:
    agent-rpc:
      enabled: true
      listen: 0.0.0.0:50052
    web-api:
      enabled: true
      listen:
        http: 0.0.0.0:8091
      authentication:
        bootstrap-token: ""
        session-renewal-interval: 4h
        session-duration: 24h
        cookie-samesite: lax
        trust-proxy-headers: true
        cookie-name: minipam_session
observed-import:
  rules-paths: []
  min-visible-score: 45
  min-default-selected-score: 70
  max-iterations: 3

Database​

server.database.location is the SQLite database file. Relative paths are resolved by the server process, so use a predictable working directory or an absolute path in deployment. Back up this file while respecting SQLite consistency requirements.

Web API​

server.services.web-api.listen.http controls the HTTP bind address. Binding to 0.0.0.0 exposes the port on every interface; apply host firewall and reverse-proxy controls appropriate to your environment.

Initial administrator​

bootstrap-token enables first-user setup only while no root user exists. Generate a long random token, complete setup from the login screen, and then clear the configuration value. Session duration and renewal accept duration values such as 24h and 4h.

The remaining authentication keys control the session cookie. cookie-samesite is normally lax; cookie-name changes the browser cookie name. trust-proxy-headers allows forwarded scheme information to affect secure-cookie handling, so enable it only behind a proxy that replaces untrusted forwarding headers.

Agent RPC​

The agent-rpc section controls the separately configured RPC listener. WebSocket agents use the web API's /ws/agent route. Disable services you do not intend to expose.

Observation import heuristics​

observed-import controls the rule-driven suggestions shown during discovery reconciliation:

  • rules-paths adds YAML rule files to the built-in heuristics;
  • min-visible-score hides weak suggestions below the chosen score;
  • min-default-selected-score controls which suggestions begin selected;
  • max-iterations limits repeated rule evaluation.

Preview remains the final safety boundary: changing a score affects suggestions, not an automatic inventory write.

Runtime configuration entries​

MiniPAM also stores a small set of global or site-specific runtime settings in the database. These include generated MAC prefixes, ping defaults, periodic network-check behavior, and job-retention periods. The /v1/api/config API exposes definitions and effective values; site-specific values override global values for that site.

Configuration evolves

The checked-in app-server/config.yml and server configuration models are the authoritative references for the version you run.

Last updated on