@logboard/cli 1.0.0

package/.env.example

@@ -0,0 +1,37 @@
+# ──────────────────────────────────────────────────────────────
+# LogBoard — Environment Configuration
+# Copy to .env and fill in your values: cp .env.example .env
+# ──────────────────────────────────────────────────────────────
+
+# Server
+NODE_ENV=development     # development | production
+PORT=9900
+
+# Security (generate with: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))")
+JWT_SECRET=change-me-at-least-32-chars-long-random-string
+JWT_EXPIRES_IN=24h       # Session duration
+
+# Legacy single API key (backward compat — prefer the API Keys UI)
+API_KEY=change-me-secret-key
+
+# Storage paths (relative to project root or absolute)
+DATA_DIR=./data           # users.json, settings.json, role-config.json, api-keys.json
+LOG_BASE_DIR=./logs       # Ingested log files
+
+# Log retention
+RETENTION_DAYS=7          # Days to keep log files
+
+# Features
+ENABLE_STREAM=true        # Enable SSE real-time stream
+
+# CORS (comma-separated allowed origins)
+CORS_ORIGINS=http://localhost:9900
+
+# Optional: Webhook URL for error alerts
+WEBHOOK_URL=
+
+# File names (relative to DATA_DIR — change if needed)
+# USERS_FILE=users.json
+# SETTINGS_FILE=settings.json
+# ROLES_FILE=role-config.json
+# API_KEYS_FILE=api-keys.json

package/README.md

@@ -0,0 +1,200 @@
+# @logboard/cli
+
+> **Production-grade log aggregator** — real-time dashboard, RBAC, multi-org, alerts, audit trail, and API analytics. One-command install on macOS, Linux & Windows.
+
+[![npm](https://img.shields.io/npm/v/@logboard/cli)](https://www.npmjs.com/package/@logboard/cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
+
+---
+
+## Quick Start
+
+```bash
+npx @logboard/cli
+# or install globally
+npm install -g @logboard/cli
+logboard
+```
+
+Open **http://localhost:9900** — first-run setup wizard runs automatically.
+
+Default credentials (change immediately):
+| Field | Value |
+|-------|-------|
+| Username | `admin` |
+| Password | set during first-run setup |
+
+---
+
+## Features
+
+| Category | What you get |
+|----------|-------------|
+| **Log Ingestion** | HTTP push endpoint — works with any language/framework |
+| **Real-time Stream** | SSE-based live log tail in the browser |
+| **RBAC** | Super-admin → Admin → Viewer roles, fully configurable |
+| **Multi-org** | Isolated organisations with per-org settings and API keys |
+| **Alerts** | Rule-based alerts via Webhook, Email, Slack, Discord |
+| **API Analytics** | Per-endpoint latency, error rate, traffic graphs |
+| **Audit Trail** | Every admin action logged with actor + timestamp |
+| **Archiving** | Automatic log rotation and compressed archive downloads |
+| **Health Monitor** | Process + host health dashboard |
+| **Auth** | JWT sessions, 2FA (TOTP), Google & GitHub OAuth |
+
+---
+
+## Installation Options
+
+### Global (recommended for production servers)
+
+```bash
+npm install -g @logboard/cli
+logboard
+```
+
+### Docker
+
+```bash
+docker run -p 9900:9900 -v $(pwd)/data:/app/data logboard/cli
+```
+
+### Manual clone
+
+```bash
+git clone https://github.com/logboards/logboard-cli.git
+cd logboard-cli
+npm install
+npm run setup   # first-run only
+npm start
+```
+
+---
+
+## Configuration
+
+All config lives in `.env` (auto-generated on first run from `.env.example`):
+
+```env
+PORT=9900
+NODE_ENV=production
+
+JWT_SECRET=<random-32-char-string>
+JWT_EXPIRES_IN=24h
+
+DATA_DIR=./data
+LOG_BASE_DIR=./logs
+RETENTION_DAYS=7
+
+CORS_ORIGINS=https://your-domain.com
+WEBHOOK_URL=                         # optional: Slack/Discord/custom webhook
+```
+
+Generate a strong secret:
+```bash
+node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
+```
+
+---
+
+## Sending Logs
+
+Use the companion SDK **[@logboard/logger](https://www.npmjs.com/package/@logboard/logger)** or push raw NDJSON:
+
+```bash
+# Raw HTTP push
+curl -X POST http://localhost:9900/api/logs \
+  -H "x-api-key: YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{"level":"info","message":"Server started","service":"api","timestamp":"2026-01-01T00:00:00Z"}'
+```
+
+```js
+// With @logboard/logger SDK
+const { createLogger } = require('@logboard/logger');
+
+const logger = createLogger({
+  serviceName: 'my-api',
+  transports: [{
+    type: 'logboard',
+    url: 'http://localhost:9900',
+    apiKey: process.env.LOGBOARD_API_KEY,
+  }],
+});
+
+logger.info('Server started', { port: 3000 });
+logger.error('DB connection failed', { err: error.message });
+```
+
+---
+
+## API Reference
+
+All API routes are prefixed `/api/` and require an `x-api-key` header (manage keys in Settings → API Keys).
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `POST` | `/api/logs` | Ingest one or more log entries |
+| `GET` | `/api/logs` | Query logs (filter, search, paginate) |
+| `GET` | `/api/logs/stream` | SSE real-time stream |
+| `GET` | `/api/analytics` | Log volume and error-rate stats |
+| `GET` | `/api/health` | Server health status |
+
+---
+
+## Production Deployment
+
+### PM2
+
+```bash
+npm install -g pm2
+pm2 start server.js --name logboard
+pm2 save && pm2 startup
+```
+
+### systemd
+
+```ini
+[Unit]
+Description=LogBoard
+After=network.target
+
+[Service]
+WorkingDirectory=/opt/logboard
+ExecStart=/usr/bin/node server.js
+Restart=always
+EnvironmentFile=/opt/logboard/.env
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Nginx reverse proxy
+
+```nginx
+location / {
+    proxy_pass http://127.0.0.1:9900;
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection 'upgrade';
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_cache_bypass $http_upgrade;
+}
+```
+
+---
+
+## Security
+
+- All passwords are bcrypt-hashed (cost factor 12).
+- JWT tokens expire in `JWT_EXPIRES_IN` (default 24 h).
+- IP whitelist middleware available — configure in Settings.
+- Rate limiting enabled on all routes.
+- Helmet.js security headers included.
+- **Change the default credentials immediately after first run.**
+
+---
+
+## License
+
+MIT © LogBoard Team