instbyte 1.9.3 → 1.10.0

package/README.md

@@ -102,147 +102,19 @@ For teams who want auth, custom retention, or branding — create `instbyte.conf
 
 Then run `npx instbyte` in the same directory. The config is picked up automatically.
 
-### Keeping It Running
-For persistent team use, run it as a background process:
-
-```bash
-# using pm2
-npm install -g pm2
-pm2 start "npx instbyte" --name instbyte
-pm2 save
-```
-
-Or use any process manager you already have — systemd, screen, tmux.
+For persistent deployment options including pm2, systemd, and Docker, see the [Deployment Guide](docs/deployment.md).
 
 ---
 
 ## Docker
 
-The fastest way to run Instbyte with Docker:
-```bash
-docker compose up -d
-```
-
-Or with plain Docker:
-```bash
-docker run -d \
-  -p 3000:3000 \
-  -v $(pwd)/instbyte-data:/data \
-  -e INSTBYTE_DATA=/data \
-  -e INSTBYTE_UPLOADS=/data/uploads \
-  --name instbyte \
-  mohitgauniyal/instbyte
-```
-
-Data persists in `./instbyte-data` on your host. The same folder used by `npx instbyte` — so switching between the two preserves all your data.
-
-### With a config file
-
-Mount your config file into the container:
-```yaml
-services:
-  instbyte:
-    image: mohitgauniyal/instbyte
-    ports:
-      - "3000:3000"
-    volumes:
-      - ./instbyte-data:/data
-      - ./instbyte.config.json:/app/instbyte.config.json
-    environment:
-      - INSTBYTE_DATA=/data
-      - INSTBYTE_UPLOADS=/data/uploads
-    restart: unless-stopped
-```
-
-### Changing the port
-
-Edit the host port in `docker-compose.yml`:
-```yaml
-ports:
-  - "8080:3000"  # now runs on port 8080
-```
-
-> **Note:** File uploads may not work correctly on Windows Docker Desktop due to network limitations. For Windows, use `npx instbyte` directly or deploy on a Linux server.
+For Docker setup, persistent data, and config file mounting, see [Deployment Guide](docs/deployment.md).
 
 ---
 
 ## Reverse Proxy
 
-For teams who want to access Instbyte over HTTPS or from outside their local network, running it behind a reverse proxy is the standard approach.
-
-> **Important:** Instbyte uses WebSockets for real-time sync. Your proxy must be configured to forward WebSocket connections — otherwise the app will load but live updates will stop working.
-
-### Nginx
-```nginx
-server {
-    listen 80;
-    server_name instbyte.yourdomain.com;
-
-    # Redirect HTTP to HTTPS
-    return 301 https://$host$request_uri;
-}
-
-server {
-    listen 443 ssl;
-    server_name instbyte.yourdomain.com;
-
-    ssl_certificate     /etc/letsencrypt/live/instbyte.yourdomain.com/fullchain.pem;
-    ssl_certificate_key /etc/letsencrypt/live/instbyte.yourdomain.com/privkey.pem;
-
-    # Increase max upload size to match Instbyte's limit
-    client_max_body_size 2G;
-
-    location / {
-        proxy_pass http://localhost:3000;
-        proxy_http_version 1.1;
-
-        # Required for WebSocket support
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "upgrade";
-
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-
-        # Prevent proxy timeouts on large uploads
-        proxy_read_timeout 300s;
-        proxy_send_timeout 300s;
-    }
-}
-```
-
-Get a free SSL certificate with Certbot:
-```bash
-certbot --nginx -d instbyte.yourdomain.com
-```
-
-### Caddy
-
-Caddy automatically handles HTTPS certificates — no Certbot needed.
-```caddy
-instbyte.yourdomain.com {
-    reverse_proxy localhost:3000
-}
-```
-
-Caddy handles WebSocket forwarding and HTTPS automatically. That's all you need.
-
-### With Docker
-
-If running Instbyte via Docker, proxy to the mapped host port:
-```nginx
-proxy_pass http://localhost:3000;
-```
-
-Or use Docker's internal network — replace `localhost` with the container name:
-```nginx
-proxy_pass http://instbyte:3000;
-```
-
-### Keeping it LAN-only
-
-If you don't want external access but still want HTTPS on your local network, tools like [Tailscale](https://tailscale.com) or [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) are good options that require no open ports.
+For Nginx, Caddy, and HTTPS setup, see [Deployment Guide](docs/deployment.md).
 
 ---
 
@@ -305,13 +177,47 @@ The difference between *a tool you use* and *a tool you own.*
 
 **Presence awareness** — see how many people are currently connected in real time.
 
+**Live broadcast** — share your screen in real time with everyone on the network. Viewers join instantly from their browser, no plugins or installs needed. Built on WebRTC for smooth, low-latency video. Includes mic audio, viewer mute/unmute, raise hand, and screen capture to channel.
+
 **Read receipts** — see how many devices have viewed each shared item. Updates live as teammates open the page.
 
 **Item management** — add optional titles to label any item for future reference. Edit text items inline without deleting and re-pasting. Pinned items are protected from both manual deletion and auto-cleanup.
+
+**Mobile ready** — install as a PWA directly from your browser. Add to Home Screen on iOS or Android for a native app feel without the App Store.
+
+**Security hardened** — rate limiting on all write endpoints, magic number file validation, filename sanitisation, and forced download for executable file types.
+
+---
+
+## Broadcasting
+
+One person shares their screen — everyone else on the network watches live in their browser. No plugins, no accounts, no external services. Built on WebRTC for smooth, low-latency video.
+
+### How to broadcast
+
+Click **📡 Broadcast** in the composer. Your browser will ask you to choose a screen, window, or tab to share. Once you pick one, a live bar appears at the top for all connected devices — teammates click **Join** to watch.
+
+While broadcasting you can still use Instbyte normally — send text, drop files, switch channels. The broadcast runs in the background.
+
+To stop, click **⏹ Stop** in the composer or use the browser's built-in "Stop sharing" bar.
+
+### As a viewer
+
+When a broadcast is live, a bar appears at the top of the page. Click **Join** to open the viewer panel. The panel is draggable and resizable — move it anywhere on your screen.
+
+- **📸 Capture** — saves the current frame as an image to the active channel
+- **✋ Raise hand** — notifies the broadcaster with a sound and toast
+- **🔇 / 🔊** — mute and unmute audio
+- **─** — minimize the panel without leaving the broadcast
+- **✕** — leave the broadcast entirely
+
+For HTTPS setup, enabling broadcast for all devices, and advanced network configuration, see the [Deployment Guide](docs/deployment.md#broadcasting).
+
 ---
 
 ## Keyboard Shortcuts
 
+```
 | Key | Action |
 |---|---|
 | `/` | Focus search |
