Fixpanic
CLI Reference

Configuration

Configuration files, paths, and parameters for the FixPanic agent

The FixPanic agent stores its configuration in YAML files. This guide covers the configuration structure, file locations, and available parameters.

File Locations

Configuration file locations depend on how you installed the agent:

System Installation (Root)

FileLocation
Agent Binary/usr/local/lib/fixpanic/fixpanic-connectivity-layer
Configuration/etc/fixpanic/agent.yaml
Logs/var/log/fixpanic/agent.log
Service/etc/systemd/system/fixpanic-connectivity-layer.service

User Installation (Non-Root)

FileLocation
Agent Binary~/.local/lib/fixpanic/fixpanic-connectivity-layer
Configuration~/.config/fixpanic/agent.yaml
Logs~/.local/log/fixpanic/agent.log

Configuration File Structure

The agent.yaml file is automatically generated during installation but can be modified manually if needed.

Basic Structure

app:
  agent_id: "your-agent-id"
  api_key: "your-api-key"

logging:
  level: "info"
  file: "/var/log/fixpanic/agent.log"

Parameters Reference

App Section

ParameterDescriptionRequired
app.agent_idThe unique identifier for this agent (provided by dashboard)Yes
app.api_keyThe authentication key for communicating with the platformYes

Logging Section

ParameterDescriptionDefault
logging.levelLog verbosity levelinfo
logging.fileAbsolute path to the log filePlatform-dependent

Available Log Levels:

LevelDescription
debugVerbose output including internal operations
infoStandard operational messages
warnWarnings and potential issues
errorError messages only

Example Configurations

Minimal Configuration

The minimum required configuration:

app:
  agent_id: "clust_abc123def456"
  api_key: "sk_live_xxxxxxxxxxxxx"

Full Configuration

A complete configuration with all options:

app:
  agent_id: "clust_abc123def456"
  api_key: "sk_live_xxxxxxxxxxxxx"

logging:
  level: "debug"
  file: "/var/log/fixpanic/agent.log"

Environment Variables

You can override configuration values using environment variables. This is useful for containerized deployments or CI/CD pipelines.

VariableOverrides
FIXPANIC_AGENT_IDapp.agent_id
FIXPANIC_API_KEYapp.api_key
FIXPANIC_LOG_LEVELlogging.level
FIXPANIC_LOG_FILElogging.file

Example:

export FIXPANIC_AGENT_ID="clust_abc123def456"
export FIXPANIC_API_KEY="sk_live_xxxxxxxxxxxxx"
export FIXPANIC_LOG_LEVEL="debug"

fixpanic agent start

Modifying Configuration

1. Stop the Agent

fixpanic agent stop

2. Edit the Configuration

Open the configuration file in your editor:

# System installation
sudo nano /etc/fixpanic/agent.yaml

# User installation
nano ~/.config/fixpanic/agent.yaml

3. Validate the Configuration

fixpanic agent validate

4. Restart the Agent

fixpanic agent start

Validating Configuration

Use the validate command to check your configuration:

fixpanic agent validate

This checks:

  • YAML syntax is valid
  • Required fields (agent_id, api_key) are present
  • File paths are accessible
  • Log directory is writable

Troubleshooting Configuration

Common Issues

Invalid YAML syntax: YAML is sensitive to indentation. Use spaces (not tabs) and ensure consistent indentation.

Check YAML syntax:

# Install yamllint if needed
pip install yamllint

# Validate your config
yamllint /etc/fixpanic/agent.yaml

Missing Configuration File

If the configuration file is missing, re-run the installation:

fixpanic agent install --agent-id="your-id" --api-key="your-key"

Permission Denied

Ensure the agent has read access to the configuration file:

# System installation
sudo chmod 600 /etc/fixpanic/agent.yaml
sudo chown root:root /etc/fixpanic/agent.yaml

# User installation
chmod 600 ~/.config/fixpanic/agent.yaml

Next Steps

On this page