webtun 1.4.0 → 1.4.1

package/README.md

@@ -76,6 +76,45 @@
 
 ## Quick Start
 
+### npm (Recommended)
+```bash
+npx webtun
+```
+
+Install globally:
+```bash
+npm install -g webtun
+webtun
+```
+
+**Options:**
+| Flag | Description |
+|------|-------------|
+| `--port, -p` | Port (default: 3000) |
+| `--host, -h` | Host (default: 0.0.0.0) |
+| `--pin` | Authentication PIN |
+| `--tunnel, -t` | Start Cloudflare Tunnel |
+| `--help` | Show help |
+| `--version` | Show version |
+
+**Examples:**
+```bash
+npx webtun                        # Start on port 3000
+npx webtun --port 8080            # Custom port
+npx webtun --pin secret123        # With PIN protection
+npx webtun --tunnel               # With Cloudflare Tunnel
+npx webtun -p 4000 -t             # Port 4000 + tunnel
+```
+
+**Note:** `node-pty` requires build tools on first install:
+```bash
+# Debian/Ubuntu
+sudo apt-get install -y python3 make g++
+
+# macOS
+xcode-select --install
+```
+
 ### One-Command Install
 ```bash
 bash -c "$(curl -fsSL https://raw.githubusercontent.com/unn-Known1/webtun/main/install.sh)"

package/bin/webtun.js

@@ -15,6 +15,7 @@ function printHelp() {
     --port, -p <port>     Port to listen on (default: 3000 or $PORT)
     --host, -h <host>     Host to bind to (default: 0.0.0.0 or $HOST)
     --pin <pin>           PIN for authentication (default: $PIN)
+    --tunnel, -t          Start a Cloudflare Tunnel for remote access
     --help                Show this help message
     --version             Show version number
 
@@ -29,12 +30,14 @@ function printHelp() {
     webtun                          Start on default port
     webtun --port 8080              Start on port 8080
     webtun --pin secret123          Start with PIN protection
+    webtun --tunnel                 Start with Cloudflare Tunnel
+    webtun -p 4000 -t               Port 4000 + tunnel
     PORT=4000 webtun               Start on port 4000 via env var
 `);
 }
 
 function parseArgs(argv) {
-  const opts = {};
+  const opts = { tunnel: false };
   for (let i = 0; i < argv.length; i++) {
     const arg = argv[i];
     if (arg === '--help' || arg === '-H') {
@@ -55,6 +58,8 @@ function parseArgs(argv) {
       opts.host = argv[++i];
     } else if (arg === '--pin') {
       process.env.PIN = argv[++i] || '';
+    } else if (arg === '--tunnel' || arg === '-t') {
+      opts.tunnel = true;
     } else {
       console.error(`Unknown option: ${arg}`);
       printHelp();
@@ -64,10 +69,77 @@ function parseArgs(argv) {
   return opts;
 }
 
+function startTunnel(port) {
+  const { execSync, spawn } = require('child_process');
+  const os = require('os');
+
+  // Check if cloudflared is installed
+  try {
+    if (os.platform() === 'win32') {
+      execSync('where cloudflared', { stdio: 'ignore' });
+    } else {
+      execSync('command -v cloudflared', { stdio: 'ignore' });
+    }
+  } catch {
+    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/');
+    return;
+  }
+
+  console.log('\n  Starting Cloudflare Tunnel...');
+
+  const proc = spawn('cloudflared', ['tunnel', '--url', `http://localhost:${port}`], {
+    stdio: ['ignore', 'pipe', 'pipe']
+  });
+
+  let tunnelUrl = null;
+
+  const handler = data => {
+    const text = data.toString();
+    const m = text.match(/https:\/\/[a-z0-9-]+\.trycloudflare\.com/);
+    if (m && !tunnelUrl) {
+      tunnelUrl = m[0];
+      console.log('');
+      console.log('  ┌─────────────────────────────────────────────────────┐');
+      console.log('  │  Public URL (share this!):                          │');
+      console.log(`  │  ${tunnelUrl}`);
+      console.log('  └─────────────────────────────────────────────────────┘');
+      console.log('');
+    }
+  };
+
+  proc.stdout.on('data', handler);
+  proc.stderr.on('data', handler);
+
+  proc.on('error', (err) => {
+    console.error('  Tunnel error:', err.message);
+  });
+
+  proc.on('exit', (code) => {
+    if (code !== 0 && !tunnelUrl) {
+      console.error('  Tunnel exited with code', code);
+    }
+  });
+
+  // Cleanup on exit
+  process.on('SIGINT', () => {
+    try { proc.kill('SIGTERM'); } catch {}
+    process.exit(0);
+  });
+  process.on('SIGTERM', () => {
+    try { proc.kill('SIGTERM'); } catch {}
+    process.exit(0);
+  });
+}
+
 const opts = parseArgs(args);
 const { startServer } = require('../server');
 
-startServer(opts).catch(err => {
+startServer(opts).then(() => {
+  if (opts.tunnel) {
+    startTunnel(opts.port || 3000);
+  }
+}).catch(err => {
   console.error('Failed to start server:', err.message);
   process.exit(1);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webtun",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Self-hosted web terminal with Cloudflare Tunnel, file explorer, and PWA support",
   "author": {
     "name": "Gaurang Patel",
@@ -98,18 +98,12 @@
     "node-pty": "^1.0.0",
     "ws": "^8.21.0"
   },
-  "optionalDependencies": {
-    "electron": "^42.2.0",
-    "electron-builder": "^26.8.1"
-  },
   "devDependencies": {
+    "electron": "^42.2.0",
+    "electron-builder": "^26.8.1",
     "nodemon": "^3.1.14"
   },
   "overrides": {
     "form-data": "4.0.6"
-  },
-  "allowScripts": {
-    "electron-winstaller@5.4.0": true,
-    "node-pty@1.1.0": true
   }
 }

package/postinstall.js

@@ -3,6 +3,37 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 
+// ── Rebuild node-pty if native module is missing ─────────────────────
+function rebuildNodePty() {
+  try {
+    require('node-pty');
+    return; // Already working
+  } catch {}
+
+  const ptyDir = path.join(__dirname, 'node_modules', 'node-pty');
+  if (!fs.existsSync(ptyDir)) return; // Not installed yet (first time npm install)
+
+  console.log('  rebuilding node-pty...');
+  try {
+    spawnSync('npm', ['rebuild', 'node-pty'], {
+      cwd: __dirname,
+      stdio: 'inherit',
+      timeout: 120000
+    });
+    // Verify it worked
+    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');
+  }
+}
+
+rebuildNodePty();
+
+// ── Install cloudflared ──────────────────────────────────────────────
 const CF_RELEASES = 'https://github.com/cloudflare/cloudflared/releases/latest/download';
 
 try {
@@ -11,110 +42,104 @@ try {
   } else {
     execSync('command -v cloudflared', { stdio: 'ignore' });
   }
-  process.exit(0);
-} catch {}
-
-const platform = os.platform();
-const arch = os.arch();
+} catch {
+  // cloudflared not found — install it
+  const platform = os.platform();
+  const arch = os.arch();
 
-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' }
-};
+  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' }
+  };
 
-const file = (files[platform] || {})[arch];
-if (!file) process.exit(0);
+  const file = (files[platform] || {})[arch];
+  if (!file) process.exit(0);
 
-console.log('  installing cloudflared...');
+  console.log('  installing cloudflared...');
 
-const url = CF_RELEASES + '/' + file;
-const tmpDir = os.tmpdir();
-const tmp = path.join(tmpDir, 'cloudflared-' + process.pid + (platform === 'win32' ? '.exe' : ''));
-const tmpExtracted = path.join(tmpDir, 'cloudflared-' + process.pid + '-bin' + (platform === 'win32' ? '.exe' : ''));
+  const url = CF_RELEASES + '/' + file;
+  const tmpDir = os.tmpdir();
+  const tmp = path.join(tmpDir, 'cloudflared-' + process.pid + (platform === 'win32' ? '.exe' : ''));
 
-function cleanup() {
-  try { fs.unlinkSync(tmp); } catch {}
-  try { fs.unlinkSync(tmpExtracted); } catch {}
-}
-
-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;
-}
+  function cleanup() {
+    try { fs.unlinkSync(tmp); } catch {}
+  }
 
-if (!download()) {
-  console.log('  cloudflared install failed (download error) — skipping');
-  cleanup();
-  process.exit(0);
-}
+  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;
+  }
 
-// Validate downloaded file is not HTML (e.g. 404 page)
-try {
-  const buf = Buffer.alloc(1024);
-  const fd = fs.openSync(tmp, 'r');
-  const bytesRead = fs.readSync(fd, buf, 0, 1024, 0);
-  fs.closeSync(fd);
-  const head = buf.slice(0, bytesRead).toString('utf8').trim();
-  if (/^<!doctype\s+html/i.test(head) || /^<html/i.test(head)) {
-    console.log('  cloudflared install failed (downloaded file is not a binary) — skipping');
+  if (!download()) {
+    console.log('  cloudflared install failed (download error) — skipping');
     cleanup();
     process.exit(0);
   }
-} catch (e) {
-  console.log('  cloudflared install failed (cannot validate download): ' + e.message);
-  cleanup();
-  process.exit(0);
-}
 
-function installBin(src, dest) {
+  // Validate downloaded file is not HTML (e.g. 404 page)
   try {
-    fs.renameSync(src, dest);
-  } catch (e) {
-    if (e.code === 'EXDEV') {
-      fs.copyFileSync(src, dest);
-      try { fs.unlinkSync(src); } catch {}
-    } else {
-      throw e;
+    const buf = Buffer.alloc(1024);
+    const fd = fs.openSync(tmp, 'r');
+    const bytesRead = fs.readSync(fd, buf, 0, 1024, 0);
+    fs.closeSync(fd);
+    const head = buf.slice(0, bytesRead).toString('utf8').trim();
+    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);
     }
+  } catch (e) {
+    console.log('  cloudflared install failed (cannot validate download): ' + e.message);
+    cleanup();
+    process.exit(0);
   }
-  // Always set executable bit regardless of rename or copy path
-  try { fs.chmodSync(dest, 0o755); } catch {}
-}
 
-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');
-  }
-  console.log('  cloudflared installed');
-  cleanup();
-} catch (e) {
-  // When installed globally via npm, /usr/local/bin may not be writable.
-  // In that case, download to a local path and suggest manual install.
-  if (e.code === 'EACCES' || e.code === 'EPERM') {
-    const localDest = path.join(process.cwd(), 'cloudflared' + (platform === 'win32' ? '.exe' : ''));
+  function installBin(src, dest) {
     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');
+      fs.renameSync(src, dest);
+    } catch (e) {
+      if (e.code === 'EXDEV') {
+        fs.copyFileSync(src, dest);
+        try { fs.unlinkSync(src); } catch {}
+      } else {
+        throw e;
+      }
     }
-  } else {
-    console.log('  cloudflared install failed: ' + e.message + ' — skipping');
+    try { fs.chmodSync(dest, 0o755); } catch {}
+  }
+
+  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');
+    }
+    console.log('  cloudflared installed');
+    cleanup();
+  } catch (e) {
+    if (e.code === 'EACCES' || e.code === 'EPERM') {
+      const localDest = path.join(process.cwd(), 'cloudflared' + (platform === 'win32' ? '.exe' : ''));
+      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');
+      }
+    } else {
+      console.log('  cloudflared install failed: ' + e.message + ' — skipping');
+    }
+    cleanup();
   }
-  cleanup();
-  process.exit(0);
 }

package/server.js

@@ -16,7 +16,17 @@ try {
 const express = require('express');
 const http = require('http');
 const WebSocket = require('ws');
-const pty = require('node-pty');
+let pty;
+try {
+  pty = require('node-pty');
+} catch (e) {
+  console.error('\n  Error: node-pty failed to load. Terminal functionality requires native build tools.');
+  console.error('  Install build tools and reinstall:');
+  console.error('    Linux:  sudo apt-get install -y python3 make g++');
+  console.error('    macOS:  xcode-select --install');
+  console.error('  Then reinstall: npm install webtun\n');
+  process.exit(1);
+}
 const multer = require('multer');
 const fs = require('fs');
 const path = require('path');