Skip to content

Edge Server Management ​

Understand Edge server concepts, architecture, and daily management


What is Edge Server ​

Edge server is YAT network's core node, responsible for:

  • 🔄 Traffic Forwarding — Relay traffic between clients and servers
  • 🔐 mTLS Authentication — Mutual TLS verification
  • 📊 Status Sync — Real-time tunnel status synchronization
  • 🌐 Domain Management — Assign and manage tunnel domains

Why Need Edge? ​

Traditional solution (requires public IP + port forwarding):
  External users → Router configuration → Internal service

YAT solution (no configuration needed):
  External users → Edge server → Internal service

Advantages: No public IP required, no router configuration, automatic encryption, global deployment

Edge Types ​

TypeDescriptionUse Case
Self-built EdgeEdge you deploy yourselfProduction environment, private deployment
Shared EdgeEdge shared by othersTesting, personal use

Architecture & Startup ​

Component Structure ​

Edge Server
├── Configuration File (config.yaml)
├── Certificate Directory (certs/)
│   ├── root-ca.crt         # Root certificate
│   ├── edge-sub-ca.crt     # Edge sub-CA
│   ├── edge-tls.crt        # TLS certificate
│   └── edge-tls.key        # TLS private key
├── Database
│   ├── channels.db         # Channel status
│   └── wireguard.db        # WireGuard configuration
└── Binary (edge)

Startup Process ​

1. Bootstrap - Initialize configuration
2. RegisterNode - Register with Captain
3. Subscribe - Subscribe to control flow
4. Heartbeat - Heartbeat keep-alive

Manage Edge Server ​

View Edge List ​

Click Edges, switch to My tab:

📸 Edge snapshot Edge List Page

Description: Shows Edge cards, status, action buttons

Edge Card Information ​

Each Edge card displays:

  • Name — Edge name
  • Status — Online/Offline (with icon)
  • Public IP — Edge's public IP address
  • Domain — System-assigned domain
  • Tunnel Count — Number of tunnels on this Edge
  • Service Status — Status of various services

Edge Operations ​

View Details ​

Click Details button to view:

  • Basic information
  • Network information (IP, domain)
  • Domain health status
  • Service running status
  • Tunnel list

📸 Edge snapshot Edge Details Page

Manage Configuration ​

Click Manage button (self-built Edge only):

  • Modify name
  • Modify description
  • Restart Edge
  • View deployment commands

Delete Edge ​

Click Delete button:

⚠️ Warning:

  • Deleting Edge will clean up all related tunnels
  • Certificates will be revoked
  • Domains will be released

Monitor Edge Status ​

  • 🟢 Online — Edge running normally
  • 🔴 Offline — Edge unreachable
  • 🟡 Abnormal — Some services abnormal

Domain & Health Check ​

System-Assigned Domain ​

Each Edge is automatically assigned a domain:

Format: {edge-id}.edge.myroxy.dev
Example: abc123.edge.myroxy.dev

Custom Domain ​

You can configure custom domain for Edge:

  1. Add custom domain in Edge management (e.g., edge.example.com)
  2. Add CNAME record pointing to the system-assigned domain
  3. YAT automatically verifies DNS configuration
  4. After verification, Let's Encrypt certificate is applied automatically

Health Check ​

YAT checks Edge domain health every 5 minutes:

StatusDescriptionAction
NormalDNS and certificate both normalNo action needed
DNS AbnormalDNS record has issuesCheck DNS configuration
Certificate AbnormalCertificate expired or invalidRegenerate certificate
UnknownCannot detectCheck Edge connection


YAT Team - Making intranet penetration simpler

Released under the MIT License.