Skip to content
ConduitConduit

Legacy: v1 container per site

Each v1 site runs the conduit-onprem-gateway image, pinned by digest. It dials the WYRE relay over WSS and opens no inbound port. This page adds a Helm chart, a Compose file and RMM snippets so you can push the container to many sites.

Value Where it comes from
Enrollment token Minted by your Conduit operator with POST /admin/tunnel/enrollment-token, passing subtenantId and capabilities. Treat it as a secret.
RELAY_URL Defaults to wss://conduit-wss.wyre.ai.
CAPABILITIES Must be non-empty, and every capability must be granted by the token. The default echo is the connectivity proof.

The token is never baked into the image, the chart, or the Compose file. It reaches the container only as an environment variable from a Kubernetes Secret or a .env file.

The chart lives in deploy/helm/conduit-tunnel in the conduit repository. Create one Secret per client site (name it after the site, so two sites in the same namespace never share a token), then install:

Terminal window
kubectl create secret generic site-acme-tunnel-token \
--from-literal=ENROLLMENT_TOKEN="$ENROLLMENT_TOKEN"
helm install site-acme ./deploy/helm/conduit-tunnel \
--set existingSecret=site-acme-tunnel-token

Use existingSecret for anything beyond a throwaway test. The alternative, --set token="$ENROLLMENT_TOKEN", stores the token in plaintext in Helm’s release values, so every helm get values call and every release revision Secret in the namespace returns it. Do not put the token in a values file you commit.

The chart runs one replica with restartPolicy: Always, a liveness probe, CPU and memory limits, a non-root user, and the image pinned by image.digest.

Check the gateway came up:

Terminal window
kubectl logs deploy/site-acme-conduit-tunnel | grep 'on-prem-gateway ready'

Save this as docker-compose.yml (it is the same digest-pinned file as docker-compose.onprem.yml in the repository):

services:
onprem-gateway:
image: ghcr.io/wyre-technology/conduit-onprem-gateway@sha256:ee80a6305df168e53a6e7c41b949bdacada021dd29a11b73c53c625e5e1e84d4
restart: unless-stopped
env_file:
- .env
# No `ports:` clause. The gateway is outbound-only.

Create .env next to it, then start:

Terminal window
umask 077
cat > .env <<EOF
RELAY_URL=wss://conduit-wss.wyre.ai
ENROLLMENT_TOKEN=$ENROLLMENT_TOKEN
CAPABILITIES=echo
EOF
docker compose up -d

Both snippets assume your RMM injects the token as the ENROLLMENT_TOKEN environment variable (use its secret or custom-field feature, not a script body that gets logged), and that docker-compose.yml from the section above is already in place in the install folder.

#!/usr/bin/env bash
set -euo pipefail
cd /opt/conduit-tunnel
umask 077
printf 'RELAY_URL=wss://conduit-wss.wyre.ai\nENROLLMENT_TOKEN=%s\nCAPABILITIES=echo\n' "$ENROLLMENT_TOKEN" > .env
docker compose up -d

This needs Docker Desktop or another Docker engine with Compose on the host.

Terminal window
Set-Location C:\conduit-tunnel
@(
'RELAY_URL=wss://conduit-wss.wyre.ai'
"ENROLLMENT_TOKEN=$env:ENROLLMENT_TOKEN"
'CAPABILITIES=echo'
) | Set-Content -Path .env -Encoding ascii
docker compose up -d

Restrict read access on C:\conduit-tunnel\.env to SYSTEM and Administrators.

The enrollment token lives in the Secret or .env, not in the image. To move a site to a newer release, change only the image digest. This works while the token is still valid: the gateway checks token expiry at boot, so if the token has expired the new container exits, and the site needs a freshly minted token (update the Secret or .env) before it reconnects. The current digest is in the latest release notes.

Helm:

Terminal window
helm upgrade site-acme ./deploy/helm/conduit-tunnel \
--reuse-values \
--set image.digest=sha256:<new-digest>

Compose: edit the @sha256:... in docker-compose.yml, then:

Terminal window
docker compose pull && docker compose up -d

Keep the digest pin; do not switch to :latest. Verify the image you pulled first with the cosign command in the Quickstart.

See Tunnels troubleshooting. The gateway refuses to start, and names the missing variable, if RELAY_URL, ENROLLMENT_TOKEN or CAPABILITIES is absent, if RELAY_URL is not wss://, or if the token has expired.