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)

1. Launch KFtray
   • Click the system tray icon
2. Add a Configuration
   • Click the "+" button
   • Fill in the required fields:
     • Service name
     • Namespace
     • Local and remote ports
     • Protocol (TCP/UDP)
   • Click "Save"
3. Start Port Forwarding
   • Toggle the switch next to your configuration
   • Or use "Start All" to enable multiple forwards

Using KFtui (Terminal)

1. Launch KFtui

   kftui
   

   Copy to clipboard
2. Import Configuration
   • Press i to import configuration
   • Select your JSON configuration file
   • Use Space to select configurations
   • Press f to start forwarding
3. Common Commands
   • Ctrl+C: Quit
   • ↑/↓: Navigate
   • Space: Select/deselect
   • f: Start/stop forwarding
   • h: Show help

Verifying 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