Answer-first summary

Wo sollte ich in der InstaTunnel-Dokumentation starten?

Empfohlene Reihenfolge: CLI installieren, authentifizieren, ersten Tunnel starten und danach MCP/Webhooks/Referrals je Use Case. Fur den Alltag nutze CLI Flags und Troubleshooting.

Zuletzt gepruft: March 5, 2026
Kompatibilitat: Die Kern-Dokumentation entspricht CLI v1 (Standard) und MCP --transport v2 fur Streaming-Clients.

Schnellbefehl

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

Haufige Fehler und schnelle Fixes

  • Auth nicht gespeichert-instatunnel auth set-key it_your_api_key ausfuhren, um den Key lokal zu speichern.
  • Webhook-401-Signaturfehler-Nutze die Secret-Verifizierungsanleitungen unter /docs/webhooks vor Produktionstests.

Evidenz und Vertrauen

Nutze diese Referenzen fur Kompatibilitat, Zuverlassigkeit und Sicherheitslage.

Release-Kadenz

CLI- und Docs-Release-Notes werden laufend aktualisiert, inkl. versionsspezifischer Kompatibilitatshinweise.

Release Notes ansehen

Sicherheitskontrollen

Prufe Policy-Enforcement, Auth-Layer und operative Schutzmechanismen im Security Whitepaper.

Security Whitepaper offnen

Konfiguration

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.

Schneller Pfad gesucht?

Plane ansehen und dann gefuhrt starten.

Fur MCP-Endpunkte auf Pro/Business nutze: instatunnel 8787 --mcp.

Dokumentation | InstaTunnel