Agent installation

Install the agent on your nodes to connect them to ConfigX.

The ConfigX agent is free and open-source. Check out the project on GitHub.

About the agent

The ConfigX agent is a monitoring and configuration agent that can be installed on your nodes.

Nodes can be physical/virtual servers, containers, cloud deployments, and edge/IoT devices. The agent runs on most Linux distributions (Ubuntu, Debian, CentOS, and more) and Docker.

By installing the agent, you will connect to the server to your ConfigX team. You will then be able to manage and monitor them from the control panel.

ConfigX is still in active development. We do not recommend installing the agent on production systems at this time.

Installation

Click Add nodes in your node overview to retrieve installation instructions.

One-line installation script

The recommended way to install the ConfigX agent is by using our one-line install script. You must have sudo or root access.

curl

wget -O /tmp/cfgx-setup.sh https://api.configx.com/install.sh && sudo sh /tmp/cfgx-setup.sh --setup-key YOUR_SETUP_KEY

wget

The installation script will automatically perform the following tasks:

1. Download the latest stable binary for your distribution

2. Create a cfgx user and set up the cfgx-agent service

3. Perform setup and register with the ConfigX server

4. Start the service

You can review the contents of the script by opening https://api.configx.com/install.sh in a text editor.

Your setup key will be shown in the instructions under the "Add nodes" screen.

Manual installation

If you prefer to manually install the agent, you can download binaries or build from source. Retrieve your setup key from the instructions, then manually set up the service and perform setup:

cfgx setup YOUR_SETUP_KEY

What's next?

Once you have installed the agent, your node should appear in the node overview. Within a few minutes, metrics and data will be reported.