Using KFtray GUI

Learn how to effectively use KFtray's graphical interface for managing your Kubernetes port forwards.

Main Interface

System Tray Menu

• Right-click tray icon for quick actions
• Left-click to open main window
• Status indicators show active forwards

Main Window

• List of configurations
• Status toggles
• Search and filter options
• Configuration management

Managing Configurations

Adding New Configuration

1. Click "+" button or use Ctrl/Cmd + N
2. Fill required fields:

   {
     "service": "my-service",
     "namespace": "default",
     "local_port": 8080,
     "remote_port": 80,
     "protocol": "tcp",
     "alias": "web"
   }
   

   Copy to clipboard
3. Click Save

Editing Configurations

1. Click edit icon next to configuration
2. Modify settings
3. Save changes

Deleting Configurations

• Click delete icon
• Confirm deletion
• Or select multiple and use bulk delete

Port Forwarding

Starting Forwards

• Toggle individual switches
• Use "Start All" button
• Right-click tray icon shortcuts

Stopping Forwards

• Toggle switches off
• Use "Stop All" button
• Right-click tray menu options

Monitoring Status

• Green: Active
• Red: Stopped
• Yellow: Connecting
• Error icon: Issues

Advanced Features

HTTP Traffic Logging

1. Enable port forward
2. Click configuration menu
3. Enable HTTP logging
4. Access logs via icon

GitHub Sync

1. Open settings
2. Configure GitHub repository
3. Set sync interval
4. Enable auto-sync

Auto Import

1. Click menu icon
2. Select "Auto Import"
3. Choose context
4. Import configurations

Settings

General

• Auto-start application
• Minimize to tray
• Update checking
• Theme selection

Kubernetes

• Default context
• Kubeconfig path
• Namespace filters
• Connection timeout

GitHub

• Repository URL
• Access token
• Sync interval
• Auto-sync toggle

Troubleshooting

Common Issues

1. Connection Failed
   • Check cluster access
   • Verify service exists
   • Review permissions
2. Port Conflicts
   • Check port availability
   • Stop conflicting services
   • Change local port
3. Sync Issues
   • Verify GitHub token
   • Check repository access
   • Review network connection

Best Practices

• Use meaningful aliases
• Group related forwards
• Regular configuration backups
• Monitor resource usage
• Keep logs cleaned up

Tips and Tricks

1. Quick Access
   • Pin frequent forwards
   • Use keyboard shortcuts
   • Organize by namespace
2. Performance
   • Limit active forwards
   • Regular cache clearing
   • Monitor system resources
3. Team Collaboration
   • Share configurations
   • Document port usage
   • Maintain naming conventions