Txlog Agent Documentation

The Txlog Agent is a specialized utility designed to compile transactional data from RPM-based systems and securely transmit it to a centralized server. By automating the collection and reporting of system changes, it enables comprehensive monitoring and analytics, providing administrators with a unified view of their infrastructure's state and history.

TL;DR

# Install
sudo dnf localinstall -y https://rpm.rda.run/repo.rpm
sudo dnf install -y txlog

# Configure (update server URL)
sudo nano /etc/txlog.yaml

# Run
txlog build

1. Tutorials

Learning-oriented lessons for beginners.

• Getting Started: A hands-on guide to installing, configuring, and running the agent for the first time.
• MCP Getting Started: Set up the MCP server to use AI assistants with your infrastructure.

2. How-to Guides

Task-oriented guides for specific goals.

• Configure Authentication: Set up API Keys or Basic Auth.
• Verify Data Integrity: Ensure local and server data match.
• Run in CI/CD: Use the agent in automated pipelines with NO_COLOR.
• Secure Configuration: Protect your credentials.
• Configure MCP with SSE: Run the MCP server with SSE transport for web clients.

3. Reference

Information-oriented technical descriptions.

• CLI Commands: build, verify, version.
• MCP Tools: Available tools and prompts for AI assistants.
• Configuration: txlog.yaml parameters.
• Environment Variables: NO_COLOR and others.

4. Explanation

Understanding-oriented background knowledge.

• Architecture Overview: How the system works.
• Data Synchronization: The logic behind the sync process.
• Design Choices: Why we chose Go, Cobra, and Regex.
• MCP Integration: How and why the Model Context Protocol was integrated.

Quick Links

• Project Repository: github.com/txlog/agent
• Issue Tracker: github.com/txlog/agent/issues