# Quickstart

> Go from a fresh account to a protected server with live metrics in the console — install the OpenShield agent, enable metrics, and connect it.
>
> Canonical: https://xdp.network/docs/getting-started/quickstart · Updated 2026-08-09

This quickstart takes you from an empty account to a server streaming live metrics into
the console. It takes about ten minutes: install the OpenShield agent, switch on its
metrics endpoint, then add the server in the dashboard.

## Before you start

You need a Linux server you own (a recent kernel with XDP support), root or sudo access,
and an XDP.NETWORK account with an OpenShield product assigned to it. If a product you
bought is missing from the dashboard, open a ticket and we will attach it.

## 1. Install the agent

:::tabs
```bash title="Ubuntu / Debian"
curl -fsSL https://get.xdp.network/openshield | sudo sh
```

```bash title="RHEL / Rocky"
curl -fsSL https://get.xdp.network/openshield | sudo sh
```
:::

The installer drops the `openshield` binary, a systemd unit, and a default config at
`/etc/openshield/openshield.yaml`. Check that the agent attached to your interface:

```bash
openshield status
```

## 2. Enable metrics

The console reads your server through the agent's metrics API, which is off by default.
Enable it and restrict who can query it:

```yaml title="/etc/openshield/openshield.yaml"
metrics:
  enabled: true
  listen: 0.0.0.0:9100
  whitelist:
    - 203.0.113.0/24   # replace with the console egress range from your dashboard
```

```bash
openshield reload
```

:::warning
Without a `metrics.whitelist` entry your metrics endpoint is open to anyone who can reach
the port. Always restrict it.
:::

## 3. Get the credentials

```bash
openshield key
```

This prints the metrics API URL and an API key (starting with `osk_`). Treat the key like
a password — anyone holding it can read your server's metrics.

## 4. Add the server in the console

Open your product page in the dashboard and choose **Add server**. Paste the URL and key,
run **Test connection** (the console calls `/health` on the agent), then save. Within a
few seconds the server row turns green and live traffic appears.

## Next steps

- [Enabling metrics (full reference)](/docs/openshield-xdp/enabling-metrics)
- [Connecting a server to the dashboard](/docs/openshield-xdp/connecting-a-server)
- [Server shows offline](/docs/troubleshooting/server-shows-offline)