Quick Start Guide
This guide will help you get started with either KFtray or KFtui quickly.
Basic Configuration Format
Both interfaces use the same JSON configuration format:
{
"service": "my-service",
"namespace": "default",
"local_port": 8080,
"remote_port": 80,
"context": "my-cluster",
"workload_type": "service",
"protocol": "tcp",
"alias": "my-service",
"domain_enabled": false
}
Using KFtray (GUI)
- Launch KFtray
- Click the system tray icon
- Add a Configuration
- Click the "+" button
- Fill in the required fields:
- Service name
- Namespace
- Local and remote ports
- Protocol (TCP/UDP)
- Click "Save"
- Start Port Forwarding
- Toggle the switch next to your configuration
- Or use "Start All" to enable multiple forwards
Monitor the status of your port forwards directly from the Application in the Switch
Using KFtui (Terminal)
- Launch KFtui
kftui
- Import Configuration
- Press
i
to import configuration - Select your JSON configuration file
- Use
Space
to select configurations - Press
f
to start forwarding
- Press
- Common Commands
Ctrl+C
: Quitโ/โ
: NavigateSpace
: Select/deselectf
: Start/stop forwardingh
: Show help
Use
Ctrl+A
to select all configurations at onceVerifying Connections
Test your port forward by accessing the service locally:
curl http://localhost:<local_port>
Common Configuration Examples
Web Application
{
"service": "frontend",
"namespace": "web",
"local_port": 3000,
"remote_port": 80,
"protocol": "tcp",
"alias": "web-app"
}
Database
{
"service": "postgres",
"namespace": "database",
"local_port": 5432,
"remote_port": 5432,
"protocol": "tcp",
"alias": "db"
}
Next Steps
- Learn about GitHub Sync
- Set up HTTP Logging
- Configure Auto Import