> ## Documentation Index
> Fetch the complete documentation index at: https://docs-xcor.paloaltonetworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the CXDOT Collector on Linux

> Install the CXDOT Collector in a supported Linux environment.

export const MyTenant = () => <>
    Replace <em><code>TENANT</code></em> with the name of your Cortex XCOR tenant.
  </>;

Install the CXDOT Collector on Linux to collect telemetry data and send that
telemetry data to Palo Alto Networks Cortex XCOR.

## Supported environments and distributions

The CXDOT Collector supports Linux environments with either x86\_64 (AMD64) or
ARM64 architecture, on distributions based on Linux kernel version 3.2 or later.

## Prerequisites

Before installing the CXDOT Collector on Linux, you must meet these
prerequisites:

* You must have `curl` installed.
* You must have `tar` installed.
* You must have either `sha256sum` or `shasum` installed.
* You must have an API token from a
  [restricted service account](/administer/accounts-teams/service-accounts#create-a-restricted-service-account)
  with a write-only scope.

## Install

To install the CXDOT Collector on Linux, follow these steps.

<Note>
  For a long-running deployment, install the CXDOT Collector in a stable location, and
  use your distribution's service manager to run the Collector.
</Note>

1. Run the following command to download and install the CXDOT Collector:

   ```shell theme={null}
   CXDOT_COLLECTOR_VERSION="VALUE"
   curl -fsSL "https://artifactregistry.googleapis.com/download/v1/projects/chronosphereio/locations/us/repositories/release-binaries/files/cxdot-collector%3A${CXDOT_COLLECTOR_VERSION}%3Acxdot-collector-install.sh:download?alt=media" | sh
   ```

   Replace *`VALUE`* with the version of the CXDOT Collector to use (for
   example, `1.4.0+otel-0.157.0`).

   This script creates `cxdot-collector` and `cxdot-admin` in `/usr/local/bin`,
   and an example configuration file and a software license in
   `/usr/local/share/cxdot-collector`. The script requests `sudo` access if these
   directories aren't writable.

2. Run the following command to make a copy of the example configuration file:

   ```shell theme={null}
   cp /usr/local/share/cxdot-collector/config-example.yaml ./config.yaml
   ```

3. In the environment where the CXDOT Collector is deployed, create an environment
   variable named `XCOR_API_TOKEN`, and set its value to your Cortex XCOR API
   token.

4. Add the `api_token` key to your YAML configuration file, and set its value to
   `${env:XCOR_API_TOKEN}`:

   ```yaml title="config.yaml" theme={null}
   cxdot:
     egress:
       tenant:
         api_token: ${env:XCOR_API_TOKEN}
   ```

5. Set the name of your Cortex XCOR tenant by adding the following key to your YAML
   configuration file:

   ```yaml title="config.yaml" theme={null}
   cxdot:
     egress:
       tenant:
         org_name: TENANT
   ```

   <MyTenant />

6. Run the following command to start the CXDOT Collector:

   ```shell theme={null}
   cxdot-collector --config ./config.yaml
   ```

   The CXDOT Collector writes logs to `stdout`. To confirm that the Collector is
   running, look for the message `Everything is ready`.

   Additionally, you can confirm whether
   [host metrics](/ingest/xcor/integrations/collector/host) appear in your
   Cortex XCOR tenant. The CXDOT Collector's default configuration collects telemetry
   data from your host environment, like information about memory, network activity,
   and uptime. If these metrics appear in your tenant, that means the Collector
   started up successfully.

After you install the CXDOT Collector, the Collector uses the
[Host](/ingest/xcor/integrations/collector/host)
integration to collect operating system metrics from your Linux host. Configure this
integration to customize or disable its behavior.

## Upgrade

To upgrade the CXDOT Collector to a new version, run the same command that you used
to [install](#install) the Collector:

```shell theme={null}
CXDOT_COLLECTOR_VERSION="VALUE"
curl -fsSL "https://artifactregistry.googleapis.com/download/v1/projects/chronosphereio/locations/us/repositories/release-binaries/files/cxdot-collector%3A${CXDOT_COLLECTOR_VERSION}%3Acxdot-collector-install.sh:download?alt=media" | sh
```

Replace *`VALUE`* with the new version of the CXDOT Collector to use (for
example, `1.4.0+otel-0.157.0`).


## Related topics

- [CXDOT Collector](/ingest/xcor/collector.md)
- [Install the CXDOT Collector in a Kubernetes cluster](/ingest/xcor/collector/install/kubernetes.md)
- [Install the CXDOT Collector on Windows](/ingest/xcor/collector/install/windows.md)
- [Debug the CXDOT Collector](/ingest/xcor/collector/debug.md)
- [Install the Chronosphere Collector](/ingest/metrics-traces/collector/install.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.