---
title: "OS specific installation"
slug: "os-specific"
tags: ["vm", "virtual machine"]
updated: 2025-08-11T09:53:25Z
published: 2025-08-11T09:53:25Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://traceabledocs.document360.io/llms.txt
> Use this file to discover all available pages before exploring further.

# OS specific installation

Traceable's Platform agent receives various information from different tracing agents. The Platform agent is deployed between a tracing agent and the Traceable Platform, collecting data. It also classifies and redacts data. The Platform agent ensures that no sensitive information reaches the Traceable Platform. The Platform agent receives the blocking rule information from the Traceable Platform and sends it to the instrumentation agent.

---

## Before you begin

- **Agent support matrix** — Before proceeding with the installation, view the [Agent Support Matrix](/docs/agent-support-matrix).
- You would require an **Agent token** to proceed with Platform agent installation. Complete the following steps to generate a unique Agent token:
  1. Log in to your Traceable account.
  2. Navigate to **Settings**(![image-1638268402925](https://cdn.document360.io/24f14f07-13d1-4684-8fae-6d8f811768ee/Images/Documentation/image-1638268402925.png)) → **Account**→ **Agent Tokens**.
  3. Click on **Generate Token**.

Copy and save the generated token, as you cannot reaccess it. You can only edit or delete the name of the token. This token is used in the steps detailed below. If this token is deleted from Traceable Platform (UI), the communication between the Traceable Platform agent and Traceable Platform (UI) will break. In such a case, generate and update a new token in the Platform agent.

---

RHEL/Amazon Linx 2 (CentOS)Ubuntu

## **RHEL/Amazon Linux 2 (CentOS)**

The following instructions apply to RHEL (supported major versions) and Amazon Linux 2. These steps will guide you through:

1. Setting up the Traceable repository
2. Selecting the version of the Traceable agent
3. Installing the Traceable agent
4. Configuring the Traceable agent
5. Starting the Traceable agent
6. Verifying the installation

---

### Set up the repository

Enter the following command to set up the Traceable repository:

```bash
sudo vi /etc/yum.repos.d/traceable.repo
```

Paste the following contents (type `i` to enter edit mode):

```ini
[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos[7|8]/
enabled=1
gpgcheck=0
```

Replace `[7|8]` with the version of CentOS/RHEL you are using. Run:

```bash
rpm -E %{rhel}
```

to determine the correct version. For example:

```ini
[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos7/
enabled=1
gpgcheck=0
```

Hold down **Shift + ZZ** to exit the Vi editor.

### Install Traceable agent

```bash
sudo yum install traceable
```

### Configure Traceable agent

#### Set the refresh token

Add the refresh token to the following file (copied from the *Before You Begin* section):

```bash
sudo vi /etc/traceable/agent/token
```

Hold down **Shift + ZZ** to exit Vi editor.

#### Reload systemd

```bash
sudo systemctl daemon-reload
```

#### Set the environment variable

```bash
sudo systemctl edit traceable
```

Enter the following, then exit the editor:

```ini
[Service]
Environment="TA_ENVIRONMENT=<expected environment>"
```

#### Platform agent connection through a proxy

If connecting through a transparent proxy, add the following along with the `TA_ENVIRONMENT` setting:

```ini
Environment="http_proxy=http://<address>:<port>"
Environment="https_proxy=http://<address>:<port>"
```

If credentials are required:

```ini
Environment="https_proxy=http://<username>:<password>@<address>:<port>"
```

### Start Traceable

```bash
sudo systemctl start traceable
```

### Add Traceable to system startup

```bash
sudo systemctl enable traceable && sudo systemctl restart traceable
```

### Verify installation

```bash
systemctl is-active traceable
```

Ensure no `ERROR` logs are present and that a *Started metric exporter* message appears:

```bash
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log
```

## **Ubuntu**

The instructions to install Traceable agent are compatible with Ubuntu 18.04, 20.04, and 22.04. Complete the following steps to install the Traceable agent:

1. Set up the repository
2. Install Traceable agent
3. Configure Traceable agent
4. Start Traceable agent
5. Verify installation

### **Set up the Repository**

```actionscript
sudo apt-get update
```

```actionscript
sudo apt-get install -y ca-certificates
```

```actionscript
sudo echo "deb [trusted=yes] https://packages.traceable.ai/ubuntu/ focal main" | sudo tee -a /etc/apt/sources.list.d/traceable.list
```

```actionscript
sudo apt-get update
```

---

### Install Traceable

```actionscript
sudo apt-get install -y traceable
```

---

### **Configure Traceable**

Configuring Traceable involves the following two steps:

1. Editing the `config.yam` file
2. Reloading `systemd` service

#### **Set the refresh token**

Add the refresh token to the file below

```actionscript
sudo vi /etc/traceable/agent/token
```

#### **Reload systemd**

Enter the following command to reload the `systemd` service:

```actionscript
sudo systemctl daemon-reload
```

#### **Set the environment variable**

Enter the following command to set the environment variable:

```actionscript
sudo systemctl edit traceable
```

Enter the following then exit the editor:

```actionscript
[Service]
Environment="TA_ENVIRONMENT=<expected environment>"
```

Enter the following command to start the Traceable agent:

```actionscript
sudo systemctl start traceable
```

---

### Platform agent connection through a proxy

If the Traceable Platform agent is connecting to the Traceable Platform through a transparent proxy, you can add the following environment variable along with `TA_ENVIRONMENT` setting:

```plaintext
Enviornment = "http_proxy=http://<address>:<port>"
Environment = "https_proxy=http://<address>:<port>"
```

If the proxy server requires a username and password, include the credentials as shown below:

```plaintext
Environment = "https_proxy=http://username:password@<address>:<port>"
```

---

### **Add Traceable to the system startup**

Enter the following command to add a Traceable agent to `systemd` startup:

```actionscript
sudo systemctl enable traceable && sudo systemctl restart traceable
```

---

### **Verify installation**

Enter the following command to verify a successful installation of the Traceable agent:

```actionscript
systemctl is-active traceable
```

Ensure no `ERROR` logs are present,, and a `Started metric exporter` message appears in the logs

```actionscript
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log
```