Skip to content
Airdress Airdress Airdress Docs

Quickstart

Install the Airdress operator, start it, and confirm it is running. This takes about five minutes. You will not need a cloud account or any port-forwarding configuration.

  1. Install the operator

    The installer downloads the latest stable airdress-operator binary, verifies the SHA-256 checksum, and places it on your PATH.

    Terminal window
    curl -fsSL https://get.airdress.co/operator | sh

    The script detects your OS and architecture automatically. On Linux it also offers .deb and .rpm packages when a supported package manager is present.

    Confirm the binary is available:

    Terminal window
    airdress-operator --version

    You should see output like:

    airdress-operator 0.x.y

  2. Start the operator

    Launch the operator with its default settings. It establishes a WireGuard tunnel to the nearest Airdress relay and starts an HTTP listener:

    Terminal window
    airdress-operator serve

    You should see log output indicating the tunnel is up:

    INFO  operator ready  bind=127.0.0.1:8080  wg_port=51820

    The operator runs in the foreground. Leave this terminal open.

  3. Verify the operator is healthy

    Open a second terminal and run:

    Terminal window
    airdress-operator health

    Or query the health endpoint directly:

    Terminal window
    curl http://127.0.0.1:8080/healthz

    A healthy response confirms the operator is running and its tunnel to the relay PoP is established.

Next steps

Section titled “Next steps”
Your First Tunnel Expose a local web server through the relay and understand the traffic flow.
CLI Reference All commands, flags, and environment variables for airdress-operator.
Configuration Customize the operator with a TOML config file.