Troubleshooting¶
Solutions for common StormTunnel issues.
Connection Issues¶
Tunnel Won't Connect¶
| Check | Solution |
|---|---|
| Hostname/IP correct? | Verify server address in tunnel settings |
| SSH port correct? | Usually 22, check with admin |
| Network connected? | Test internet connection |
| VPN required? | Connect to VPN first |
| Server accessible? | Ask admin to verify server is online |
Connection Timeout¶
- Increase timeout: Settings → General → Connection Timeout
- Check network: Try wired instead of WiFi
- Check firewall: Verify SSH port isn't blocked
Connection Drops¶
- Enable auto-reconnect: Edit tunnel → Advanced → Auto-Reconnect
- Check network stability: WiFi interference, cable issues
- Prevent Mac sleep: Adjust Energy Saver settings
Authentication Problems¶
"Permission denied (publickey)"¶
Your SSH key isn't authorized on the server.
Solutions:
- Verify correct key is selected in tunnel settings
- Ask admin to add your public key to server's
~/.ssh/authorized_keys - Test manually:
ssh -i /path/to/key user@host - Try CLI fallback: Edit tunnel → Advanced → Use CLI Fallback
"Authentication failed" (Password)¶
- Verify password is correct (check Caps Lock)
- Re-enter password in tunnel settings
- Ask admin if password changed
- Try CLI fallback mode
Two-Factor Authentication¶
StormTunnel's native SSH doesn't support interactive 2FA prompts.
Solution: Enable CLI Fallback mode:
- Edit tunnel → Advanced → Use CLI Fallback
- Connect - you'll see 2FA prompt
- Enter your code when prompted
Port Issues¶
"Port already in use"¶
Another application is using that local port.
Solutions:
- Choose different local port (e.g., 5433 instead of 5432)
- Find what's using the port: Activity Monitor or
lsof -i :PORT - Close the conflicting application
"Port forwarding failed"¶
- Verify remote host and port are correct
- Check if service is running on remote server
- Ask admin to verify firewall allows the connection
AWS Session Manager Issues¶
"Session Manager plugin not found"¶
AWS CLI plugin isn't installed or not in PATH.
Solutions:
- Install plugin:
brew install --cask session-manager-plugin - Verify in Settings → AWS → Plugin Status
- If custom location, set path in Settings → Advanced
"Access Denied" or IAM errors¶
- Check AWS profile is configured: Settings → AWS
- Verify IAM permissions with your AWS admin
- Test AWS CLI:
aws sts get-caller-identity
Required IAM Permissions¶
Your AWS admin needs to grant:
ssm:StartSessionssm:TerminateSessionec2:DescribeInstances(for instance list)
See AWS IAM Policies for full policy examples.
UI Issues¶
Application Won't Launch¶
- Check macOS version: Requires macOS 15.0+
- Check security: System Settings → Privacy → Allow StormTunnel
- Reset app: Delete
~/Library/Containers/in.rs.olujic.StormTunnel/and relaunch
Interface Frozen¶
- Force quit: Cmd+Option+Esc → Select StormTunnel → Force Quit
- Restart: Reopen from Applications
- Check resources: Close other apps if memory is low
Menu Bar Icon Missing¶
- Enable: Settings → General → Show in Menu Bar
- Check menu bar space (remove other icons if full)
- Restart StormTunnel
Performance Issues¶
Slow Connections¶
- Use IP address instead of hostname (avoids DNS lookup)
- Increase connection timeout
- Check network latency
High CPU/Memory¶
- Disconnect unused tunnels
- Restart StormTunnel periodically
- Check Activity Monitor for other resource-heavy apps
Connection History Issues¶
History Not Showing¶
- Check privacy settings: Settings → Privacy → Connection History
- Verify tunnel is tracked: Some tunnels can be excluded
- Check license: Free tier limited to last 5 entries
- Restart StormTunnel: Sometimes history needs refresh
Missing Events¶
If connection events aren't being recorded:
| Check | Solution |
|---|---|
| History tracking enabled? | Settings → Privacy → Enable Connection History |
| Tunnel excluded? | Check tunnel exclusion list in settings |
| Privacy mode active? | Host anonymization may affect display |
| App crashed during connection? | Events may be lost on crash |
Statistics Incorrect¶
If numbers don't match expected values:
- Verify date range: Check if you're looking at the right time period
- Check for orphaned events: Restart app to trigger cleanup
- Filter settings: Make sure filters aren't hiding events
- Refresh view: Use Cmd+R to reload statistics
Performance with Large History¶
If StormTunnel is slow with many events:
- Reduce retention: Settings → Privacy → History Retention Days
- Limit per tunnel: Settings → Privacy → Max Events Per Tunnel
- Clear old history: Delete events you don't need
- Exclude frequently-changing tunnels: Don't track test tunnels
Privacy & Performance
Host anonymization can improve performance by reducing search overhead on long hostnames.
Search & Filtering Issues¶
Search Not Finding Tunnels¶
If search isn't showing expected tunnels:
| Problem | Solution |
|---|---|
| Typo in search | Check spelling and try partial match |
| Wrong field searched | Search looks at multiple fields - try different keywords |
| Case sensitivity | Search is case-insensitive - shouldn't matter |
| Tunnel recently deleted | Tunnel may have been removed |
| Search stuck | Clear search (Esc) and re-enter |
Search Fields Not Working¶
If specific fields aren't being searched:
- Verify tunnel type: AWS vs SSH have different fields
- Check for null values: Empty fields won't match
- Try different keywords: Search ports, names, hosts
- Restart StormTunnel: Sometimes search index needs refresh
Search Performance¶
If search is slow or laggy:
- Reduce tunnel count: Archive old tunnels you don't use
- Check system resources: Close other apps if memory is low
- Restart StormTunnel: Clears cached search data
- Report issue: If consistently slow, contact support
Clearing Filters¶
If you can't see all tunnels after searching:
- Press Esc - Clears search immediately
- Delete all text from search field
- Click outside field - Sometimes focus issues
- Restart app - If search field is stuck
Retry & Reliability Issues¶
Retry Not Working¶
If auto-retry isn't triggering:
| Check | Solution |
|---|---|
| Premium license active? | Retry is a Premium feature only |
| Retry enabled on tunnel? | Edit tunnel → Advanced → Enable Auto-Retry |
| Connection errors? | Retry only triggers on connection failures |
| Retry count > 0? | Check max retry attempts setting |
Too Many Retry Attempts¶
If tunnels retry excessively:
- Lower retry count: Edit tunnel → Advanced → Max Retry Attempts
- Fix root cause: Network issue, wrong credentials, server down
- Check logs: Connection History shows retry attempts
- Disable retry temporarily: While debugging connection issues
Retry Exhausted Errors¶
If you see "max retry attempts exceeded":
| Possible Cause | Solution |
|---|---|
| Server down | Wait for server to come online |
| Wrong credentials | Verify SSH key or password is correct |
| Network issue | Check VPN, WiFi, or internet connection |
| Firewall blocking | Verify SSH port isn't blocked |
| Too high retry limit | Increase max retry attempts if appropriate |
Log Analysis
Check Connection History for error patterns - repeated errors indicate configuration issues.
When to Disable Retry¶
Consider disabling auto-retry if:
| Situation | Reason |
|---|---|
| Testing new configurations | Immediate feedback is better than retrying |
| Frequently changing credentials | Retries waste time with wrong credentials |
| Known server maintenance | Wait until maintenance is complete |
| Debugging connection issues | Want to see each error individually |
Retry with Different Auth Methods¶
If retries fail due to authentication:
- Try CLI fallback: Edit tunnel → Advanced → Use CLI Fallback
- Check SSH key: Verify key is in Settings → Keys
- Test password auth: Temporarily switch to password method
- Update credentials: Refresh password or key if expired
Credential Caching
Passwords aren't cached across app restarts. Retries may fail if password was deleted from Keychain.
Quick Fixes¶
Reset StormTunnel¶
This deletes all settings and tunnels
- Quit StormTunnel
- Delete:
~/Library/Containers/in.rs.olujic.StormTunnel/ - Relaunch and reconfigure
Clear Known Hosts¶
If "Host key verification failed":
- Quit StormTunnel
- Delete:
~/Library/Application Support/StormTunnel/SSH/known_hosts - Relaunch and reconnect (verify new host key)
Force Quit¶
If StormTunnel is frozen:
- Press Cmd+Option+Esc
- Select "StormTunnel"
- Click "Force Quit"
- Relaunch from Applications
Error Reference¶
| Error | Cause | Solution |
|---|---|---|
| "Permission denied (publickey)" | SSH key not authorized | Check key, ask admin |
| "Connection timed out" | Network/server issue | Check network, increase timeout |
| "Port already in use" | Port conflict | Change local port |
| "Host key verification failed" | Server key changed | Clear known_hosts or verify with admin |
| "Authentication failed" | Wrong credentials | Check password/key |
Getting Help¶
Enable Debug Logging¶
For detailed troubleshooting:
- Settings → Advanced → Enable Debug Mode
- Enable Verbose SSH Output (for SSH issues)
- Reproduce the problem
- Check Console.app → Search "StormTunnel"
Report an Issue¶
Include:
- StormTunnel version (Settings → About)
- macOS version
- Steps to reproduce
- Error messages
- Debug logs if available
Contact: [email protected]
Related¶
- Creating Tunnels - Configuration options
- Authentication - SSH key setup
- AWS IAM Policies - AWS permissions