saymon-syswatch-linux 1.0.0

package/README.md

@@ -0,0 +1,154 @@
+# SysWatch 🖥️
+
+**Linux system monitor + learning dashboard** — install it, run it, done.
+
+Monitor CPU, memory, disk, services, journal logs and processes from a web UI.
+Every panel shows the exact Linux commands being used — so you **learn while you monitor**.
+
+---
+
+## ⚡ Install & Run (3 steps)
+
+```bash
+# Step 1 — Install
+sudo npm install -g syswatch
+
+# Step 2 — Run (first time auto-runs setup wizard)
+sudo syswatch
+
+# Step 3 — Open browser
+# http://localhost:8080
+```
+
+**That's it.** On first run, a setup wizard asks you 4 simple questions in the terminal — including your password — and creates the config file automatically.
+
+---
+
+## 🧙 First-Run Setup Wizard
+
+When you run SysWatch for the first time (no config found), it automatically starts an interactive wizard:
+
+```
+╭──────────────────────────────────────────────────────╮
+│   SysWatch — First Time Setup                        │
+│   Takes about 30 seconds ⚡                          │
+╰──────────────────────────────────────────────────────╯
+
+Step 1/4 — Set your login password
+  Enter password: ********
+  Confirm password: ********
+  ✓ Password set!
+
+Step 2/4 — HTTP Port
+  Port [8080]: (press Enter for default)
+  ✓ HTTP port: 8080
+
+Step 3/4 — Who can access SysWatch?
+  1) Only this computer  (localhost) ← safer
+  2) Anyone on my network (0.0.0.0)
+  Choose [1]:
+  ✓ Access: Localhost only
+
+Step 4/4 — Enable HTTPS?
+  Enable HTTPS? [y/N]:
+  ✓ HTTPS: Disabled
+
+  ✓ Setup complete! Config saved → syswatch.config.json
+  Starting SysWatch → http://localhost:8080
+```
+
+The wizard creates `syswatch.config.json` automatically. **No manual editing needed.**
+
+---
+
+## 🔁 Re-run Setup (change password, port, etc.)
+
+```bash
+sudo syswatch --setup
+```
+
+---
+
+## ⚙️ CLI Options
+
+```bash
+sudo syswatch                 # first run = setup wizard, then start
+sudo syswatch --setup         # re-run setup wizard anytime
+sudo syswatch --no-auth       # skip password (local testing only)
+sudo syswatch --port 3000     # override port
+sudo syswatch --host 0.0.0.0  # allow LAN access
+sudo syswatch --https         # enable HTTPS too
+sudo syswatch --help          # show all options
+```
+
+---
+
+## 🔒 HTTPS
+
+**Self-signed (quick):** Answer "y" to the HTTPS question in setup. A cert is auto-generated. Browser will warn "Not Secure" — click Advanced → Proceed. Normal for self-signed.
+
+**Let's Encrypt (real domain):**
+```bash
+sudo certbot certonly --standalone -d yourdomain.com
+# Then edit syswatch.config.json:
+# "certPath": "/etc/letsencrypt/live/yourdomain.com/fullchain.pem"
+# "keyPath":  "/etc/letsencrypt/live/yourdomain.com/privkey.pem"
+```
+
+---
+
+## 🔄 Auto-start on boot (systemd)
+
+```bash
+sudo nano /etc/systemd/system/syswatch.service
+```
+```ini
+[Unit]
+Description=SysWatch Linux Monitor
+After=network.target
+
+[Service]
+Type=simple
+User=root
+ExecStart=/usr/bin/syswatch
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable --now syswatch
+```
+
+---
+
+## 📚 Learn Mode
+
+Toggle **📖 Learn Mode** in the dashboard top-right. Every panel shows:
+- The exact Linux command being run
+- What each flag does
+- The Node.js code that calls it
+
+| Panel | Commands you learn |
+|-------|--------------------|
+| Overview | `/proc/stat` · `/proc/meminfo` · `/proc/loadavg` · `/proc/net/dev` |
+| Services | `systemctl list-units` · `systemctl show` · `systemctl restart` |
+| Logs | `journalctl -f -u nginx -p err -o json --since "1h ago"` |
+| Processes | `ps aux` · `/proc/PID/stat` · `kill -9 PID` |
+| Boot | `systemd-analyze blame` · `critical-chain` · `plot` |
+
+---
+
+## 🐧 Requirements
+
+- **Linux** — Ubuntu 20.04+, Debian 11+, RHEL 8+, Arch, etc.
+- **Node.js 18+** — https://nodejs.org
+- **systemd** — for service control and journalctl
+- **sudo/root** — needed for journal access and service control
+
+---
+
+## 📄 License
+
+MIT

