Archived
feat: Remove old apps and get new README
This commit is contained in:
@@ -1,54 +1,41 @@
|
||||
# Vynte Connect
|
||||
# Vynte Connect for Windows
|
||||
|
||||
Vynte Connect is the branded client wrapper for the Vynte NetBird VPN at `https://vpn.vyntehome.com`.
|
||||
Vynte Connect for Windows is a tray wrapper around the bundled `netbird.exe` CLI for `https://vpn.vyntehome.com`.
|
||||
|
||||
This source tree contains:
|
||||
It exposes the same basic flow as the macOS app:
|
||||
|
||||
- `apps/vynte-connect`: macOS 14 SwiftUI menu bar app.
|
||||
- `apps/vynte-connect-windows`: Windows Electron tray app.
|
||||
- `docs/vynte-connect-design-spec.md`: product and UI behavior notes.
|
||||
- `scripts/fetch-netbird-assets.mjs`: fetches the official NetBird runtime assets needed for packaging.
|
||||
- Connect to `vpn.vyntehome.com`
|
||||
- Disconnect the tunnel
|
||||
- Log out so the next connect registers with NetBird again
|
||||
- Show gateway, internal IP, peer count, and connection state
|
||||
|
||||
The apps do not implement VPN networking themselves. They bundle and drive the official NetBird CLI, install/start the local NetBird helper service when needed, then poll `netbird status --json` until the tunnel is ready.
|
||||
## Build
|
||||
|
||||
## Prepare NetBird Assets
|
||||
Place the Windows NetBird runtime files in `resources/` before packaging:
|
||||
|
||||
Downloaded binaries are intentionally ignored by git. Fetch them before packaging:
|
||||
- `resources/netbird.exe`
|
||||
- `resources/wintun.dll`
|
||||
|
||||
```bash
|
||||
node scripts/fetch-netbird-assets.mjs
|
||||
```
|
||||
|
||||
To pin a version:
|
||||
|
||||
```bash
|
||||
NETBIRD_VERSION=v0.71.4 node scripts/fetch-netbird-assets.mjs
|
||||
```
|
||||
|
||||
## macOS
|
||||
|
||||
```bash
|
||||
cd apps/vynte-connect
|
||||
swift build -c release
|
||||
./Scripts/package-zip.sh
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
- `apps/vynte-connect/dist/Vynte Connect.app`
|
||||
- `apps/vynte-connect/dist/Vynte-Connect-macOS.zip`
|
||||
|
||||
## Windows
|
||||
|
||||
```bash
|
||||
cd apps/vynte-connect-windows
|
||||
```powershell
|
||||
npm install
|
||||
npm run package:win
|
||||
```
|
||||
|
||||
Output:
|
||||
The packaged app is written to `dist/Vynte Connect-win32-x64/`, and a portable zip is written to `dist/Vynte-Connect-Windows-x64.zip`.
|
||||
|
||||
- `apps/vynte-connect-windows/dist/Vynte Connect-win32-x64/`
|
||||
- `apps/vynte-connect-windows/dist/Vynte-Connect-Windows-x64.zip`
|
||||
This build intentionally creates a portable Windows app without stamping Windows executable metadata, so it can be built from macOS without Wine.
|
||||
|
||||
The Windows package is a portable x64 app bundle. It is not code-signed and does not stamp Windows executable metadata, so it can be built from macOS without Wine.
|
||||
## Runtime behavior
|
||||
|
||||
On first connect, the app uses Windows UAC to install/start the bundled Vynte network helper service:
|
||||
|
||||
```powershell
|
||||
netbird.exe service install --management-url https://vpn.vyntehome.com --admin-url https://vpn.vyntehome.com
|
||||
netbird.exe service start
|
||||
```
|
||||
|
||||
Then it runs:
|
||||
|
||||
```powershell
|
||||
netbird.exe up --management-url https://vpn.vyntehome.com --admin-url https://vpn.vyntehome.com
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user