Skip to content

Dioad Connect

Dioad Connect provides agent and server commands that together implement SNI-based reverse tunneling and forward tunneling between local services and a Connect Server. The agent can also be used with the hosted service at connect.dioad.dev, which exposes local services to the internet without configuring port forwarding and works behind a proxy.

This site covers using dioad/connect: installing it, configuring and operating the Agent and Server, using the built-in tunnel types, and extending it. Where the hosted connect.dioad.dev service behaves differently from a self-hosted connect server, pages call it out with a Hosted vs. self-hosted note.

Looking for architecture/internals?

Component boundaries, package layout, C4 models, and tracked architectural weaknesses/improvements live in doc/architecture/ — a local-only documentation set for contributors (not published here). Clone the repository and run make docs-serve-architecture to browse it.

Source of truth

This site is generated from the dioad/connect repository's doc/user/ tree and, where noted, directly from the Go source (the CLI reference is generated from the cobra command tree; the config references are checked against the actual config structs by a CI test). Use the "Edit this page" link on any page to propose a change.

Where to start

  • Quickstart — install, authenticate, and run the agent against the hosted connect.dioad.dev service (or your own server).
  • Tunnel Types — configure and use the built-in server types: HTTP reverse proxy, TCP, file sharing, CoreDNS, mail routing, webhook debugging, Docker auto-discovery, and more.
  • Agent Configuration Reference and Server Configuration Reference — every config key, its type, default, and purpose.
  • Authentication — agent identity, server-side JWT validation, and per-tunnel traffic auth.
  • Production Operations and Daemon and OS Service — deployment topologies, observability, secret handling, incident recovery, and running as a systemd/launchd service.
  • Extension Authoring — building custom Tunnel Types and management Extensions against the SDK.
  • Development — building from source, make verify, and the local dev workflow.
  • Cookbook — worked examples (SMTP testing, SSH over a tunnel).
  • CLI Reference — every command and flag.
  • Terminology — precise definitions for Agent, Tunnel, Managed Exec Service, and other terms used throughout both documentation sites.

Project status

This project does not yet publish a LICENSE file. If you're evaluating it for self-hosted or embedded use, check with the maintainer before relying on an implied license.

This is a beta. Reverse/forward tunnelling (HTTP, TCP, file sharing) is the most exercised path, backed by an end-to-end smoke test on every change. Mail routing (SMTP relay, DMARC/TLSRPT aggregate reporting) is newer and has less production mileage. There's no formal SLA; see Production Operations / Rollback for the rollback procedure if something goes wrong after an upgrade.