@@ -335,10 +241,19 @@ node server/server.js
 
 ## Use Cases
 
-- Moving content between your phone and laptop over WiFi
+- Moving content between your phone and laptop, or just any device over WiFi
 - Sharing API payloads, logs, or screenshots during a sprint
 - A lightweight team clipboard during standups or pair sessions
 - Home lab file sharing without setting up NAS or cloud sync
+- Piping build logs or stack traces from CI or terminal directly into a shared channel
+- Sharing sensitive credentials or config files over LAN without leaving a cloud trail
+- Live screen sharing during standups, design reviews, or debugging sessions — no Zoom link needed
+
+---
+
+## Terminal Usage
+
+Push content from your terminal using curl — no browser needed. See [Terminal Usage Guide](docs/terminal-usage.md).
 
 ---
 
@@ -352,6 +267,8 @@ Instbyte follows [Semantic Versioning](https://semver.org). See [Releases](https
 
 Instbyte is intentionally lightweight and LAN-first. If you want to extend it — CLI tools, themes, integrations — open an issue or submit a pull request.
 
+The codebase has a full test suite (195 tests across unit and integration). Run `npm test` before submitting anything. Issues tagged **good first issue** are a good starting point.
+
 ---
 
 ## License

package/bin/instbyte.js

@@ -25,4 +25,5 @@ process.env.INSTBYTE_UPLOADS = uploadsDir;
 // ========================
 // BOOT
 // ========================
+process.env.INSTBYTE_BOOT = '1';
 require("../server/server.js");