tailscale-proxy 1.3.0 → 1.5.0

package/README.md

@@ -3,8 +3,23 @@
 [![ci](https://github.com/meabed/tailscale-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/meabed/tailscale-proxy/actions/workflows/ci.yml)
 [![release](https://github.com/meabed/tailscale-proxy/actions/workflows/release.yml/badge.svg)](https://github.com/meabed/tailscale-proxy/actions/workflows/release.yml)
 [![npm](https://img.shields.io/npm/v/tailscale-proxy)](https://www.npmjs.com/package/tailscale-proxy)
+[![docs](https://img.shields.io/badge/docs-tailscaleproxy.vercel.app-blue)](https://tailscaleproxy.vercel.app)
 
-📖 **Docs:** https://tailscaleproxy.vercel.app · sources in [`website/`](website)
+## ⚡ Start in one command
+
+```bash
+npx tailscale-proxy
+```
+
+That's it — no install, no config. It discovers your running dev servers and shares
+them all through one Tailscale URL. (First time? Run `npx tailscale-proxy doctor` to
+check Tailscale is set up — see [Requirements](#requirements).)
+
+```bash
+brew install meabed/tap/tsp && tsp     # or install the binary, then run `tsp`
+```
+
+---
 
 An open-source, **self-hosted [ngrok](https://ngrok.com) alternative** built on
 [Tailscale](https://tailscale.com). Discover your local dev servers by **port**,
@@ -87,6 +102,25 @@ Update later with **`tsp update`** — it self-updates a standalone binary, or p
 
 ---
 
+## Desktop app
+
+<img src="website/public/app-icon.svg" align="right" width="96" alt="Tailscale Proxy app icon" />
+
+Prefer clicking to typing? There's a native **menu-bar app** for **macOS, Windows,
+and Linux** — start/stop the proxy, watch each dev server (cpu · memory · uptime),
+switch Funnel/Serve, and open/copy/kill services, all without a terminal. It runs
+the same engine as the CLI and shares the same `~/.tailscale-proxy/config.json`.
+
+**[⬇ Download](https://github.com/meabed/tailscale-proxy/releases)** — pick the
+latest **`desktop-v…`** release · **[Docs & screenshots](https://tailscaleproxy.vercel.app/desktop)**
+
+<img src="website/public/desktop-panel.png" width="330" alt="Tailscale Proxy menu-bar panel" />
+
+Build from source: `cd desktop && go build -o tsp-app . && ./tsp-app` (see
+[`desktop/README.md`](desktop/README.md)).
+
+---
+
 ## Commands
 
 ```
@@ -178,6 +212,26 @@ Step-by-step with screenshots-worth-of-detail: **[docs/EXAMPLES.md](docs/EXAMPLE
 
 ## How it works
 
+```mermaid
+flowchart LR
+    C["Caller<br/>internet or tailnet"]
+    C -->|"https://node.ts.net/web/foo"| TS
+    subgraph machine["your machine"]
+        direction TB
+        TS["tailscale funnel | serve<br/>TLS · :443 / 8443 / 10000"]
+        P["tsp proxy<br/>net/http · :8443"]
+        SCAN["discovery loop<br/>lsof·ps / netstat·tasklist"]
+        D1["127.0.0.1:4983<br/>web · bun"]
+        D2["127.0.0.1:3000<br/>api · node"]
+        TS -->|plain HTTP| P
+        P -->|"/web/foo → strip → /foo<br/>Host → localhost:4983"| D1
+        P --> D2
+        SCAN -->|"slug → port map"| P
+        SCAN -.->|"scan every --interval"| D1
+        SCAN -.-> D2
+    end
+```
+
 1. Every `--interval` seconds, `tsp` lists listening TCP sockets in the range
    (macOS/Linux via `lsof`+`ps`, Windows via `netstat`+`tasklist`), classifies the
    runtime, and derives a slug from the nearest project-root folder
@@ -188,7 +242,23 @@ Step-by-step with screenshots-worth-of-detail: **[docs/EXAMPLES.md](docs/EXAMPLE
 3. `tailscale serve|funnel --bg <proxy-port>` exposes the proxy. On exit the entry
    is reset.
 
-More in [docs/HOW-IT-WORKS.md](docs/HOW-IT-WORKS.md).
+**Request routing:**
+
+```mermaid
+flowchart TD
+    R["Request /seg/rest?query"] --> M{"first segment<br/>matches a slug?"}
+    M -->|yes| H["strip segment · Host → localhost:port<br/>set tsp_route cookie"]
+    M -->|"no (prefix-less asset/HMR)"| CK{"tsp_route<br/>cookie set?"}
+    CK -->|yes| FF["forward full path to the cookie's backend"]
+    CK -->|no| NF["404 + list of services"]
+    H --> UP{"backend up?"}
+    FF --> UP
+    UP -->|yes| OK["stream response<br/>(SSE · WebSocket)"]
+    UP -->|no| E502["502"]
+```
+
+More — including the discovery pipeline and lifecycle sequence diagrams — in
+[docs/HOW-IT-WORKS.md](docs/HOW-IT-WORKS.md).
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tailscale-proxy",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Discover local dev servers by port and expose them through one Tailscale Serve/Funnel entry, routed by project name.",
   "keywords": [
     "tailscale",
@@ -74,12 +74,12 @@
     "semantic-release": "^25.0.3"
   },
   "optionalDependencies": {
-    "tailscale-proxy-darwin-arm64": "1.3.0",
-    "tailscale-proxy-darwin-x64": "1.3.0",
-    "tailscale-proxy-linux-x64": "1.3.0",
-    "tailscale-proxy-linux-arm64": "1.3.0",
-    "tailscale-proxy-win32-x64": "1.3.0",
-    "tailscale-proxy-win32-arm64": "1.3.0"
+    "tailscale-proxy-darwin-arm64": "1.5.0",
+    "tailscale-proxy-darwin-x64": "1.5.0",
+    "tailscale-proxy-linux-x64": "1.5.0",
+    "tailscale-proxy-linux-arm64": "1.5.0",
+    "tailscale-proxy-win32-x64": "1.5.0",
+    "tailscale-proxy-win32-arm64": "1.5.0"
   },
   "packageManager": "bun@1.3.14",
   "engines": {