Skip to main content

VibeTunnel - Web Terminal Server

Run terminal sessions in your browser. Perfect for remote access, Docker containers, and quick terminal sharing via ngrok. npm version License: MIT

πŸš€ Quick Start

No installation needed - run instantly with npx:
Then open http://localhost:4020 in your browser.

πŸ“¦ Installation

Global Install

Docker

The packaged Dockerfile consumes only published runtime files. Repository builds continue to use the source-oriented web/Dockerfile.standalone.

🌐 Remote Access with Ngrok

Share your terminal with anyone on the internet:

πŸ”§ CLI Options

Server Options

  • --port <number> - Server port (default: 4020)
  • --bind <address> - Bind address (default: 0.0.0.0)
  • --debug - Enable debug logging

Authentication

  • --no-auth - Disable authentication (⚠️ use only for testing)
  • --enable-ssh-keys - Enable SSH key authentication
  • --disallow-user-password - SSH keys only, no passwords

Tunnel Options

  • --ngrok - Enable ngrok tunnel
  • --ngrok-auth <token> - Ngrok auth token
  • --ngrok-domain <domain> - Custom domain
  • --ngrok-region <region> - Region: us, eu, ap, au, sa, jp, in
  • --cloudflare - Enable Cloudflare Quick Tunnel (no auth)

πŸ’‘ Use Cases

Remote Server Management

Access any server’s terminal through a browser:

Docker Development

Add terminal access to any container:

Kubernetes Debugging

Deploy as a sidecar for pod debugging:

Teaching & Demos

Share your terminal for live coding sessions:

πŸ”’ Security

⚠️ Important Security Notes:
  1. Never use --no-auth in production - it disables all authentication
  2. Always use HTTPS in production - either via ngrok or a reverse proxy
  3. Consider SSH key authentication for better security
  4. Use environment variables for sensitive configuration

Production Setup

πŸ› οΈ Advanced Configuration

Environment Variables

  • PORT - Default port (overrides 4020)
  • VIBETUNNEL_DEBUG - Enable debug logging
  • NGROK_AUTHTOKEN - Ngrok auth token

Custom Configuration

Create ~/.vibetunnel/config.json:

πŸ“š Full Documentation

🀝 Contributing

Contributions welcome! Please check the main repository for guidelines.

πŸ“„ License

MIT - See LICENSE for details.
Note: This is the standalone web server version of VibeTunnel. For the full macOS app experience with menu bar integration, see the main project.