# tunguard/tanguard-binary architecture

> Architecture diagram of the GitHub repository tunguard/tanguard-binary, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tunguard/tanguard-binary
- Repository: https://github.com/tunguard/tanguard-binary

## Overview

TunGuard is a self-hosted connectivity control plane with a web dashboard. The principal workflow is an operator provisioning peers, then managing access and connectivity through the dashboard; the runtime also provides mesh links, TCP relay, domain HTTPS, DNS filtering, and SSH access. The graph follows the sampled startup, route, and service relationships. Some UI-to-API and unsampled subsystem links are documented capabilities rather than inspected call sites, so those links are dashed and unverified.

Main entry points: [`api/api.go`](https://github.com/tunguard/tanguard-binary/blob/main/api/api.go) (HTTP API), [`main.go`](https://github.com/tunguard/tanguard-binary/blob/main/main.go) (Server Startup), [`p2p/mesh.go`](https://github.com/tunguard/tanguard-binary/blob/main/p2p/mesh.go) (P2P Mesh), [`api/policy_routes.go`](https://github.com/tunguard/tanguard-binary/blob/main/api/policy_routes.go) (Policy Routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Runtime"]
  node_runtime["Server Startup<br/>[main.go]"]
  node_config["Configuration<br/>[config.go]"]
  node_api["HTTP API<br/>[api.go]"]
end

subgraph group_identity["Identity and Policy"]
  node_auth["Dashboard Auth<br/>[webcred.go]"]
  node_apikey["API Keys<br/>[apikey.go]"]
  node_policyapi["Policy Routes<br/>[policy_routes.go]"]
  node_policy[("Group Policy<br/>[policy.go]")]
end

subgraph group_network["Peer Connectivity"]
  node_peers[("Peer Registry<br/>[peer_store.go]")]
  node_wireguard["WireGuard<br/>[wg.go]"]
  node_monitor["Peer Monitor<br/>[peer_monitor.go]"]
  node_meshapi["Mesh Routes<br/>[mesh_routes.go]"]
  node_mesh["P2P Mesh<br/>[mesh.go]"]
  node_p2p["P2P Transport<br/>[p2p.go]"]
end

subgraph group_services["Network Services"]
  node_trp["TCP Relay<br/>[trp.go]"]
  node_domainapi["Domain Routes<br/>[domain_routes.go]"]
  node_domains[("Domain HTTPS<br/>[domain.go]")]
  node_adguardapi["DNS Routes<br/>[adguard_routes.go]"]
  node_adguard["AdGuard DNS<br/>[adguard.go]"]
end

subgraph group_dashboard["Web Dashboard"]
  node_dashboard["Dashboard UI<br/>[dashboard.js]"]
  node_peerui["Peer Management UI<br/>[peers.js]"]
  node_meshui["Mesh UI<br/>[p2p.js]"]
  node_policyui["Policy UI<br/>[policy.js]"]
  node_domainui["Domain UI<br/>[domains.js]"]
end

node_operator(("Operator"))

node_operator -->|"manages"| node_dashboard
node_dashboard -.->|"opens peers"| node_peerui
node_peerui -.->|"requests peer operations"| node_api
node_operator -->|"provisions devices"| node_peerui
node_runtime -->|"loads"| node_config
node_runtime -->|"starts"| node_api
node_runtime -->|"starts"| node_wireguard
node_runtime -->|"starts"| node_mesh
node_runtime -->|"starts"| node_adguard
node_runtime -->|"loads credentials"| node_auth
node_runtime -->|"starts"| node_monitor
node_api -.->|"guards routes"| node_auth
node_api -.->|"authenticates automation"| node_apikey
node_api -.->|"registers routes"| node_policyapi
node_policyapi -->|"manages groups"| node_policy
node_policyapi -->|"looks up peers"| node_peers
node_policyui -.->|"manages groups"| node_api
node_api -.->|"registers routes"| node_meshapi
node_meshapi -->|"controls mesh"| node_mesh
node_mesh -->|"releases mappings"| node_trp
node_trp -->|"sends node commands"| node_mesh
node_meshui -.->|"manages mesh"| node_api
node_api -.->|"registers routes"| node_domainapi
node_domainapi -->|"manages mappings"| node_domains
node_domains -->|"resolves relay targets"| node_trp
node_domains -->|"uses DNS service"| node_adguard
node_domainui -.->|"manages domains"| node_api
node_api -.->|"registers routes"| node_adguardapi
node_adguardapi -->|"controls service"| node_adguard
node_dashboard -.->|"views status"| node_api
node_wireguard -.->|"uses peer registry"| node_peers
node_monitor -.->|"monitors peers"| node_wireguard

click node_runtime "https://github.com/tunguard/tanguard-binary/blob/main/main.go"
click node_config "https://github.com/tunguard/tanguard-binary/blob/main/config/config.go"
click node_api "https://github.com/tunguard/tanguard-binary/blob/main/api/api.go"
click node_auth "https://github.com/tunguard/tanguard-binary/blob/main/auth/webcred.go"
click node_apikey "https://github.com/tunguard/tanguard-binary/blob/main/auth/apikey.go"
click node_peers "https://github.com/tunguard/tanguard-binary/blob/main/peers/peer_store.go"
click node_wireguard "https://github.com/tunguard/tanguard-binary/blob/main/wg/wg.go"
click node_monitor "https://github.com/tunguard/tanguard-binary/blob/main/wg/peer_monitor.go"
click node_policyapi "https://github.com/tunguard/tanguard-binary/blob/main/api/policy_routes.go"
click node_policy "https://github.com/tunguard/tanguard-binary/blob/main/policy/policy.go"
click node_meshapi "https://github.com/tunguard/tanguard-binary/blob/main/api/mesh_routes.go"
click node_mesh "https://github.com/tunguard/tanguard-binary/blob/main/p2p/mesh.go"
click node_p2p "https://github.com/tunguard/tanguard-binary/blob/main/p2p/p2p.go"
click node_trp "https://github.com/tunguard/tanguard-binary/blob/main/trp/trp.go"
click node_domainapi "https://github.com/tunguard/tanguard-binary/blob/main/api/domain_routes.go"
click node_domains "https://github.com/tunguard/tanguard-binary/blob/main/domain/domain.go"
click node_adguardapi "https://github.com/tunguard/tanguard-binary/blob/main/api/adguard_routes.go"
click node_adguard "https://github.com/tunguard/tanguard-binary/blob/main/adguard/adguard.go"
click node_dashboard "https://github.com/tunguard/tanguard-binary/blob/main/webui/dashboard.js"
click node_peerui "https://github.com/tunguard/tanguard-binary/blob/main/webui/peers.js"
click node_meshui "https://github.com/tunguard/tanguard-binary/blob/main/webui/p2p.js"
click node_policyui "https://github.com/tunguard/tanguard-binary/blob/main/webui/policy.js"
click node_domainui "https://github.com/tunguard/tanguard-binary/blob/main/webui/domains.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_runtime,node_config,node_api toneBlue
class node_auth,node_apikey,node_policyapi,node_policy toneAmber
class node_peers,node_wireguard,node_monitor,node_meshapi,node_mesh,node_p2p toneMint
class node_trp,node_domainapi,node_domains,node_adguardapi,node_adguard toneRose
class node_dashboard,node_peerui,node_meshui,node_policyui,node_domainui,node_operator toneIndigo
```

## Components

### Runtime

- [Server Startup](https://github.com/tunguard/tanguard-binary/blob/main/main.go): `main.go`
- [Configuration](https://github.com/tunguard/tanguard-binary/blob/main/config/config.go): `config/config.go`
- [HTTP API](https://github.com/tunguard/tanguard-binary/blob/main/api/api.go): `api/api.go`

### Identity and Policy

- [Dashboard Auth](https://github.com/tunguard/tanguard-binary/blob/main/auth/webcred.go): `auth/webcred.go`
- [API Keys](https://github.com/tunguard/tanguard-binary/blob/main/auth/apikey.go): `auth/apikey.go`
- [Policy Routes](https://github.com/tunguard/tanguard-binary/blob/main/api/policy_routes.go): `api/policy_routes.go`
- [Group Policy](https://github.com/tunguard/tanguard-binary/blob/main/policy/policy.go): `policy/policy.go`

### Peer Connectivity

- [Peer Registry](https://github.com/tunguard/tanguard-binary/blob/main/peers/peer_store.go): `peers/peer_store.go`
- [WireGuard](https://github.com/tunguard/tanguard-binary/blob/main/wg/wg.go): `wg/wg.go`
- [Peer Monitor](https://github.com/tunguard/tanguard-binary/blob/main/wg/peer_monitor.go): `wg/peer_monitor.go`
- [Mesh Routes](https://github.com/tunguard/tanguard-binary/blob/main/api/mesh_routes.go): `api/mesh_routes.go`
- [P2P Mesh](https://github.com/tunguard/tanguard-binary/blob/main/p2p/mesh.go): `p2p/mesh.go`
- [P2P Transport](https://github.com/tunguard/tanguard-binary/blob/main/p2p/p2p.go): `p2p/p2p.go`

### Network Services

- [TCP Relay](https://github.com/tunguard/tanguard-binary/blob/main/trp/trp.go): `trp/trp.go`
- [Domain Routes](https://github.com/tunguard/tanguard-binary/blob/main/api/domain_routes.go): `api/domain_routes.go`
- [Domain HTTPS](https://github.com/tunguard/tanguard-binary/blob/main/domain/domain.go): `domain/domain.go`
- [DNS Routes](https://github.com/tunguard/tanguard-binary/blob/main/api/adguard_routes.go): `api/adguard_routes.go`
- [AdGuard DNS](https://github.com/tunguard/tanguard-binary/blob/main/adguard/adguard.go): `adguard/adguard.go`

### Web Dashboard

- [Dashboard UI](https://github.com/tunguard/tanguard-binary/blob/main/webui/dashboard.js): `webui/dashboard.js`
- [Peer Management UI](https://github.com/tunguard/tanguard-binary/blob/main/webui/peers.js): `webui/peers.js`
- [Mesh UI](https://github.com/tunguard/tanguard-binary/blob/main/webui/p2p.js): `webui/p2p.js`
- [Policy UI](https://github.com/tunguard/tanguard-binary/blob/main/webui/policy.js): `webui/policy.js`
- [Domain UI](https://github.com/tunguard/tanguard-binary/blob/main/webui/domains.js): `webui/domains.js`

### Other components

- **Operator**

## Connections

- Operator → Dashboard UI: manages
- Dashboard UI → Peer Management UI: opens peers
- Peer Management UI → HTTP API: requests peer operations
- Operator → Peer Management UI: provisions devices
- Server Startup → Configuration: loads (evidence: `main.go`)
- Server Startup → HTTP API: starts (evidence: `main.go`)
- Server Startup → WireGuard: starts (evidence: `main.go`)
- Server Startup → P2P Mesh: starts (evidence: `main.go`)
- Server Startup → AdGuard DNS: starts (evidence: `main.go`)
- Server Startup → Dashboard Auth: loads credentials (evidence: `main.go`)
- Server Startup → Peer Monitor: starts (evidence: `main.go`)
- HTTP API → Dashboard Auth: guards routes
- HTTP API → API Keys: authenticates automation
- HTTP API → Policy Routes: registers routes
- Policy Routes → Group Policy: manages groups (evidence: `api/policy_routes.go`)
- Policy Routes → Peer Registry: looks up peers (evidence: `api/policy_routes.go`)
- Policy UI → HTTP API: manages groups
- HTTP API → Mesh Routes: registers routes
- Mesh Routes → P2P Mesh: controls mesh (evidence: `api/mesh_routes.go`)
- P2P Mesh → TCP Relay: releases mappings (evidence: `p2p/mesh.go`)
- TCP Relay → P2P Mesh: sends node commands (evidence: `trp/trp.go`)
- Mesh UI → HTTP API: manages mesh
- HTTP API → Domain Routes: registers routes
- Domain Routes → Domain HTTPS: manages mappings (evidence: `api/domain_routes.go`)
- Domain HTTPS → TCP Relay: resolves relay targets (evidence: `domain/domain.go`)
- Domain HTTPS → AdGuard DNS: uses DNS service (evidence: `domain/domain.go`)
- Domain UI → HTTP API: manages domains
- HTTP API → DNS Routes: registers routes
- DNS Routes → AdGuard DNS: controls service (evidence: `api/adguard_routes.go`)
- Dashboard UI → HTTP API: views status
- WireGuard → Peer Registry: uses peer registry
- Peer Monitor → WireGuard: monitors peers
