Deploy the connector

The connector is a single container. It uses your enrollment token to securely register with the Acme cloud.

Before you begin

You have the prerequisites in place.
You have an enrollment token from the portal (Connectors > Add connector).
You know your region: us, eu or apac.

Install

Create a folder on your host, for example acme-connector, and open a terminal in it.

Create a file named docker-compose.yml with this content:

services:
  acme-connector:
    image: registry.acme-service.example/connector:1.4
    container_name: acme-connector
    restart: unless-stopped
    environment:
      ACME_ENROLLMENT_TOKEN: ${ACME_ENROLLMENT_TOKEN}
      ACME_REGION: us
      ACME_CONNECTOR_NAME: production-network
    ports:
      - "127.0.0.1:8080:8080"
    volumes:
      - acme-data:/var/lib/acme
volumes:
  acme-data:

Create a file named .env in the same folder and add your token:
Terminal window
```
ACME_ENROLLMENT_TOKEN=paste-your-token-here
```
Start the connector:
Terminal window
```
docker compose up -d
```

docker run -d \
  --name acme-connector \
  --restart unless-stopped \
  -e ACME_ENROLLMENT_TOKEN=paste-your-token-here \
  -e ACME_REGION=us \
  -e ACME_CONNECTOR_NAME=production-network \
  -p 127.0.0.1:8080:8080 \
  -v acme-data:/var/lib/acme \
  registry.acme-service.example/connector:1.4

docker run -d `
  --name acme-connector `
  --restart unless-stopped `
  -e ACME_ENROLLMENT_TOKEN=paste-your-token-here `
  -e ACME_REGION=us `
  -e ACME_CONNECTOR_NAME=production-network `
  -p 127.0.0.1:8080:8080 `
  -v acme-data:/var/lib/acme `
  registry.acme-service.example/connector:1.4

Verify

Check the container is running:
Terminal window
```
docker ps --filter name=acme-connector
```
Check its health:
Terminal window
```
curl http://localhost:8080/healthz
```
A healthy connector replies ok.
In the portal, open Connectors. Your connector shows as Connected within about a minute.

Settings

Variable	Required	Default	Description
`ACME_ENROLLMENT_TOKEN`	Yes	None	One-time token from the portal.
`ACME_REGION`	Yes	None	Region for your organisation: `us`, `eu` or `apac`.
`ACME_CONNECTOR_NAME`	No	Host name	Friendly name shown in the portal.
`ACME_LOG_LEVEL`	No	`info`	`error`, `warn`, `info` or `debug`.
`ACME_PROXY_URL`	No	None	Outbound proxy, for example `http://proxy.example.local:3128`.

Update the connector

docker compose pull
docker compose up -d

Your enrollment is kept in the acme-data volume, so you do not need a new token.

Next step

Connect data sources