Menu AuthGuardHelp centre
Portuguêsauthguard.pt

Administrators · Edge appliance

Install the Edge appliance (Docker or systemd)

  • 2 min read
  • SaaS · Self-hosted · Edge
  • Video
Tutorial 03Install the Edge appliance2:14 · Narrated in Portuguese, with English captions.Transcript and details

The Edge appliance is an agent that runs in your network and connects to the service with outbound HTTPS only. Today it serves privileged access (recorded SSH sessions). It runs as a Docker container (Linux x86_64) or a systemd service (Debian 12/13, Ubuntu 24.04).

Before you start

  1. In the console, create the appliance and note the Edge URL, the organization and the enrolment code (see Enrol the appliance). The code lasts 30 minutes and works once.
  2. Create the host secret: 32 random bytes that seal the appliance's keys. Keep it out of the image and include it in the volume's backups; without it the appliance must be enrolled again.
sudo install -d -m 0700 /etc/authguard-edge
openssl rand -hex 32 | sudo tee /etc/authguard-edge/host.key >/dev/null
sudo chmod 0600 /etc/authguard-edge/host.key

Network

DirectionPortPurpose
Outbound443 to the Edge URLEnrolment, configuration, audit and health (mutual TLS)
Outbound443 to the recordings storage (S3 region)Session recordings
OutboundThe targets' ports (SSH 22, …)Sessions
Inbound2222/tcpssh -p 2222 <lease>@<appliance>
Inbound9443/tcp (usually published as 443)Web terminal
Inbound8443/tcp, management networks onlyStatus page

Docker

Run the container with the persistent volume, the secret mounted read-only, the variables AUTHGUARD_EDGE_URL, AUTHGUARD_EDGE_TENANT, AUTHGUARD_EDGE_ENROLMENT_CODE and AUTHGUARD_EDGE_PUBLIC_URL, the ports above and a read-only filesystem. The full command is what the console copies with «Copy command». Then docker logs authguard-edge shows the confirmation code.

systemd

Install the authguard-edge binary, the system user, the environment file and the unit, and enable it. The confirmation code appears in journalctl -u authguard-edge.

Updating

Pull the new image and recreate the container with the same volume and secret. No new code is needed.

Diagnostics

docker exec authguard-edge authguard-edge diag shows the version, the key custody («Keys in software (no TPM)» in Docker) and the agent's status.

Error codes in this article

Article referencead-edge-installquote it to support to identify this article. Checked against the product at commit 5f6607a8.