Alpamon configuration

Use these settings when a server needs a custom certificate, proxy, or agent setting. For standard setup, use the command generated by your workspace in Install Alpamon.

Configuration

Configuration file

The configuration file location depends on the platform:

  • Linux: /etc/alpamon/alpamon.conf
  • macOS: /etc/alpamon/alpamon.conf
  • Windows: %ProgramData%\alpamon\alpamon.conf

Format (INI):

ini
[server]
id = your-server-id
key = your-server-key
url = https://your-workspace.us1.alpacon.io
 
[ssl]
verify = true
# ca_cert = /path/to/ca.crt    # Custom CA certificate (optional)
 
[logging]
debug = false           # Enable verbose debug logging
 
[pool]
max_workers = 20        # Default: 20 concurrent workers
queue_size = 200        # Default: 200 queued jobs
default_timeout = 3600  # Default: 3600 seconds when unset (0 = no timeout)
 
[editor]
idle_timeout = 60       # Default: 60 minutes (0 = disabled)
 
[interface]
include_virtual =      # Default: empty; example: veth0, cali*
exclude_virtual_from_inventory = false # Default: false
 
[file]
# max_download_bytes = 0    # Max download size in bytes for URL fetches (0 = unlimited)
Note

This file is automatically generated during installation or registration. You typically don’t need to edit it manually.

Network interface settings

In [interface], include_virtual is a comma-separated list of exact interface names or case-sensitive glob patterns, such as veth0, cali*. It is empty by default. Use it to include traffic samples for virtual interfaces that are otherwise filtered out. Loopback interfaces and interfaces without a hardware address cannot be added this way.

exclude_virtual_from_inventory defaults to false, so those virtual interfaces remain in the reported interface list even when their traffic samples are excluded. Set it to true to omit them from that list as well.

Warning

Enable exclude_virtual_from_inventory only when your Alpacon server retains interfaces that the agent stops reporting. A server that deletes an unreported interface also deletes its traffic history.

Environment variables

These environment variables are used during package installation for auto-registration:

bash
# Required for auto-registration
export ALPACON_URL="https://your-workspace.us1.alpacon.io"
export PLUGIN_ID="your-server-id"
export PLUGIN_KEY="your-server-key"
 
# Optional
export ALPACON_SSL_VERIFY="true"      # SSL certificate verification
export ALPACON_CA_CERT="/path/to/ca.crt"  # CA certificate path
export PLUGIN_DEBUG="false"           # Enable debug logging

Proxy configuration

If your server is behind a proxy, set the HTTP proxy environment variables before running the install command or alpamon register:

bash
export http_proxy="http://proxy.example.com:8080"
export https_proxy="http://proxy.example.com:8080"
Note

Use the lowercase form (http_proxy / https_proxy)—the workspace-generated command and the system package manager read these. The -EH flags in sudo -EH then preserve them for the installation process.

These variables reach only the commands you run from that shell. The installed agent service does not inherit them; to send the agent’s connections through the proxy, see Proxy support.

Last updated: