Visit kftray.app »

KFtray and KFtui are independent, cross-platform applications. They help you set up and manage multiple port-forwarding settings easily. Both apps are part of the same open-source project and aim to make working with Kubernetes easier. KFtray has a desktop interface, while KFtui has a terminal interface, so you can choose the one that suits you best.

❓ Why

KFtray and KFtui were made to fix common problems with Kubernetes port forwarding. The usual kubectl port-forward command can be unreliable. For example, if a pod dies, it needs manual reconnection. It also has trouble setting up many port forwards at once and doesn't support UDP services.

KFtray and KFtui solve these issues by being more reliable and easier to use. They automatically reconnect to running pods if one fails, allow setting up multiple port forwards with one click, and support both TCP and UDP protocols. KFtray also has extra features like HTTP logs tracing and GitHub sync to make workflows smoother.

📑 Table of Contents

• ✨ Features
• 🗂 Features Matrix
• 🛠 Installation
• 📚 Usage
• 🛠️ Build from source
• 🏗 Architecture
• 👥 Contributing
• 📄 License

✨ Features

• Resilient Port Forwarding Connection: Ensures continuous service even if a pod dies by reconnecting to another running pod automatically.
• One-Click Multiple Port Forwards: Allows for the setup of several port forwarding instances simultaneously with a single click.
• Independent of Kubectl: Directly interfaces with the Kubernetes API, eliminating the need for kubectl.
• Multi-Protocol Support: Enables access to internal or external servers through a Proxy Relay server deployed in a Kubernetes cluster, including TCP and UDP port forwarding.
• HTTP Logs Tracing: Enable or disable HTTP logs for specific configurations to save the requests and responses in a local log file. (Currently available only in the KFtray desktop app) - Blog Post
• GitHub Sync: Keep your configurations saved on GitHub and share or synchronize them in a GitOps style. (Currently available only in the KFtray desktop app)
• Auto Import: Automatically import Kubernetes service configurations based on specific annotations.

🗂 Features Matrix

Feature	KFtray (Desktop App)	KFtui (Terminal UI)
Resilient Port Forwarding Connection	✔️	✔️
One-Click Multiple Port Forwards	✔️	✔️
Independent of Kubectl	✔️	✔️
Multi-Protocol Support (TCP/UDP)	✔️	✔️
HTTP Logs Tracing	✔️	❌ (Coming Soon)
GitHub Sync	✔️	❌ (Coming Soon)
Local JSON File Configuration	✔️	✔️
Auto Import with k8s Annotations	✔️	✔️

🛠 Installation

• KFtray Desktop App: Check INSTALL.md.
• KFtui: Check INSTALL.md.

📚 Usage

• KFtray Desktop App: Check USAGE.md.
• KFtui: Check USAGE.md.

🛠️ Build from source

• KFtray Desktop App: Check BUILD.md.
• KFtui: Check BUILD.md.

🏗 Architecture

For an overall architectural review, check ARCH.md.

👥 Contributing

• Pull Requests: Feel free to create pull requests for bug fixes, new features, or improvements.
• Issues: Report bugs, suggest new features, or ask questions.
• Feedback: Your feedback helps improve kftray.

📄 License

KFtray is available under the MIT License. See the LICENSE file for full details.

Star History

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Henrique Cavarsan 💻

Filipe Andujar 💻

Ikko Eltociear Ashimine 💻

This project follows the all-contributors specification. Contributions of any kind welcome!