diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index f796e53..b853799 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -10,20 +10,47 @@ permissions:
jobs:
publish-tauri:
- runs-on: windows-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ include:
+ - platform: windows-latest
+ args: ""
+ - platform: macos-latest
+ args: "--target aarch64-apple-darwin"
+ - platform: macos-latest
+ args: "--target x86_64-apple-darwin"
+ - platform: ubuntu-22.04
+ args: ""
+
+ runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v4
+ - name: Install Linux dependencies
+ if: matrix.platform == 'ubuntu-22.04'
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y \
+ libwebkit2gtk-4.1-dev \
+ libappindicator3-dev \
+ librsvg2-dev \
+ patchelf \
+ libssl-dev
+
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- uses: dtolnay/rust-toolchain@stable
+ with:
+ targets: ${{ matrix.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
- uses: swatinem/rust-cache@v2
with:
workspaces: "./src-tauri -> target"
+ key: ${{ matrix.platform }}-${{ matrix.args }}
- run: npm ci
@@ -34,19 +61,22 @@ jobs:
tagName: ${{ github.ref_name }}
releaseName: "EnvTunnel ${{ github.ref_name }}"
releaseBody: |
- Windows installers for EnvTunnel.
+ EnvTunnel installers for Windows, macOS, and Linux.
- - **NSIS setup** β recommended
- - **MSI** β enterprise / IT
- - **EnvTunnel.exe** β portable, no install
+ - **Windows:** NSIS setup (recommended), MSI, portable `.exe`
+ - **macOS:** `.dmg` for Apple Silicon and Intel
+ - **Linux:** AppImage and `.deb`
releaseDraft: false
prerelease: false
+ args: ${{ matrix.args }}
- - name: Upload portable exe
+ - name: Upload portable Windows exe
+ if: matrix.platform == 'windows-latest'
shell: pwsh
run: Copy-Item src-tauri/target/release/envtunnel.exe EnvTunnel.exe
- uses: softprops/action-gh-release@v2
+ if: matrix.platform == 'windows-latest'
with:
tag_name: ${{ github.ref_name }}
files: EnvTunnel.exe
diff --git a/README.md b/README.md
index 172d150..24dd89b 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,9 @@
## π₯ What is it?
-**EnvTunnel** is a Windows desktop application built with [Tauri](https://tauri.app/) + React + TypeScript. It sits in your system tray, silently monitors popular development ports, and the moment it detects an active server it generates a large QR code using your real local network IP (e.g. `192.168.1.15`).
+**EnvTunnel** is a desktop application built with [Tauri](https://tauri.app/) + React + TypeScript. It sits in your system tray, silently monitors popular development ports, and the moment it detects an active server it generates a large QR code using your real local network IP (e.g. `192.168.1.15`).
-No cloud. No accounts. No internet required. 100% offline.
+Windows, macOS, and Linux. No cloud. No accounts. No internet required. 100% offline.
## π― Who is it for?
@@ -26,14 +26,16 @@ No cloud. No accounts. No internet required. 100% offline.
| π **Auto-scan** | Checks 16+ popular dev ports every 3 seconds |
| π± **QR Codes** | Big, scannable QR generated instantly for any active port |
| π§ **Framework Detection** | Recognizes Vite, Next.js, Astro, Angular, Nuxt, Gatsby, Django, Flask, Laravel, Rails, Express |
-| π **Toast Notifications** | Get notified when a new dev server comes online |
+| π **Notifications** | In-app toast plus a native OS notification when a new server comes online (works from the tray) |
| β‘ **Live Reload Indicator** | Orange pulse shows which port just became active |
+| π **Interface picker** | Click the IP to switch Wi-Fi / Ethernet / VPN if the QR used the wrong adapter |
| β **Custom Ports** | Add any port manually (e.g. `6969`) |
| π **Custom Paths** | Append `/admin`, `?debug=true` or any path to the QR URL |
| π **Copy URL** | One-click copy of the full address to clipboard |
| πΎ **Save QR** | Export QR code as PNG image |
+| π **Open in browser** | Open the same URL on this PC to sanity-check it |
| π₯οΈ **System Tray** | Minimizes to tray. Click to restore, right-click to quit |
-| π **Autostart** | Optional launch with Windows |
+| π **Autostart** | Optional launch on login |
## π‘ Supported Ports (Default)
@@ -66,11 +68,11 @@ You can also **add any custom port** via the in-app input.
## π Installation
-### For Users (Just want the .exe)
+### For Users
-1. Download the Windows installer from [Releases](../../releases)
-2. Run the installer
-3. Launch EnvTunnel from Start Menu or Desktop
+1. Download the installer for your OS from [Releases](../../releases)
+2. Run it (Windows setup/MSI, macOS `.dmg`, Linux AppImage/`.deb`)
+3. Launch EnvTunnel from the Start Menu, Applications, or your desktop
### For Developers (Build from source)
@@ -78,7 +80,9 @@ You can also **add any custom port** via the in-app input.
- [Node.js](https://nodejs.org/) 18+
- [Rust](https://rustup.rs/) 1.77+
-- Windows with Visual Studio Build Tools (for `legacy_stdio_definitions.lib`)
+- Windows: Visual Studio Build Tools (for `legacy_stdio_definitions.lib`)
+- macOS: Xcode Command Line Tools
+- Linux: WebKitGTK 4.1 and related Tauri system packages
**Build steps:**
@@ -93,8 +97,10 @@ npm install
# Build frontend + Tauri (production)
npm run tauri build
-# The .exe will be at:
-# src-tauri/target/release/envtunnel.exe
+# The binary will be at:
+# src-tauri/target/release/envtunnel.exe (Windows)
+# src-tauri/target/release/envtunnel (macOS / Linux)
+# plus installers under src-tauri/target/release/bundle/
```
> **Note for Windows builders:** If you get `LNK1181: cannot open input file legacy_stdio_definitions.lib`, add this to your `LIB` environment variable:
@@ -135,6 +141,8 @@ Open your camera app and scan the QR code. Your phone browser opens the local UR
- **Custom Path**: Type `/admin` in the Custom section to generate `http://192.168.1.15:3000/admin`
- **Save QR**: Click "SAVE QR" to download the code as a PNG
+- **Open**: Click "OPEN" to load the same URL in your desktop browser
+- **Pick IP**: Click the IP if the QR used a VPN/WSL adapter instead of Wi-Fi
- **Tray Mode**: Clicking **X** minimizes to system tray. Right-click the tray icon to fully quit.
## π οΈ Tech Stack
@@ -168,6 +176,10 @@ EnvTunnel is a **local-first** desktop app. It works completely offline:
- Keeps the app running in the background
- Prevents accidental close (hides instead)
+## πΊοΈ Roadmap
+
+Planned work lives in [ROADMAP.md](ROADMAP.md): process names, extra default ports, pin a port, HTTPS QR, `--host` copy, path presets, optional tunnels, global hotkey.
+
## π€ Contributing
Contributions are welcome! This is an open-source project meant to help developers.
@@ -180,12 +192,7 @@ Contributions are welcome! This is an open-source project meant to help develope
### Ideas for contributions
-- Add more framework detection patterns
-- Support for macOS / Linux builds
-- Dark/Light theme toggle
-- ngrok / Cloudflare Tunnel integration
-- Network device scanner
-- QR code style customization
+See [ROADMAP.md](ROADMAP.md). Small, focused PRs are preferred.
## π License
diff --git a/ROADMAP.md b/ROADMAP.md
new file mode 100644
index 0000000..506f9b4
--- /dev/null
+++ b/ROADMAP.md
@@ -0,0 +1,29 @@
+# Roadmap
+
+Ideas that are **not** in the current release. PRs welcome.
+
+## Next up
+
+- **Process that owns the port** β show `node.exe` / `python` / Docker next to `:5173` so a stale process is obvious.
+- **More default ports** β Storybook `6006`, Expo/Metro `8081`, Vite preview `4173`, webpack `8888`.
+- **Pin a port** β keep the QR locked on one server when several are active.
+- **HTTPS in the QR** β emit `https://` for mkcert / `vite --https` instead of always `http://`.
+- **`--host` copy command** β on LOCAL ONLY, copy the exact dev-server flag for the detected framework.
+- **Path presets** β chips for `/admin`, `/api`, `?debug=true` instead of a single custom path field.
+- **Optional public tunnel** β Cloudflare Tunnel or ngrok when the phone is not on the same Wi-Fi. Default stays LAN-only / offline.
+- **Global hotkey** β e.g. `Ctrl+Shift+Q` to restore the window from the tray.
+
+## Maybe later
+
+- Network device scanner (out of scope β different product).
+- QR visual customization.
+- Light theme (the neon brutalist look is the identity).
+
+## Shipped
+
+- Auto-scan + QR with LAN IP
+- Framework detection, custom ports/paths, tray, autostart
+- LAN IP heuristic (skip VPN/WSL) and **manual interface picker**
+- Native OS notification when a new port comes online
+- Open the URL in the desktop browser
+- Windows / macOS / Linux installers via GitHub Actions
diff --git a/docs/index.html b/docs/index.html
index 92cbfe9..7d2678d 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -23,6 +23,7 @@
@@ -43,11 +44,11 @@
@@ -294,9 +397,36 @@ function App() {
{/* IP + ACTIVE PORTS */}
-
- IP: {ip || '---.---.---.---'}
-
+
+
+ {ipMenuOpen && ifaces.length > 0 && (
+
+ {ifaces.map(iface => (
+
+ ))}
+
+ )}
+
{lastScan && (
{lastScan.toLocaleTimeString('en-US', { hour: '2-digit', minute: '2-digit', second: '2-digit' })}
@@ -365,6 +495,9 @@ function App() {
LOCAL ONLYRUN DEV SERVER WITH --HOSTTO ACCESS FROM NETWORK
+
) : selectedPort ? (
@@ -381,20 +514,15 @@ function App() {
{getQrUrl()}
-
@@ -469,7 +597,7 @@ function App() {
)}
- START WITH WINDOWS
+ START ON LOGIN
{autostartLoading ? '...' : autostartEnabled ? 'ON' : 'OFF'}