Answer-first summary

Where should I start in InstaTunnel docs?

Follow this order: Install CLI, authenticate, run first tunnel, then move to MCP/webhooks/referrals based on your use case. Use CLI Flags and Troubleshooting for day-to-day operations.

Last reviewed: March 5, 2026
Compatibility: Core docs align with CLI v1 default and MCP --transport v2 for streaming clients.

Quick command

instatunnel auth login -e you@example.com && instatunnel 3000 --subdomain docs-demo

Common failures and quick fixes

  • Auth not persisted-Run instatunnel auth set-key it_your_api_key to store your key locally.
  • Webhook 401 signature errors-Use provider-specific secret verification guides in /docs/webhooks before production tests.

Evidence and trust

Use these references when evaluating compatibility, reliability, and security posture.

Release cadence

CLI and docs release notes are updated continuously, with version-specific compatibility notes.

View release notes

Security controls

Review policy enforcement, auth layers, and operational safeguards in the security whitepaper.

Open security whitepaper

Reliability runbooks

Troubleshooting guides cover common failures, recovery steps, and CLI compatibility baselines.

Read troubleshooting guides

Troubleshooting

Resolve common InstaTunnel issues quickly with these troubleshooting guides and solutions.

πŸ”Œ Connection Issues

Tunnel Won't Start

❌ Error: Failed to connect to tunnel server

Check Your Internet Connection
# Test connectivity
$ ping instatunnel.my
$ curl -I https://api.instatunnel.my/health
Verify API Key
# Check API key format
$ instatunnel config show
# Test authentication
$ instatunnel auth test
Firewall & Proxy Issues
# Try different connection method
$ instatunnel 3000 --connection-type http
# Use proxy if needed
$ instatunnel 3000 --proxy http://proxy.company.com:8080

Tunnel Disconnects Frequently

Enable Auto-Restart
$ instatunnel 3000 --auto-restart --retry-interval 5s
Increase Keep-Alive
$ instatunnel 3000 --keep-alive 60s --timeout 120s
Switch Regions
$ instatunnel 3000 --region us-west # Try different region

Slow Performance

Enable Compression
$ instatunnel 3000 --compress --connections 10
Optimize Local App
  • β€’ Ensure your local app responds quickly (<100ms)
  • β€’ Check for slow database queries or API calls
  • β€’ Use local caching when possible
  • β€’ Minimize large file transfers

πŸšͺ Port & Application Issues

Port Already in Use

❌ Error: Port 3000 is already in use

Find What's Using the Port
# On macOS/Linux
$ lsof -i :3000
# On Windows
$ netstat -ano | findstr :3000
Use a Different Port
$ instatunnel 3001 # Try next available port
$ instatunnel 8000 # Or use common alternative
Auto-Detect Available Port
$ instatunnel --auto-port # Automatically find free port

App Not Responding

❌ Error: Connection refused to localhost:3000

Verify App is Running
# Test local access
$ curl http://localhost:3000
# Check if port is listening
$ telnet localhost 3000
Check App Configuration
  • β€’ Ensure app binds to 0.0.0.0 or localhost, not 127.0.0.1 only
  • β€’ Check if CORS is properly configured
  • β€’ Verify no authentication blocking local requests
  • β€’ Look for firewall rules blocking local connections

πŸ” Authentication & Permission Issues

Invalid API Key

❌ Error: Invalid or expired API key

Get a New API Key
# Login and get new key
$ instatunnel login
# Or visit dashboard
$ open https://dashboard.instatunnel.my/api-keys
Set API Key Correctly
# Environment variable
$ export INSTATUNNEL_API_KEY="it_1234567890abcdef"
# Or config file
$ instatunnel config set api_key it_1234567890abcdef

Subdomain Already Reserved

❌ Error: Subdomain 'myapp' is reserved by another user

Try Alternative Names
$ instatunnel 3000 --subdomain myapp-dev
$ instatunnel 3000 --subdomain myapp-2024
$ instatunnel 3000 --subdomain mycompany-myapp
Use Auto-Suffix
$ instatunnel 3000 --subdomain myapp --auto-suffix
βœ… Tunnel created: https://myapp-2.instatunnel.my

🌐 Browser & HTTPS Issues

Mixed Content Warnings

Ensure Local App Uses HTTPS
# For development servers that support HTTPS
$ npm start -- --https # React
$ ng serve --ssl # Angular
Force HTTPS Forwarding
$ instatunnel 3000 --force-https

CORS Issues

Configure Your App for Tunneling
// Express.js example
app.use(cors({
Β Β origin: [
Β Β Β Β 'http://localhost:3000',
Β Β Β Β 'https://*.instatunnel.my'
Β Β ]
}))
Use Tunnel Headers
# Add custom headers for CORS
$ instatunnel 3000 --header "X-Tunnel-Origin: true"

πŸ›  Advanced Troubleshooting

Debug Mode

# Enable verbose debugging
$ instatunnel 3000 --log-level debug --verbose
πŸ” WebSocket connection established
πŸ” Tunnel registered: abc123.instatunnel.my
πŸ” Health check: OK
πŸ” Request: GET / from 203.0.113.1
πŸ” Response: 200 (45ms)

Generate Support Bundle

# Create diagnostic bundle
$ instatunnel support-bundle
βœ… Support bundle created: instatunnel-debug-20240702.zip
πŸ“Š Included:
- Configuration files
- Recent logs
- Network connectivity tests
- System information

Health Checks

# Run comprehensive health check
$ instatunnel doctor
πŸ” Running InstaTunnel diagnostics...
βœ… Internet connectivity: OK
βœ… DNS resolution: OK
βœ… API server reachable: OK
βœ… Authentication: OK
⚠️ Local app on port 3000: Not responding
βœ… WebSocket support: OK

πŸ“ž Getting Help

Community Support

  • β€’ Discord: Real-time chat with community
  • β€’ GitHub Issues: Report bugs and feature requests
  • β€’ Stack Overflow: Tag questions with 'instatunnel'
  • β€’ Reddit: r/instatunnel community

Premium Support

  • β€’ Email Support: support@instatunnel.my
  • β€’ Priority Queue: Pro/Business users
  • β€’ Live Chat: Available in dashboard
  • β€’ Video Calls: Business tier scheduled support

πŸš€ Quick Fix: 90% of issues are resolved by running instatunnel doctor and following the suggested fixes. Always try this first!

Need a quick path?

See plans, then jump into a guided start whenever you are ready.

For MCP endpoints on Pro/Business, use: instatunnel 8787 --mcp.

InstaTunnel Docs | CLI, Webhook Testing, MCP & Troubleshooting