How donaldzou/wgdashboard works
WGDashboard is a web application for managing WireGuard configurations and peers, with separate administrator and end-user interfaces. An administrator uses the dashboard to inspect and change configurations; the server-side API delegates configuration operations to WireGuard management code, which interacts with WireGuard and persists dashboard data. The end-user portal supports account access and peer configuration. The README establishes the product purpose and major features; where frontend-to-API wiring or unsampled subsystem behavior is not shown, those links are marked unverified.
Main entry points: dashboard.py Dashboard API · WireguardConfiguration.py Configuration manager · DashboardClients.py Client accounts · client.py Client API
Components 22
Web interfaces
- Admin dashboard
src/static/app/src/App.vue - Client portal
src/static/client/src/App.vue
HTTP services
- Dashboard API
src/dashboard.py - Client API
src/client.py
WireGuard management
- Configuration manager
src/modules/WireguardConfiguration.py - Amnezia support
src/modules/AmneziaConfiguration.py - Peer management
src/modules/Peer.py - Peer jobs
src/modules/PeerJobs.py
Accounts and sharing
- Client accounts
src/modules/DashboardClients.py - Peer assignments
src/modules/DashboardClientsPeerAssignment.py - TOTP tokens
src/modules/DashboardClientsTOTP.py - Peer sharing
src/modules/PeerShareLinks.py
Persistence and integrations
- Dashboard settings
src/modules/DashboardConfig.py - Dashboard database
src/modules/DatabaseConnection.py - Webhooks
src/modules/DashboardWebHooks.py - System status
src/modules/SystemStatus.py - Email delivery
src/modules/Email.py
Other components
- Administrator
- Client user
- WireGuard service
- Email service
- OIDC provider
Connections 30
- Administrator → Admin dashboard: uses
- Client user → Client portal: uses
- Admin dashboard → Dashboard API: calls API
- Client portal → Client API: calls API
- Dashboard API → Configuration manager: manages configs
src/dashboard.py - Dashboard API → Amnezia support: routes operations
src/dashboard.py - Dashboard API → Peer jobs: handles jobs
src/dashboard.py - Dashboard API → Peer sharing: handles sharing
src/dashboard.py - Dashboard API → Client accounts: handles clients
src/dashboard.py - Dashboard API → Webhooks: uses hooks
src/dashboard.py - Dashboard API → System status: reports status
src/dashboard.py - Client API → Client accounts: authenticates users
src/client.py - Client API → Dashboard settings: checks settings
src/client.py - Client API → Email delivery: sends reset email
src/client.py - Configuration manager → WireGuard service: controls VPN
- Configuration manager → Peer management: manages peers
src/modules/WireguardConfiguration.py - Configuration manager → Peer jobs: uses peer jobs
src/modules/WireguardConfiguration.py - Configuration manager → Peer sharing: uses share links
src/modules/WireguardConfiguration.py - Configuration manager → Webhooks: fires hooks
src/modules/WireguardConfiguration.py - Amnezia support → Configuration manager: uses configuration
src/modules/AmneziaConfiguration.py - Client accounts → Peer assignments: uses assignments
src/modules/DashboardClients.py - Client accounts → TOTP tokens: uses tokens
src/modules/DashboardClients.py - Client accounts → OIDC provider: authenticates via OIDC
- Peer jobs → Configuration manager: looks up peers
src/modules/PeerJobs.py - Peer jobs → Dashboard database: reads and writes
src/modules/PeerJobs.py - Peer sharing → Dashboard database: reads and writes
src/modules/PeerShareLinks.py - Dashboard settings → Dashboard database: reads and writes
src/modules/DashboardConfig.py - Webhooks → Dashboard database: stores hook state
src/modules/DashboardWebHooks.py - Webhooks → Email service: posts webhook
src/modules/DashboardWebHooks.py - Email delivery → Email service: sends messages