@justin0713/opspilot 1.0.0

package/README.md

@@ -0,0 +1,142 @@
+# OpsPilot
+
+OpsPilot is a Flask + Socket.IO based remote operations dashboard for SSH/Serial management, test execution, file transfer, and real-time collaboration (War Room).
+
+## Features
+
+- Multi-target SSH command execution (single/batch/streaming shell)
+- Serial console sessions (when `pyserial` is installed)
+- Target/group management and command favorites
+- SFTP file browser and upload/download
+- Reboot/Network/SSD test workflows
+- Share links for outputs/test snapshots
+- War Room collaboration:
+  - shared terminal output
+  - guest approval/control
+  - chat (including rich text/image)
+  - WebRTC voice signaling
+- Local JSON persistence (no external database required)
+- Offline frontend vendor assets under `static/vendor/`
+
+## Project Structure
+
+- `opspilot.py`: main startup entry (recommended)
+- `web_app.py`: core Flask + Socket.IO app
+- `ssh_agent.py`: SSH and connection pool logic
+- `auth.py`: auth decorators and user helpers
+- `templates/`: web UI templates (`index`, `login`, `collab`, `share`)
+- `tests/`: reboot/network/ssd blueprints and test state handling
+- `static/vendor/`: local frontend dependencies (React/Babel/Tailwind/xterm/socket.io/simple-peer/fonts)
+- `*.json`: runtime/config/test/share/audit data files
+
+## Requirements
+
+- Python 3.9+ recommended
+- Windows/Linux supported (some X11 and serial paths are platform-specific)
+
+Install Python dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+Optional:
+
+- `pyserial` for serial console support
+- `pyOpenSSL` for local certificate generation (if cert files are missing)
+
+## Checkout Source Code
+
+Clone by HTTPS:
+
+```bash
+git clone https://github.com/<org-or-user>/<repo>.git
+cd <repo>
+```
+
+Clone by SSH:
+
+```bash
+git clone git@github.com:<org-or-user>/<repo>.git
+cd <repo>
+```
+
+Checkout a specific branch:
+
+```bash
+git fetch --all --prune
+git checkout <branch-name>
+git pull --ff-only
+```
+
+Checkout a specific commit:
+
+```bash
+git fetch --all --prune
+git checkout <commit-sha>
+```
+
+Create a working branch from current HEAD:
+
+```bash
+git switch -c <new-branch-name>
+```
+
+## Run
+
+Default (HTTPS mode, auto cert handling):
+
+```bash
+python opspilot.py
+```
+
+HTTP mode:
+
+```bash
+python opspilot.py --http
+```
+
+Custom port:
+
+```bash
+python opspilot.py --port 6000
+```
+
+Then open:
+
+- `https://<host-ip>:5000` (default)
+- or `http://<host-ip>:5000` with `--http`
+
+## Authentication
+
+- Login page: `/login`
+- Default credential in UI hint: `admin / admin` (change immediately in real environments)
+
+## Notes
+
+- This project currently uses Flask debug/dev server settings for convenience.
+- Data is persisted in local JSON files; back them up regularly.
+- Frontend dependencies are available locally in `static/vendor`, so UI can run without public CDN access.
+- Security baseline (2026-02-27):
+  - `llm_config.json` and `rooms.json` are local-only and ignored by git.
+  - Runtime logs (`*.log`) must not be committed.
+  - If secrets were ever committed, rotate credentials first, then rewrite history.
+
+## Security and Git Hygiene
+
+- Keep secrets in environment variables or local untracked files only.
+- Never commit bot tokens, API keys, chat IDs, or runtime logs.
+- For Telegram bridge operations:
+  - restrict with `ALLOWED_USER_IDS` / `ALLOWED_CHAT_IDS`
+  - keep shell mode behind explicit intent (`shell:`) and safety policy
+  - monitor usage via `GET /api/telegram/bridge/metrics`
+- If history rewrite is performed:
+  - force-push is required
+  - all collaborators must re-sync (`git fetch --all --prune` and reset/reclone)
+
+## Troubleshooting
+
+- If style looks broken, force refresh (`Ctrl+F5`) to clear old browser cache.
+- If `Cannot access 'xxx' before initialization` appears, ensure latest templates are deployed and cache is cleared.
+- If HTTPS certificate warnings appear, trust local cert for internal use or run with `--http` in trusted networks.
+

