Support¶

Get help with StormTunnel through these channels.

Getting Started¶

New to StormTunnel? Start here:

• Quick Start Guide - Get up and running in 5 minutes
• Onboarding Guide - Step-by-step setup walkthrough
• Main Window Overview - Understand the interface
• Common Workflows - Learn typical usage patterns

Common Topics¶

SSH Tunnels¶

• Creating Tunnels - How to set up new SSH tunnels
• Managing Tunnels - Start, stop, and organize tunnels
• Authentication Methods - SSH keys, passwords, and 2FA

AWS Session Manager¶

• Session Manager Setup - Configure AWS SSM tunnels
• SSO Authentication - Use AWS SSO for authentication
• AWS Configuration - Server-side AWS setup

License & Billing¶

• License Management - Activate and manage your license
• Pricing - View plans and pricing
• Customer Portal - Manage billing and subscriptions

Troubleshooting¶

Common issues and solutions:

Connection Problems¶

Issue: Tunnel fails to connect Solutions:

• Check Connection Testing guide
• Verify SSH server is running and accessible
• Check Known Hosts Management for host key issues
• Review Troubleshooting guide

Issue: Authentication fails Solutions:

• Verify SSH key permissions (should be 600 or 400)
• Check SSH Key Management guide
• Ensure correct username for server
• Try Two-Factor Authentication if enabled

AWS Session Manager Issues¶

Issue: AWS SSM tunnel won't start Solutions:

• Verify Session Manager plugin is installed
• Check AWS Session Manager Updates
• Review IAM permissions in AWS IAM Policies
• Confirm SSO authentication status

Performance & Stability¶

Issue: App is slow or unresponsive Solutions:

• Check Performance Optimization guide
• Review connection history size
• Consider reducing number of active tunnels

Issue: Tunnels disconnect frequently Solutions:

• Enable Retry & Reconnect features
• Check network stability
• Review SSH server logs
• Adjust keep-alive settings in Advanced Settings

Getting Help¶

Email Support¶

• Email: [email protected]
• Response Time: Within 48 hours (24 hours for critical issues)
• What to Include:
  • StormTunnel version (found in About window)
  • macOS version
  • Description of the issue
  • Steps to reproduce
  • Relevant error messages

Report Issues¶

• GitHub Issues: Report bugs
• Feature Requests: Request features

Security Issues¶

For security vulnerabilities:

• Email: [email protected]
• Important: Report privately, do NOT create a public issue
• Include:
  • Steps to reproduce the vulnerability
  • Potential impact assessment
  • Your recommendations (if any)
• Response Time: Within 24 hours

We appreciate responsible disclosure of security vulnerabilities. Please give us time to fix issues before public disclosure.

Documentation Sections¶

For Users¶

• Guide - User guides and workflows
• Features - Detailed feature documentation
• Reference - Settings, shortcuts, and reference material

For Administrators¶

• Administrators - Server setup and configuration
• SSH Server Setup - Configure SSH servers
• AWS Configuration - AWS infrastructure setup
• Server Security - Security best practices
• Monitoring & Logging - Server monitoring

Keyboard Shortcuts¶

Quick reference for keyboard shortcuts:

• Cmd+N - New Tunnel
• Cmd+R - Refresh
• Cmd+, - Settings
• Cmd+K - Quick Search
• View all shortcuts

Additional Resources¶

Website¶

• Homepage - Product overview
• Features - Feature highlights
• Pricing - Plans and pricing
• FAQ - Frequently asked questions

Security & Privacy¶

• Security Practices - How we protect your data
• Privacy Policy - Our privacy commitments
• Terms of Service - Legal terms

Community¶

• GitHub Discussions - Community discussions
• Release Notes - Latest updates and changes

Still Need Help?¶

If you can't find what you're looking for:

1. Try our Troubleshooting Guide
2. Search the documentation
3. Check GitHub Issues
4. Contact us at [email protected]

We're here to help!