Par ou commencer dans la documentation InstaTunnel ?

Ordre recommande : installer le CLI, s authentifier, lancer le premier tunnel, puis passer a MCP/webhooks/referrals selon votre cas. Utilisez CLI Flags et Troubleshooting au quotidien.

Derniere revision : March 5, 2026

Compatibilite : La documentation principale couvre CLI v1 par defaut et MCP --transport v2 pour les clients streaming.

Commande rapide

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

Erreurs courantes et corrections rapides

Auth non persistee-Executez instatunnel auth set-key it_your_api_key pour enregistrer votre cle localement.
Erreurs 401 de signature webhook-Utilisez les guides de verification de secret sur /docs/webhooks avant les tests de production.

Preuves et confiance

Utilisez ces references pour evaluer la compatibilite, la fiabilite et la securite.

Cadence des releases

Les release notes CLI et docs sont mises a jour en continu, avec des notes de compatibilite par version.

Voir les release notes

Controles de securite

Consultez le security whitepaper pour les politiques, l auth et les protections operationnelles.

Ouvrir le security whitepaper

Runbooks de fiabilite

Les guides de troubleshooting couvrent les pannes courantes, la recuperation et les baselines CLI.

Lire les guides de troubleshooting

Configuration

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):

Command-line flags - --api-key your_key
Environment variables - API_KEY=your_key
Config file - ~/.instatunnel.yaml
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

Option	Flag	Env Variable	Description
`api_key`	`--api-key`	`API_KEY`	Your InstaTunnel API key
`server_url`	`--server`	`SERVER_URL`	InstaTunnel 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.