InstaTunnel docs wa doko kara hajimeru no ga yoi desu ka?

Kono junban ga suisho desu: CLI install -> auth -> first tunnel, sono ato use case ni awasete MCP/webhooks/referrals. Nichijou unyou wa CLI Flags to Troubleshooting o tsukatte kudasai.

Last reviewed: March 5, 2026

Compatibility: Core docs wa CLI v1 default to streaming client no tame no MCP --transport v2 ni taiou shiteimasu.

Quick command

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

Common failures and quick fixes

Auth not persisted-instatunnel auth set-key it_your_api_key de key o local ni hozon shite kudasai.
Webhook 401 signature errors-Production test mae ni /docs/webhooks no provider betsu secret verification guide o shiyou shite kudasai.

Evidence and trust

Compatibility, reliability, security posture no kakunin ni tsukatte kudasai.

Release cadence

CLI to docs no release notes wa tsune ni update sare, version goto no compatibility note ga arimasu.

View release notes

Security controls

Security whitepaper de policy enforcement, auth layer, operational safeguards o kakunin dekimasu.

Open security whitepaper

Reliability runbooks

Troubleshooting guide ni common failure, recovery step, CLI baseline ga matomatteimasu.

Read troubleshooting guides

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.