Skip to content

Configuration File Reference

This document details the configuration parameters for the Txlog Agent.

File Location: /etc/txlog.yamlFormat: YAML

Server Configuration (server)

Parameters related to the connection with the central Txlog Server.

ParameterTypeRequiredDescription
server.urlstringYesThe base URL of the Txlog Server
(e.g., https://txlog.example.com).
server.api_keystringNoAPI Key for authentication.
Requires Server version >= 1.14.0.
server.usernamestringNoUsername for Basic Authentication.
server.passwordstringNoPassword for Basic Authentication.

Agent Configuration (agent)

Parameters controlling the agent's internal behavior.

ParameterTypeDefaultDescription
agent.check_versionbooleantrueIf true, checks for newer agent versions
on execution.

Example Configuration

yaml
server:
  url: https://txlog.internal:8080
  # Authentication (Choose one method)
  # Method 1: API Key (Recommended)
  api_key: "txlog_prod_..."
  # Method 2: Basic Auth
  # username: "admin"
  # password: "secure_password"

agent:
  check_version: true