package/bin/gen-cert.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+// ─────────────────────────────────────────────────────
+//  bin/gen-cert.js
+//  Generates a self-signed TLS cert for HTTPS mode.
+//  Uses openssl — must be installed on the system.
+//  Saves to: certs/key.pem + certs/cert.pem
+// ─────────────────────────────────────────────────────
+'use strict';
+
+const { execSync } = require('child_process');
+const fs   = require('fs');
+const path = require('path');
+
+const certsDir = path.join(__dirname, '..', 'certs');
+
+function generateCert() {
+  if (!fs.existsSync(certsDir)) fs.mkdirSync(certsDir, { recursive: true });
+
+  const keyPath  = path.join(certsDir, 'key.pem');
+  const certPath = path.join(certsDir, 'cert.pem');
+
+  if (fs.existsSync(keyPath) && fs.existsSync(certPath)) {
+    console.log('✓ Certificates already exist at certs/');
+    return { keyPath, certPath };
+  }
+
+  console.log('🔐 Generating self-signed TLS certificate...');
+
+  try {
+    execSync(
+      `openssl req -x509 -newkey rsa:2048 -keyout "${keyPath}" \
+       -out "${certPath}" -days 365 -nodes \
+       -subj "/CN=syswatch/O=SysWatch/C=US"`,
+      { stdio: 'pipe' }
+    );
+    console.log('✓ Certificates saved to certs/key.pem + certs/cert.pem');
+    console.log('  Note: Browser will warn "Not secure" for self-signed certs — that is normal.');
+    console.log('  For production, replace with Let\'s Encrypt certs.');
+  } catch (e) {
+    console.error('✗ openssl not found. Install it:  sudo apt install openssl');
+    process.exit(1);
+  }
+
+  return { keyPath, certPath };
+}
+
+module.exports = { generateCert };
+
+// run directly
+if (require.main === module) generateCert();

package/bin/syswatch.js

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+// ─────────────────────────────────────────────────────
+//  SysWatch CLI  —  bin/syswatch.js
+//  Usage:
+//    npx syswatch                   # quick start HTTP
+//    npx syswatch --https           # HTTP + HTTPS
+//    npx syswatch --port 9000       # custom port
+//    npx syswatch --host 0.0.0.0    # bind all interfaces
+//    npx syswatch --setup           # interactive first-run wizard
+// ─────────────────────────────────────────────────────
+'use strict';
+
+const path = require('path');
+const args = process.argv.slice(2);
+
+// ── help ───────────────────────────────────────────────
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(`
+  ╔══════════════════════════════════════════╗
+  ║   SysWatch  —  Linux Monitor + Learn     ║
+  ╚══════════════════════════════════════════╝
+
+  Usage:
+    npx syswatch [options]
+
+  Options:
+    --port <n>        HTTP port        (default: 8080)
+    --https-port <n>  HTTPS port       (default: 8443)
+    --host <ip>       Bind address     (default: 127.0.0.1)
+    --https           Enable HTTPS too
+    --no-auth         Disable password protection
+    --setup           Run first-time setup wizard
+    --help            Show this help
+
+  Examples:
+    npx syswatch                         # localhost:8080
+    npx syswatch --host 0.0.0.0          # LAN access
+    npx syswatch --https                 # HTTP + HTTPS
+    npx syswatch --port 3000 --no-auth   # no password, port 3000
+  `);
+  process.exit(0);
+}
+
+// ── setup wizard ──────────────────────────────────────
+if (args.includes('--setup')) {
+  // force re-run setup even if config exists
+  require('../src/setup').run(false);
+} else {
+  // server.js will auto-detect missing config and run setup
+  require('../src/server');
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "saymon-syswatch-linux",
+  "version": "1.0.0",
+  "description": "Linux system monitor & learning dashboard — HTTP/HTTPS, journal logs, services, processes",
+  "main": "src/server.js",
+  "bin": {
+    "syswatch": "./bin/syswatch.js"
+  },
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "node src/server.js --dev",
+    "setup-https": "node bin/gen-cert.js"
+  },
+  "keywords": ["linux", "monitor", "systemd", "journalctl", "sysadmin", "dashboard", "learning"],
+  "author": "Saymon",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.18.2",
+    "cors": "^2.8.5",
+    "bcrypt": "^5.1.1",
+    "jsonwebtoken": "^9.0.2",
+    "cookie-parser": "^1.4.6",
+    "express-rate-limit": "^7.1.5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}