package/bin/opspilot.js

@@ -0,0 +1,280 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * OpsPilot Local — CLI
+ * Wraps Docker to pull, run, update, and manage the OpsPilot Local container.
+ *
+ * Usage:
+ *   npx opspilot start --token <license-token>
+ *   opspilot start --token <token> --port 5000
+ *   opspilot stop
+ *   opspilot logs [-f]
+ *   opspilot update
+ *   opspilot status
+ *   opspilot config            # show saved config
+ */
+
+const { execSync, spawnSync } = require('child_process');
+const fs   = require('fs');
+const path = require('path');
+const os   = require('os');
+
+// ── Constants ────────────────────────────────────────────────────────────────
+
+const IMAGE      = 'opspilot/local:latest';
+const CONTAINER  = 'opspilot';
+const CONFIG_DIR  = path.join(os.homedir(), '.opspilot');
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+const CYAN   = '\x1b[36m';
+const GREEN  = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+const RED    = '\x1b[31m';
+const BOLD   = '\x1b[1m';
+const RESET  = '\x1b[0m';
+
+// ── Helpers ──────────────────────────────────────────────────────────────────
+
+function log(msg)  { console.log(`${CYAN}[opspilot]${RESET} ${msg}`); }
+function ok(msg)   { console.log(`${GREEN}✓${RESET} ${msg}`); }
+function warn(msg) { console.log(`${YELLOW}⚠${RESET}  ${msg}`); }
+function die(msg)  { console.error(`${RED}✗${RESET}  ${msg}`); process.exit(1); }
+
+function run(cmd, opts = {}) {
+  return execSync(cmd, { stdio: opts.silent ? 'pipe' : 'inherit', encoding: 'utf8' });
+}
+
+function tryRun(cmd) {
+  try { return execSync(cmd, { stdio: 'pipe', encoding: 'utf8' }).trim(); }
+  catch { return null; }
+}
+
+function checkDocker() {
+  if (!tryRun('docker --version')) {
+    die(
+      'Docker is not installed or not in PATH.\n' +
+      '  Install Docker Desktop: https://docs.docker.com/get-docker/'
+    );
+  }
+}
+
+// ── Config (persisted in ~/.opspilot/config.json) ────────────────────────────
+
+function loadConfig() {
+  try {
+    return JSON.parse(fs.readFileSync(CONFIG_FILE, 'utf8'));
+  } catch { return {}; }
+}
+
+function saveConfig(data) {
+  fs.mkdirSync(CONFIG_DIR, { recursive: true });
+  const merged = Object.assign(loadConfig(), data);
+  fs.writeFileSync(CONFIG_FILE, JSON.stringify(merged, null, 2));
+}
+
+// ── Arg parser (zero dependencies) ──────────────────────────────────────────
+
+function parseArgs(argv) {
+  const args = { flags: {}, positional: [] };
+  for (let i = 0; i < argv.length; i++) {
+    if (argv[i].startsWith('--')) {
+      const key = argv[i].slice(2);
+      if (argv[i + 1] && !argv[i + 1].startsWith('-')) {
+        args.flags[key] = argv[++i];
+      } else {
+        args.flags[key] = true;
+      }
+    } else if (argv[i].startsWith('-') && argv[i].length === 2) {
+      args.flags[argv[i].slice(1)] = true;
+    } else {
+      args.positional.push(argv[i]);
+    }
+  }
+  return args;
+}
+
+// ── Commands ─────────────────────────────────────────────────────────────────
+
+function cmdStart(flags) {
+  checkDocker();
+
+  const cfg   = loadConfig();
+  const token = flags.token    || cfg.token    || '';
+  const url   = flags['cloud-url'] || cfg.cloudUrl || 'https://teams.codetop.net';
+  const port  = flags.port     || cfg.port     || '5000';
+  const data  = flags['data-dir'] || cfg.dataDir || 'opspilot-data';
+
+  if (!token) {
+    die(
+      'License token required.\n' +
+      '  opspilot start --token <your-license-token>\n' +
+      '  Get a token at: https://teams.codetop.net/dashboard'
+    );
+  }
+
+  // Persist for next run
+  saveConfig({ token, cloudUrl: url, port, dataDir: data });
+
+  // Stop existing container if running
+  const existing = tryRun(`docker inspect -f "{{.State.Status}}" ${CONTAINER} 2>/dev/null`);
+  if (existing === 'running') {
+    log('Stopping existing container ...');
+    run(`docker stop ${CONTAINER}`, { silent: true });
+  }
+  if (existing) {
+    run(`docker rm -f ${CONTAINER}`, { silent: true });
+  }
+
+  // Pull latest image
+  log(`Pulling ${IMAGE} ...`);
+  run(`docker pull ${IMAGE}`);
+
+  // Volume arg: named volume or host path
+  const isAbsolute = path.isAbsolute(data);
+  const volArg = isAbsolute ? `${data}:/app/data` : `${data}:/app/data`;
+
+  log(`Starting OpsPilot Local on port ${port} ...`);
+  run(
+    `docker run -d ` +
+    `--name ${CONTAINER} ` +
+    `-p ${port}:5000 ` +
+    `-e OPSPILOT_CLOUD_URL=${url} ` +
+    `-e OPSPILOT_CLOUD_TOKEN=${token} ` +
+    `-e OPSPILOT_PORT=5000 ` +
+    `-v ${volArg} ` +
+    `--restart unless-stopped ` +
+    `${IMAGE}`
+  );
+
+  console.log('');
+  ok(`OpsPilot Local is running!`);
+  console.log(`${BOLD}  URL :${RESET} http://localhost:${port}`);
+  console.log(`${BOLD}  Data:${RESET} ${isAbsolute ? data : `docker volume '${data}'`}`);
+  console.log('');
+  console.log(`  ${CYAN}opspilot logs -f${RESET}   — tail live logs`);
+  console.log(`  ${CYAN}opspilot stop${RESET}       — stop the server`);
+  console.log(`  ${CYAN}opspilot update${RESET}     — upgrade to latest`);
+}
+
+function cmdStop() {
+  checkDocker();
+  const status = tryRun(`docker inspect -f "{{.State.Status}}" ${CONTAINER} 2>/dev/null`);
+  if (!status) {
+    warn(`No container named '${CONTAINER}' found.`);
+    return;
+  }
+  log('Stopping OpsPilot ...');
+  run(`docker stop ${CONTAINER}`, { silent: true });
+  run(`docker rm ${CONTAINER}`,   { silent: true });
+  ok('Stopped.');
+}
+
+function cmdLogs(flags) {
+  checkDocker();
+  const follow = flags.f ? '-f' : '';
+  const result = spawnSync('docker', ['logs', follow, '--tail', '200', CONTAINER].filter(Boolean), { stdio: 'inherit' });
+  if (result.status !== 0) die(`Container '${CONTAINER}' not found. Run: opspilot start`);
+}
+
+function cmdUpdate() {
+  checkDocker();
+  const cfg = loadConfig();
+  if (!cfg.token) die('No saved token found. Run: opspilot start --token <token>');
+
+  log(`Pulling latest ${IMAGE} ...`);
+  run(`docker pull ${IMAGE}`);
+
+  log('Restarting with new image ...');
+  cmdStop();
+  cmdStart(cfg.flags || {});  // reuse saved config
+}
+
+function cmdStatus() {
+  checkDocker();
+  const status = tryRun(`docker inspect -f "{{.State.Status}}" ${CONTAINER} 2>/dev/null`);
+  if (!status) {
+    warn(`Container '${CONTAINER}' not found.`);
+    return;
+  }
+  const cfg  = loadConfig();
+  const port = cfg.port || '5000';
+  console.log(`${BOLD}Container:${RESET} ${CONTAINER}`);
+  console.log(`${BOLD}Status   :${RESET} ${status === 'running' ? GREEN : RED}${status}${RESET}`);
+  if (status === 'running') console.log(`${BOLD}URL      :${RESET} http://localhost:${port}`);
+}
+
+function cmdConfig() {
+  const cfg = loadConfig();
+  if (Object.keys(cfg).length === 0) {
+    warn(`No config saved yet. Run: opspilot start --token <token>`);
+    return;
+  }
+  console.log(`${BOLD}Saved config${RESET} (${CONFIG_FILE}):`);
+  const safe = Object.assign({}, cfg);
+  if (safe.token) safe.token = safe.token.slice(0, 6) + '…';   // redact
+  console.log(JSON.stringify(safe, null, 2));
+}
+
+function printHelp() {
+  console.log(`
+${BOLD}${CYAN}OpsPilot Local${RESET} — CLI v1.0.0
+
+${BOLD}Usage:${RESET}
+  opspilot <command> [options]
+
+${BOLD}Commands:${RESET}
+  ${CYAN}start${RESET}   Pull image and start the container
+  ${CYAN}stop${RESET}    Stop and remove the container
+  ${CYAN}logs${RESET}    Show container logs  (-f to follow)
+  ${CYAN}update${RESET}  Pull latest image and restart
+  ${CYAN}status${RESET}  Show container status
+  ${CYAN}config${RESET}  Show saved local config
+
+${BOLD}Start options:${RESET}
+  --token     <token>   License token from OpsPilot Cloud  ${YELLOW}(required on first run)${RESET}
+  --cloud-url <url>     Cloud server URL  [default: https://teams.codetop.net]
+  --port      <port>    Local port        [default: 5000]
+  --data-dir  <path>    Host data path or Docker volume name  [default: opspilot-data]
+
+${BOLD}Examples:${RESET}
+  npx opspilot start --token eyJ...
+  opspilot start --token eyJ... --port 8080
+  opspilot logs -f
+  opspilot update
+`);
+}
+
+// ── Main ─────────────────────────────────────────────────────────────────────
+
+const argv   = process.argv.slice(2);
+const parsed = parseArgs(argv);
+const cmd    = parsed.positional[0];
+
+switch (cmd) {
+  case 'start':  cmdStart(parsed.flags);  break;
+  case 'stop':   cmdStop();               break;
+  case 'logs':   cmdLogs(parsed.flags);   break;
+  case 'update':
+    // cmdUpdate reuses saved config; allow overriding token inline
+    (function () {
+      const cfg = loadConfig();
+      if (parsed.flags.token) cfg.token = parsed.flags.token;
+      checkDocker();
+      log(`Pulling latest ${IMAGE} ...`);
+      run(`docker pull ${IMAGE}`);
+      log('Restarting ...');
+      cmdStop();
+      cmdStart(Object.assign({}, cfg, parsed.flags));
+    })();
+    break;
+  case 'status': cmdStatus();             break;
+  case 'config': cmdConfig();             break;
+  case undefined:
+  case 'help':
+  case '--help':
+  case '-h':
+    printHelp(); break;
+  default:
+    die(`Unknown command: ${cmd}\nRun: opspilot --help`);
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@justin0713/opspilot",
+  "version": "1.0.0",
+  "description": "CLI installer for OpsPilot Local — self-hosted SSH operations platform",
+  "license": "MIT",
+  "homepage": "https://github.com/Albert0977/ShellShare#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Albert0977/ShellShare.git"
+  },
+  "keywords": ["opspilot", "ssh", "terminal", "ops", "docker"],
+  "bin": {
+    "opspilot": "bin/opspilot.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "bin/"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}