webtun 1.4.2 → 1.4.5

package/README.md

@@ -6,7 +6,7 @@
 ![Desktop](https://img.shields.io/badge/Desktop-Electron-47848F?style=for-the-badge)
 ![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)
 
-**Access your Linux server from any browser — no VPN, no SSH client, no installing anything.**
+**Access your server from any browser — no VPN, no SSH client, no installing anything.**
 
 [![Quick Start](https://img.shields.io/badge/Quick_Start-One_Command-2D5B8E?style=for-the-badge&logo=gnu-bash)](install.sh)
 [![Download](https://img.shields.io/github/v/release/unn-known1/webtun?style=for-the-badge&logo=github)](https://github.com/unn-known1/webtun/releases/latest)
@@ -97,6 +97,17 @@ webtun
 | `--help` | Show help |
 | `--version` | Show version |
 
+**Environment Variables:**
+| Variable | Description |
+|----------|-------------|
+| `PORT` | Server port (default: 3000) |
+| `HOST` | Bind address (default: 0.0.0.0) |
+| `PIN` | Authentication PIN (empty = no auth) |
+| `SHELL` | Shell to use (default: PowerShell on Windows, bash/sh elsewhere) |
+| `WORKSPACE_ROOT` | Root directory for file operations (default: ~) |
+| `TRUST_PROXY` | Set to `true` if behind a reverse proxy (default: loopback only) |
+| `WEBTUN_SHELL` | Override shell on Windows (e.g., `/usr/bin/bash` for Git Bash) |
+
 **Examples:**
 ```bash
 npx webtun                        # Start on port 3000
@@ -148,35 +159,35 @@ npm start
 ## Architecture
 
 ```
-┌─────────────────────────────────────────────────────────────┐
-│                      Your Browser                           │
-│  ┌─────────┐  ┌──────────┐  ┌────────────┐  ┌────────────┐  │
-│  │Terminal │  │  File    │  │   Tunnel   │  │  Settings  │  │
-│  │ (xterm) │  │ Explorer │  │   Manager  │  │   Panel    │  │
-│  └────┬────┘  └────┬─────┘  └──────┬─────┘  └─────┬──────┘  │
-│       │            │               │              │         │
-└───────┼────────────┼───────────────┼──────────────┼─────────┘
-        │ WebSocket  │               │              │
-        ▼            ▼               ▼              │
-┌─────────────────────────────────────────────────────────────┐
-│                      Node.js Server                         │
-│  ┌────────────┐  ┌─────────────┐  ┌────────────────────┐    │
-│  │  WebSocket │  │   File API  │  │ Cloudflare Tunnel   │    │
-│  │  Handler   │  │ (read/write)│  │     Manager        │    │
-│  └─────┬──────┘  └──────┬──────┘  └─────────┬──────────┘    │
-│        │                │                   │               │
-│        ▼                ▼                   ▼               │
-│  ┌─────────┐  ┌────────────────┐  ┌──────────────────────┐  │
-│  │ node-pty│  │Local Filesystem│  │ cloudflared daemon    │  │
-│  │ (shell) │  │(your server)   │  │ (exposes to internet)│  │
-│  └─────────┘  └────────────────┘  └──────────────────────┘  │
-└─────────────────────────────────────────────────────────────┘
-                            │
-                            ▼
-                    ┌─────────────────┐
-                    │  Internet Users │
-                    │  (HTTPS URL)    │
-                    └─────────────────┘
+┌────────────────────────────────────────────────────────────────┐
+│                        Your Browser                            │
+│  ┌──────────┐  ┌───────────┐  ┌─────────────┐  ┌───────────┐   │
+│  │ Terminal │  │   File    │  │   Tunnel    │  │  Settings │   │
+│  │  (xterm) │  │ Explorer  │  │   Manager   │  │   Panel   │   │
+│  └─────┬────┘  └─────┬─────┘  └──────┬──────┘  └─────┬─────┘   │
+│        │             │               │               │         │
+└────────┼─────────────┼───────────────┼───────────────┼─────────┘
+         │  WebSocket  │  REST API     │               │
+         ▼             ▼               ▼               │
+┌────────────────────────────────────────────────────────────────┐
+│                       Node.js Server                           │
+│  ┌─────────────┐  ┌──────────────┐  ┌───────────────────────┐  │
+│  │  WebSocket  │  │   File API   │  │  Cloudflare Tunnel    │  │
+│  │   Handler   │  │ (read/write) │  │      Manager          │  │
+│  └──────┬──────┘  └──────┬───────┘  └───────────┬───────────┘  │
+│         │                │                      │              │
+│         ▼                ▼                      ▼              │
+│  ┌──────────┐  ┌──────────────────┐  ┌──────────────────────┐  │
+│  │ node-pty │  │ Local Filesystem │  │ cloudflared daemon   │  │
+│  │  (shell) │  │ (your server)    │  │ (exposes to internet)│  │
+│  └──────────┘  └──────────────────┘  └──────────────────────┘  │
+└────────────────────────────────────────────────────────────────┘
+                               │
+                               ▼
+                      ┌─────────────────┐
+                      │  Internet Users │
+                      │  (HTTPS URL)    │
+                      └─────────────────┘
 ```
 
 ---
@@ -231,6 +242,9 @@ kill $(pgrep -f 'cloudflared tunnel')
 | Permission denied on shell | Ensure user has shell access: `chsh -s /bin/bash` |
 | File upload fails | Check `public/uploads/` permissions: `chmod 755 public/uploads/` |
 | Port 3000 in use | Change port: `PORT=3001 npm start` |
+| Windows terminal opens PowerShell instead of Git Bash | Set `WEBTUN_SHELL=/usr/bin/bash` in `.env` |
+| Behind reverse proxy, wrong client IP | Set `TRUST_PROXY=true` in `.env` |
+| Tunnel persists after server restart | Tunnels are auto-managed; manual cleanup: `kill $(pgrep -f 'cloudflared tunnel')` |
 
 ---
 

package/bin/webtun.js

@@ -23,7 +23,7 @@ function printHelp() {
     PORT                  Server port (default: 3000)
     HOST                  Bind address (default: 0.0.0.0)
     PIN                   Authentication PIN (empty = no auth)
-    SHELL                 Shell to use (default: /bin/bash or system shell)
+    SHELL                 Shell to use (default: PowerShell on Windows, bash/sh elsewhere)
     WORKSPACE_ROOT        Root directory for file operations (default: ~)
 
   Examples:
@@ -70,25 +70,20 @@ function parseArgs(argv) {
 }
 
 function startTunnel(port) {
-  const { execSync, spawn } = require('child_process');
-  const os = require('os');
+  const { spawn } = require('child_process');
+  const { findCloudflared } = require('../server');
 
-  // Check if cloudflared is installed
-  try {
-    if (os.platform() === 'win32') {
-      execSync('where cloudflared', { stdio: 'ignore' });
-    } else {
-      execSync('command -v cloudflared', { stdio: 'ignore' });
-    }
-  } catch {
+  const bin = findCloudflared();
+  if (!bin) {
     console.error('\n  Error: cloudflared is not installed.');
     console.error('  Install it from: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/');
+    console.error('  Or re-run: npm install webtun  (postinstall downloads it)');
     return;
   }
 
-  console.log('\n  Starting Cloudflare Tunnel...');
+  console.log('  Starting Cloudflare Tunnel...');
 
-  const proc = spawn('cloudflared', ['tunnel', '--url', `http://localhost:${port}`], {
+  const proc = spawn(bin, ['tunnel', '--url', `http://localhost:${port}`], {
     stdio: ['ignore', 'pipe', 'pipe']
   });
 
@@ -121,23 +116,22 @@ function startTunnel(port) {
     }
   });
 
-  // Cleanup on exit
-  process.on('SIGINT', () => {
-    try { proc.kill('SIGTERM'); } catch {}
-    process.exit(0);
-  });
-  process.on('SIGTERM', () => {
+  const stop = () => {
     try { proc.kill('SIGTERM'); } catch {}
     process.exit(0);
-  });
+  };
+  process.on('SIGINT', stop);
+  process.on('SIGTERM', stop);
 }
 
 const opts = parseArgs(args);
-const { startServer } = require('../server');
+const { startServer, PORT } = require('../server');
+
+const listenPort = opts.port || PORT;
 
 startServer(opts).then(() => {
   if (opts.tunnel) {
-    startTunnel(opts.port || 3000);
+    startTunnel(listenPort);
   }
 }).catch(err => {
   console.error('Failed to start server:', err.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webtun",
-  "version": "1.4.2",
+  "version": "1.4.5",
   "description": "Self-hosted web terminal with Cloudflare Tunnel, file explorer, and PWA support",
   "author": {
     "name": "Gaurang Patel",
@@ -93,10 +93,12 @@
     }
   },
   "dependencies": {
+    "archiver": "^8.0.0",
     "express": "^4.18.2",
     "multer": "^2.0.0",
     "node-pty": "^1.0.0",
-    "ws": "^8.21.0"
+    "ws": "^8.21.0",
+    "yauzl": "^3.4.0"
   },
   "devDependencies": {
     "electron": "^42.2.0",
@@ -105,5 +107,8 @@
   },
   "overrides": {
     "form-data": "4.0.6"
+  },
+  "allowScripts": {
+    "node-pty@1.1.0": true
   }
 }

package/postinstall.js

@@ -2,6 +2,8 @@ const { execSync, spawnSync } = require('child_process');
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
+const https = require('https');
+const http = require('http');
 
 // ── Rebuild node-pty if native module is missing ─────────────────────
 function rebuildNodePty() {
@@ -18,16 +20,20 @@ function rebuildNodePty() {
     spawnSync('npm', ['rebuild', 'node-pty'], {
       cwd: __dirname,
       stdio: 'inherit',
-      timeout: 120000
+      timeout: 120000,
+      shell: os.platform() === 'win32'
     });
     // Verify it worked
+    delete require.cache[require.resolve('node-pty')];
     require('node-pty');
     console.log('  node-pty rebuilt successfully');
   } catch (e) {
     console.log('  node-pty rebuild failed: ' + e.message);
-    console.log('  Terminal requires build tools: python3, make, g++');
-    console.log('  Linux:  sudo apt-get install -y python3 make g++');
-    console.log('  macOS:  xcode-select --install');
+    console.log('  Terminal requires native build tools:');
+    console.log('  Linux:   sudo apt-get install -y python3 make g++');
+    console.log('  macOS:   xcode-select --install');
+    console.log('  Windows: install Visual Studio Build Tools with "Desktop development with C++"');
+    console.log('           https://visualstudio.microsoft.com/visual-cpp-build-tools/');
   }
 }
 
@@ -36,47 +42,101 @@ rebuildNodePty();
 // ── Install cloudflared ──────────────────────────────────────────────
 const CF_RELEASES = 'https://github.com/cloudflare/cloudflared/releases/latest/download';
 
-try {
-  if (os.platform() === 'win32') {
-    execSync('where cloudflared', { stdio: 'ignore' });
+function cloudflaredExists() {
+  try {
+    if (os.platform() === 'win32') {
+      execSync('where cloudflared', { stdio: 'ignore' });
+    } else {
+      execSync('command -v cloudflared', { stdio: 'ignore' });
+    }
+    return true;
+  } catch {}
+
+  const isWin = os.platform() === 'win32';
+  const name = isWin ? 'cloudflared.exe' : 'cloudflared';
+  const candidates = [
+    path.join(__dirname, name),
+    path.join(process.cwd(), name),
+  ];
+  if (isWin) {
+    const localApp = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
+    candidates.push(path.join(localApp, 'cloudflared', name));
+    const pf = process.env.ProgramW6432 || process.env.ProgramFiles;
+    if (pf) candidates.push(path.join(pf, 'cloudflared', name));
   } else {
-    execSync('command -v cloudflared', { stdio: 'ignore' });
+    candidates.push(path.join(os.homedir(), '.local', 'bin', name));
+    candidates.push('/usr/local/bin/' + name);
   }
-} catch {
-  // cloudflared not found — install it
-  const platform = os.platform();
-  const arch = os.arch();
+  return candidates.some(c => {
+    try { return fs.existsSync(c) && fs.statSync(c).isFile(); } catch { return false; }
+  });
+}
 
-  const files = {
-    linux:   { x64: 'cloudflared-linux-amd64', arm64: 'cloudflared-linux-arm64', arm: 'cloudflared-linux-arm' },
-    darwin:  { x64: 'cloudflared-darwin-amd64.tgz', arm64: 'cloudflared-darwin-arm64.tgz' },
-    win32:   { x64: 'cloudflared-windows-amd64.exe' }
-  };
+if (cloudflaredExists()) process.exit(0);
 
-  const file = (files[platform] || {})[arch];
-  if (!file) process.exit(0);
+const platform = os.platform();
+const arch = os.arch();
 
-  console.log('  installing cloudflared...');
+const files = {
+  linux:   { x64: 'cloudflared-linux-amd64', arm64: 'cloudflared-linux-arm64', arm: 'cloudflared-linux-arm' },
+  darwin:  { x64: 'cloudflared-darwin-amd64.tgz', arm64: 'cloudflared-darwin-arm64.tgz' },
+  win32:   { x64: 'cloudflared-windows-amd64.exe', arm64: 'cloudflared-windows-amd64.exe' }
+};
 
-  const url = CF_RELEASES + '/' + file;
-  const tmpDir = os.tmpdir();
-  const tmp = path.join(tmpDir, 'cloudflared-' + process.pid + (platform === 'win32' ? '.exe' : ''));
+const file = (files[platform] || {})[arch];
+if (!file) process.exit(0);
 
-  function cleanup() {
-    try { fs.unlinkSync(tmp); } catch {}
-  }
+console.log('  installing cloudflared...');
 
-  function download() {
-    const r = spawnSync('curl', ['-#fL', url, '-o', tmp], { stdio: 'inherit', timeout: 60000 });
-    if (r.status === 0) return true;
-    const r2 = spawnSync('wget', ['-q', url, '-O', tmp], { stdio: 'inherit', timeout: 60000 });
-    return r2.status === 0;
-  }
+const url = CF_RELEASES + '/' + file;
+const tmpDir = os.tmpdir();
+const tmp = path.join(tmpDir, 'cloudflared-' + process.pid + (platform === 'win32' ? '.exe' : ''));
 
-  if (!download()) {
-    console.log('  cloudflared install failed (download error) — skipping');
-    cleanup();
-    process.exit(0);
+function cleanup() {
+  try { fs.unlinkSync(tmp); } catch {}
+}
+
+function downloadFile(downloadUrl, dest) {
+  return new Promise((resolve, reject) => {
+    const mod = downloadUrl.startsWith('https') ? https : http;
+    const req = mod.get(downloadUrl, { headers: { 'User-Agent': 'webtun-postinstall' } }, res => {
+      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+        res.resume();
+        return downloadFile(res.headers.location, dest).then(resolve, reject);
+      }
+      if (res.statusCode !== 200) {
+        res.resume();
+        return reject(new Error('HTTP ' + res.statusCode));
+      }
+      const out = fs.createWriteStream(dest);
+      res.pipe(out);
+      out.on('finish', () => out.close(err => err ? reject(err) : resolve()));
+      out.on('error', reject);
+    });
+    req.on('error', reject);
+    req.setTimeout(60000, () => {
+      req.destroy();
+      reject(new Error('download timeout'));
+    });
+  });
+}
+
+function downloadWithCurlOrWget() {
+  const r = spawnSync('curl', ['-#fL', url, '-o', tmp], { stdio: 'inherit', timeout: 60000 });
+  if (r.status === 0) return true;
+  const r2 = spawnSync('wget', ['-q', url, '-O', tmp], { stdio: 'inherit', timeout: 60000 });
+  return r2.status === 0;
+}
+
+async function main() {
+  try {
+    await downloadFile(url, tmp);
+  } catch (e) {
+    if (!downloadWithCurlOrWget()) {
+      console.log('  cloudflared install failed (download error) — skipping');
+      cleanup();
+      return;
+    }
   }
 
   // Validate downloaded file is not HTML (e.g. 404 page)
@@ -89,15 +149,16 @@ try {
     if (/^<!doctype\s+html/i.test(head) || /^<html/i.test(head)) {
       console.log('  cloudflared install failed (downloaded file is not a binary) — skipping');
       cleanup();
-      process.exit(0);
+      return;
     }
   } catch (e) {
     console.log('  cloudflared install failed (cannot validate download): ' + e.message);
     cleanup();
-    process.exit(0);
+    return;
   }
 
   function installBin(src, dest) {
+    fs.mkdirSync(path.dirname(dest), { recursive: true });
     try {
       fs.renameSync(src, dest);
     } catch (e) {
@@ -111,35 +172,61 @@ try {
     try { fs.chmodSync(dest, 0o755); } catch {}
   }
 
+  function preferredDest() {
+    const name = platform === 'win32' ? 'cloudflared.exe' : 'cloudflared';
+    if (platform === 'win32') {
+      const localApp = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
+      return path.join(localApp, 'cloudflared', name);
+    }
+    return path.join(os.homedir(), '.local', 'bin', name);
+  }
+
+  function extractDarwinIfNeeded() {
+    if (platform !== 'darwin') return tmp;
+    const result = spawnSync('tar', ['xzf', tmp, '-C', tmpDir], { stdio: 'inherit' });
+    if (result.status !== 0) throw new Error('tar extraction failed');
+    try { fs.unlinkSync(tmp); } catch {}
+    return path.join(tmpDir, 'cloudflared');
+  }
+
   try {
-    if (platform === 'darwin') {
-      const result = spawnSync('tar', ['xzf', tmp, '-C', tmpDir], { stdio: 'inherit' });
-      if (result.status !== 0) throw new Error('tar extraction failed');
-      installBin(path.join(tmpDir, 'cloudflared'), '/usr/local/bin/cloudflared');
-      try { fs.unlinkSync(tmp); } catch {}
-    } else if (platform === 'win32') {
-      const progFiles = process.env.ProgramW6432 || process.env.ProgramFiles || (process.env.SystemRoot + '\\Program Files');
-      const dest = path.join(progFiles, 'cloudflared', 'cloudflared.exe');
-      fs.mkdirSync(path.dirname(dest), { recursive: true });
-      installBin(tmp, dest);
-    } else {
-      installBin(tmp, '/usr/local/bin/cloudflared');
+    const src = extractDarwinIfNeeded();
+    // Prefer user-local path (no admin), then package dir, then system
+    const dests = [preferredDest(), path.join(__dirname, platform === 'win32' ? 'cloudflared.exe' : 'cloudflared')];
+    if (platform !== 'win32') dests.push('/usr/local/bin/cloudflared');
+    else {
+      const pf = process.env.ProgramW6432 || process.env.ProgramFiles;
+      if (pf) dests.push(path.join(pf, 'cloudflared', 'cloudflared.exe'));
     }
-    console.log('  cloudflared installed');
-    cleanup();
-  } catch (e) {
-    if (e.code === 'EACCES' || e.code === 'EPERM') {
-      const localDest = path.join(process.cwd(), 'cloudflared' + (platform === 'win32' ? '.exe' : ''));
+
+    let installed = null;
+    let lastErr = null;
+    for (const dest of dests) {
       try {
-        installBin(tmp, localDest);
-        console.log('  cloudflared installed to ' + localDest);
-        console.log('  Move it to your PATH: sudo mv ' + localDest + ' /usr/local/bin/');
-      } catch (e2) {
-        console.log('  cloudflared install failed: ' + e2.message + ' — skipping');
+        installBin(src, dest);
+        installed = dest;
+        break;
+      } catch (e) {
+        lastErr = e;
+      }
+    }
+
+    if (installed) {
+      console.log('  cloudflared installed → ' + installed);
+      if (platform === 'win32' && installed.includes('Local')) {
+        console.log('  (not on PATH; WebTun will find it automatically)');
       }
     } else {
-      console.log('  cloudflared install failed: ' + e.message + ' — skipping');
+      console.log('  cloudflared install failed: ' + (lastErr && lastErr.message) + ' — skipping');
     }
     cleanup();
+  } catch (e) {
+    console.log('  cloudflared install failed: ' + e.message + ' — skipping');
+    cleanup();
   }
 }
+
+main().catch(e => {
+  console.log('  cloudflared install failed: ' + e.message + ' — skipping');
+  cleanup();
+});