Installation

Anyport has two parts: the dashboard you log into, and a small agent that runs on your infrastructure. You bring the clusters; we don't sell you infra. The agent is what lets you create projects, deploy apps, and read logs and metrics from Anyport against the clusters you connect. This page covers getting the agent onto a cluster and what it needs.

The CLI does both halves

Connecting a cluster used to be two steps in two places: register it in the dashboard, then paste a command carrying its token. Now it is one:

anyport cluster attach

The CLI registers the cluster and installs the agent in the same process, which is why there is no token to copy. The agent token is created, used, and discarded without ever being displayed or written down — Anyport stores only its hash, so the plaintext genuinely exists nowhere else.

That also means a cluster cannot end up registered with no agent, which was the most common way setup used to go wrong.

What you need

The requirement depends on what you are connecting.

You haveCommandNeeds
A Kubernetes clusteranyport cluster attachA kubeconfig context pointing at it
A container runtimeanyport cluster createDocker, OrbStack, colima or Podman, running
A Linux serveranyport cluster create --dedicatedRoot on the machine, and systemd
A Linux server, set up from hereanyport cluster create --ssh root@hostSSH access to it

You do not need kubectl or Helm installed — the CLI talks to Kubernetes directly. Anyport never installs a container runtime for you; if none is running it names which to install.

For anything with a volume — PostgreSQL, durable Redis, metrics and logs — the cluster also needs a working default StorageClass. See Cluster requirements.

What it installs

Into the cluster: cert-manager, if it is not already there, and the Anyport agent into the anyport namespace. Both are Helm releases, so helm list -A shows them and re-running is how you upgrade.

Onto a dedicated machine, additionally: k3s as a systemd service. Everything written to the machine is recorded in /var/lib/anyport/install-manifest.json, so it can be removed exactly:

anyport cluster detach <name> --purge --dry-run

That prints the precise list before anything is removed. Without --dry-run it performs exactly that list, and never touches a file that was already there or that changed after Anyport wrote it.

Check that it worked

anyport cluster attach waits for the agent to connect and tells you when it has. To look for yourself:

anyport cluster ls

If a cluster stays disconnected, the agent could not reach Anyport: it dials out over gRPC on 443, so an egress firewall or proxy is the usual cause. Every install also writes a full transcript to ~/.anyport/logs/, with the agent token redacted, and a failing step names it.

If you deploy with GitOps

To manage the agent from a repository rather than letting the CLI install it:

anyport cluster attach --print-values

That registers the cluster and prints a complete Helm values file including its token, instead of installing anything. Apply it with the chart however you normally would. It is the one path where the token is displayed, because there is no other way to get it into your repository.

Next steps