Back to app
Docs
Documentation
Guía do usuarioComo verificar o teu dominioQue é a delegación CNAME?

Set Up the Agent

Install the QuietLS agent on your server — VPS or Docker — and verify it's running.

Setup with an AI Agent (Fastest)

The quickest way to get the agent running is to let an AI assistant handle it for you.

Copy the prompt below and paste it into Claude, ChatGPT, or any AI agent of your choice. The AI will read the raw setup instructions and install the agent automatically:

The AI will open the documentation link, get the markdown text directly, and execute the correct installation steps for your server.


What the Agent Does

The QuietLS agent is a lightweight daemon that runs on your server. It connects to the QuietLS backend, reports your server's OS and web server configuration, and receives commands to manage SSL certificates, reload web servers, and run security checks. Once installed and registered, you can assign domains to it from the dashboard.

Prerequisites

  • A server running Ubuntu 20.04+, Debian 11+, or CentOS 7/8 (or compatible distributions).
  • Root or sudo access.
  • Outbound HTTPS (port 443) to api.quietls.com.
  • For Docker installs: Docker and Docker Compose installed.

Option 1: Install on a VPS (Ubuntu / Debian)

Run the following command on your server, replacing <TOKEN> with the setup token from your QuietLS dashboard:

SSL_AGENT_TOKEN=<TOKEN> \
curl -sSL https://api.quietls.com/install \
| python3 -

The installer will:

  1. Detect your OS and architecture.
  2. Download the ssl-agent binary and verify its checksum.
  3. Create a system user and config directory.
  4. Register the agent with QuietLS using your token.
  5. Install and start the systemd service.

Option 2: Install with Docker Compose

Choose the variant that matches your reverse proxy.

Nginx (certbot)

Use this if you run Nginx with Let's Encrypt certificates stored in the default certbot directory:

version: '3.8'
services:
  quietls-agent:
    image: quietls/agent:latest
    restart: unless-stopped
    environment:
      - SSL_AGENT_TOKEN=<TOKEN>
    volumes:
      - /etc/letsencrypt:/etc/letsencrypt
      - /var/run/docker.sock:/var/run/docker.sock

Traefik

Use this if you run Traefik as your reverse proxy. It includes the ACME volume for Traefik's own certificate storage:

version: '3.8'
services:
  quietls-agent:
    image: quietls/agent:latest
    restart: unless-stopped
    environment:
      - SSL_AGENT_TOKEN=<TOKEN>
    volumes:
      - /etc/letsencrypt:/etc/letsencrypt
      - /var/run/docker.sock:/var/run/docker.sock
      - traefik-acme:/etc/traefik/acme
volumes:
  traefik-acme:

Caddy

Use this if you run Caddy. Caddy manages certificates internally, so no cert volume mount is needed:

version: '3.8'
services:
  quietls-agent:
    image: quietls/agent:latest
    restart: unless-stopped
    environment:
      - SSL_AGENT_TOKEN=<TOKEN>
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

Configuration Variants

VariantCertificate VolumeWhen to Use
Nginx/etc/letsencrypt:/etc/letsencryptStandard certbot/Let's Encrypt setup
Traefik/etc/letsencrypt + traefik-acmeTraefik with ACME resolver
CaddyNone (certs managed internally)Caddy auto-HTTPS

docker.sock is always mounted so the agent can detect running containers and web server configuration.

Post-Install Verification

After installing, check that the agent is running:

VPS (systemd):

systemctl status ssl-agent

Docker:

docker compose logs quietls-agent

You should see a log line confirming the agent connected to QuietLS. In the dashboard, the agent status will change from "Waiting for connection" to "Online" and you can proceed to assign domains.

Assign Domains

Once the agent is connected:

  1. In the QuietLS dashboard, go to Agents.
  2. Find your new agent and click Assign Domains.
  3. Select the domains this agent should manage and confirm.

You can also assign domains later from the agents table at any time.