6ec5133773ae5d60bf8703578a19db5a1cb6d9e7
Expand README with desktop platform requirements (Windows x86, macOS ARM), helper build commands, gateway utility scripts, and updated local test flow. Add realistic MVP usage section clarifying current platform build status, gateway configuration needs, and admin debug profile behavior with client private key handling.
NexaVPN
NexaVPN is a production-oriented, self-hosted WireGuard control plane for remote access. It combines:
- A Go backend and PostgreSQL control plane
- A React admin console
- A Tauri desktop client for Windows and macOS
- WireGuard gateway and firewall policy enforcement
- Docker Compose deployment assets
Monorepo Layout
docs/architecture, schema, API, and deployment designbackend/Go API, migrations, seeds, and domain servicesadmin-web/React + Vite admin UIdesktop-client/Tauri desktop clientdeploy/Docker Compose, reverse proxy, and gateway assets
Phase Status
This repository contains the initial production-minded MVP scaffold:
- Phase 1: architecture, schema, API, enrollment, provisioning, gateway design
- Phase 2: backend scaffold, migrations, auth, CRUD, audit, profile generation
- Phase 3: admin UI scaffold and core pages
- Phase 4: desktop client scaffold, enrollment flow, profile provisioning abstraction
- Phase 5: deployment assets, bootstrap scripts, and hardening notes
Quick Start
- Copy
deploy/.env.exampletodeploy/.env. - Review
docs/architecture.mdanddocs/deployment.md. - Start the stack with Docker Compose from
deploy/. - Open
http://localhost. - On the admin login screen, choose the bootstrap flow if this is a fresh install.
- Create the initial admin, then sign in.
Important MVP Notes
- WireGuard remains the tunnel transport. NexaVPN is the control plane around it.
- Client private keys are generated on-device and are not stored server-side.
- Gateway-side enforcement uses nftables generated from issued policy state.
- The desktop client is structured so NexaVPN is the only user-facing VPN app.
- The tunnel layer still uses WireGuard internally, but the intended delivery model is a NexaVPN-bundled tunnel backend, not a separately used WireGuard app.
Desktop Requirements
- Windows x86: package NexaVPN with the bundled Windows x86 tunnel helper
- macOS ARM: package NexaVPN with the bundled macOS ARM tunnel helper
See client-platforms.md for the current platform strategy.
Helper build commands:
cd desktop-client
npm run helper:windows-x86
npm run helper:macos-arm64
Gateway utility scripts:
./deploy/scripts/generate-gateway-keypair.sh
./deploy/scripts/get-admin-token.sh http://localhost admin your-password
Local Test Flow
cd deploy
cp .env.example .env
docker compose up --build
Then:
- Visit
http://localhost - Bootstrap the first admin account
- Create a standard user in the
Userspage - Create a user policy in the
Policiespage - Enroll a device from the NexaVPN desktop app against
http://localhost - Inspect the generated device profile in the
Devicespage
Realistic MVP Usage
The current repository can act as a real WireGuard control plane and issue per-device peer state, but these platform pieces are still at MVP level:
- the desktop app now targets an embedded NexaVPN tunnel backend model, and the helper source is in-repo, but final platform builds and signing still need to happen per target OS
- the gateway helper now applies WireGuard and nftables state in-container, but you still need to provide the gateway private key and correct uplink interface settings
- admin debug profiles intentionally use a private-key placeholder because the client private key stays local
Description
Languages
Go
39.7%
TypeScript
25.5%
Rust
19.7%
CSS
7.6%
Shell
4.3%
Other
3.2%