Documentation

Everything you need to know about SimpleTunnel features, setup, and advanced usage

πŸš€ Getting Started

Quick start guide to get your first tunnel running in under a minute. Installation, basic commands, and your first tunnel.

Read guide β†’

πŸ”Œ Multi-Port Tunneling

Expose HTTP and TCP services on a single hostname. Perfect for full-stack apps with databases, APIs, and frontends.

Learn more β†’

πŸ’¬ WebSocket Support

Real-time bidirectional communication. Use with Streamlit, Jupyter, Socket.io, and any WebSocket-based application.

See examples β†’

πŸ” TCP Tunneling

Tunnel databases, SSH, game servers, or any TCP service. Get a dedicated port and hostname for your service.

View guide β†’

🌐 Custom Domains

Use your own domain with SimpleTunnel. Configure DNS, root domain support, and custom subdomains.

Setup guide β†’

☸️ Kubernetes Controller

Native Kubernetes integration with Helm charts, CRDs, and annotations. Expose any service with one line.

Deploy now β†’

πŸ”’ Password Protection

Secure your tunnels with HTTP Basic Authentication. Control access to your development work and demos.

Configure β†’

πŸ› οΈ CLI Reference

Complete command-line reference. All flags, options, and configuration settings explained with examples.

Full reference β†’

πŸ“š API Documentation

REST API reference for tunnel management, monitoring, and automation. Build integrations and tools.

API docs β†’