Quick Links

/docs/cli-flags/docs/troubleshooting/docs/webhooks/solutions/docs/referrals

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

Documentation

Installation

Multiple ways to install InstaTunnel. We recommend NPM for the best experience.

🥇 Recommended: NPM (Global Install)

# Install globally via NPM
$ npm install -g instatunnel
# Verify installation
$ instatunnel --version
InstaTunnel CLI 1.1.2
# Ready to use!
$ instatunnel 3000

✅ Why NPM? Automatic updates, works on all platforms, integrates with Node.js workflows, and provides the latest features.

Alternative Installation Methods

🍺Homebrew (macOS/Linux)

# Homebrew formula coming soon
# Currently not available
# Use NPM installation for now
$ npm install -g instatunnel

Homebrew formula is planned but not yet available. Use NPM installation instead.

🍫Chocolatey (Windows)

# Chocolatey package coming soon
# Currently not available
# Use NPM installation for now
$ npm install -g instatunnel

Chocolatey package is planned but not yet available. Use NPM installation instead.

📦Direct Binary Download

# Download for your platform
$ curl -L https://api.instatunnel.my/releases/instatunnel-linux-amd64 -o instatunnel
$ chmod +x instatunnel
$ ./instatunnel 3000

Download pre-built binaries for Linux, macOS, and Windows.

Linux (amd64)macOS (Intel)Windows (x64)

🐳Docker

# Docker images not yet available
# Use direct binary or NPM installation
# Download binary directly:
$ curl -L https://api.instatunnel.my/releases/instatunnel-linux-amd64 -o instatunnel
$ chmod +x instatunnel
$ ./instatunnel 3000

Docker images are planned but not yet available. Use direct binary download or NPM installation instead.

Verification & Next Steps

# Check if InstaTunnel is installed correctly
$ instatunnel --version
InstaTunnel CLI 1.1.2
# View available commands
$ instatunnel --help
# Test with your first tunnel
$ instatunnel 3000

🎯 Quick Start: Once installed, jump to the "Your First Tunnel" section to create your first tunnel in seconds!

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.

View PricingWebhook GuidesUse Cases HubGet Started Guide
InstaTunnel Docs | CLI, Webhook Testing, MCP & Troubleshooting