Answer-first summary

Donde debo empezar en la documentacion de InstaTunnel?

Sigue este orden: instalar CLI, autenticar, ejecutar primer tunel y luego MCP/webhooks/referrals segun tu caso. Usa CLI Flags y Troubleshooting para operacion diaria.

Ultima revision: March 5, 2026
Compatibilidad: La documentacion base se alinea con CLI v1 por defecto y MCP --transport v2 para clientes streaming.

Comando rapido

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

Errores comunes y solucion rapida

  • Auth no persistida-Ejecuta instatunnel auth set-key it_your_api_key para guardar tu key local.
  • Errores 401 de firma webhook-Usa las guias de verificacion de secreto en /docs/webhooks antes de pruebas en produccion.

Evidencia y confianza

Usa estas referencias para evaluar compatibilidad, confiabilidad y seguridad.

Cadencia de releases

Las notas de release de CLI y docs se actualizan continuamente, con notas de compatibilidad por version.

Ver release notes

Controles de seguridad

Revisa enforcement de politicas, capas de auth y salvaguardas operativas en el security whitepaper.

Abrir security whitepaper

Runbooks de confiabilidad

Las guias de troubleshooting cubren fallos comunes, recuperacion y compatibilidad base de CLI.

Leer troubleshooting guides

Configuracion

Configure InstaTunnel with config files and environment variables for persistent settings.

📁 Configuration Files

Global Configuration

Create a global config file at ~/.instatunnel.yaml:

# ~/.instatunnel.yaml
api_key: "your_api_key_here"
server_url: "https://api.instatunnel.my"

💡 Tip: Config file is automatically loaded if present in your home directory.

Custom Config File

Use a custom config file location with the --config flag:

# Use custom config file
$ instatunnel --config /path/to/config.yaml 3000
Using config file: /path/to/config.yaml
✅ Tunnel created: https://abc123.instatunnel.my

🌍 Environment Variables

Available Environment Variables

InstaTunnel automatically reads environment variables that match config keys:

# Set your API key
$ export API_KEY="your_api_key_here"
# Set custom server URL
$ export SERVER_URL="https://api.instatunnel.my"
# Now these are used automatically
$ instatunnel 3000

🔒 Security: Never commit API keys to version control. Use environment variables for sensitive data.

⚙️ Configuration Priority

InstaTunnel follows this configuration priority (highest priority first):

  1. Command-line flags - --api-key your_key
  2. Environment variables - API_KEY=your_key
  3. Config file - ~/.instatunnel.yaml
  4. Built-in defaults - Fallback values
# Example: Command-line flag overrides everything
$ instatunnel --api-key override_key 3000
✅ Using API key from command line

🛠 Available Configuration Options

Current Options

OptionFlagEnv VariableDescription
api_key--api-keyAPI_KEYYour InstaTunnel API key
server_url--serverSERVER_URLInstaTunnel server URL

🎯 Best Practice: Store your API key in the config file (~/.instatunnel.yaml) or environment variable for convenience. Use command-line flags for temporary overrides.

Necesitas una ruta rapida?

Mira planes y luego sigue una guia cuando quieras.

Para endpoints MCP en Pro/Business, usa: instatunnel 8787 --mcp.

Documentacion | InstaTunnel