Configuration File
The agent can be configured using a TOML file. By default, it looks for config/agent.toml, but you can specify a different path with --config.
File Location
Section titled “File Location”# Use default locationepoch-agent
# Use custom config fileepoch-agent --config /etc/epoch-agent/config.tomlComplete Example
Section titled “Complete Example”# EpochProxy Agent Configuration
[api]# API server URL for activation and managementurl = "https://api.epochproxy.cloud"
[agent]# Activation code (required for first-time setup)# Can also be provided via --activation-code or EPOCH_ACTIVATION_CODEactivation_code = "YOUR_ACTIVATION_CODE"
# Optional: Agent name (for display in dashboard)name = "production-server-1"
# Optional: Labels for organizing agents[agent.labels]environment = "production"region = "us-east-1"team = "backend"
[shell]# Shell executable pathpath = "/bin/bash"
[reconnect]# Reconnection settings (optional)initial_delay_ms = 1000max_delay_ms = 60000max_retries = 0 # 0 = infinite retriesConfiguration Sections
Section titled “Configuration Sections”Configure the connection to the EpochProxy API server.
| Key | Type | Default | Description |
|---|---|---|---|
url | string | https://api.epochproxy.cloud | API server URL |
[agent]
Section titled “[agent]”Agent identification and registration settings.
| Key | Type | Default | Description |
|---|---|---|---|
activation_code | string | - | Activation code (required for first setup) |
name | string | hostname | Display name in dashboard |
labels | table | {} | Key-value labels for organization |
[shell]
Section titled “[shell]”Terminal session configuration.
| Key | Type | Default | Description |
|---|---|---|---|
path | string | /bin/bash | Shell executable |
[reconnect]
Section titled “[reconnect]”Automatic reconnection behavior.
| Key | Type | Default | Description |
|---|---|---|---|
initial_delay_ms | integer | 1000 | Initial reconnect delay |
max_delay_ms | integer | 60000 | Maximum reconnect delay |
max_retries | integer | 0 | Max retry attempts (0 = infinite) |
Minimal Configuration
Section titled “Minimal Configuration”For most use cases, you only need the activation code:
[agent]activation_code = "YOUR_CODE"All other settings use sensible defaults.
Systemd Service Configuration
Section titled “Systemd Service Configuration”When running as a systemd service, place the config at /etc/epoch-agent/config.toml:
sudo mkdir -p /etc/epoch-agentsudo nano /etc/epoch-agent/config.tomlThen reference it in your service file:
ExecStart=/usr/local/bin/epoch-agent --config /etc/epoch-agent/config.tomlConfiguration Precedence
Section titled “Configuration Precedence”- Default values (built into the binary)
- Configuration file values
- Environment variables (
EPOCH_*) - Command-line arguments (
--*)
Command-line arguments always take precedence.