Skip to content

redcarbon-dev/redcarbon-agent

Repository files navigation


Table of Contents
  1. About The Project
  2. Getting Started

About The Project

This is the repository containing the source code of the RedCarbon Agent.

Getting Started

To build the Agent you need:

  • Go 1.24 or later. You'll also need to set your $GOPATH and have $GOPATH/bin in your path.

Installation

To install the RedCarbon Agent, you mast download the latest release you can find at the following page.

We support Linux and MacOS. The binary is statically linked, so you don't need to install any dependencies.

After the download, you can configure the agent by using the 'profile.sh' utility script. This script is used to handle profiles within the agent. You can create, delete and list profiles.

Profiles are associated with a specific agent token.

For adding a new profile, you can use the following command:

./profile.sh add -t <agent_token> <profile_name>

Next, you can start the agent by using the 'svc.sh' utility script. This script is used to install, start, stop and remove the agent as a systemd service daemon.

The script must be run with root privileges, but it is recommended to specify a user to run the agent. This user must have the right permissions to access the downloaded files.

To install the agent as a systemd service, you can use the following command:

sudo ./svc.sh install <user>

Update

The agent supports automatic updates. The agent will check for updates every 24 hours and will download the latest version if available.

Manual Update

We suggest to use the automatic update feature, but if you want you can update the agent manually, in case of problems.

For executing the update, you need to stop the agent before and then substitute the binary with the new one. After that, you can start the agent again.

It will keep the same configuration as before, so you don't need to worry about it.

About

The source code of the RedCarbon Agent

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •