docs: update README with kanhole branding and contributors
golangci-lint / lint (push) Failing after 4s
golangci-lint / lint (push) Failing after 4s
- Rebrand from frp to kanhole (fork of frp) - Add 'What's New in kanhole' section highlighting: * Modern GUI client with setup wizard and dashboard * Windows MSI installer (WiX v7) * Enhanced client features (server config, token auth, admin DB) - Add Contributors section acknowledging: * opencode - GUI redesign, WiX v7 installer, Windows service integration * fatedier - Original frp project creator * frp contributors - The frp community
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# frp
|
# kanhole
|
||||||
|
|
||||||
[](https://circleci.com/gh/fatedier/frp)
|
[](https://circleci.com/gh/fatedier/frp)
|
||||||
[](https://github.com/fatedier/frp/releases)
|
[](https://github.com/fatedier/frp/releases)
|
||||||
@@ -7,6 +7,8 @@
|
|||||||
|
|
||||||
[README](README.md) | [中文文档](README_zh.md)
|
[README](README.md) | [中文文档](README_zh.md)
|
||||||
|
|
||||||
|
**kanhole** is a fork of [frp](https://github.com/fatedier/frp) with enhanced features including a modern GUI client and Windows installer.
|
||||||
|
|
||||||
## Sponsors
|
## Sponsors
|
||||||
|
|
||||||
frp is an open source project with its ongoing development made possible entirely by the support of our awesome sponsors. If you'd like to join them, please consider [sponsoring frp's development](https://github.com/sponsors/fatedier).
|
frp is an open source project with its ongoing development made possible entirely by the support of our awesome sponsors. If you'd like to join them, please consider [sponsoring frp's development](https://github.com/sponsors/fatedier).
|
||||||
@@ -42,11 +44,46 @@ an API that records Zoom, Google Meet, Microsoft Teams, in-person meetings, and
|
|||||||
</div>
|
</div>
|
||||||
<!--gold sponsors end-->
|
<!--gold sponsors end-->
|
||||||
|
|
||||||
## What is frp?
|
## What is kanhole?
|
||||||
|
|
||||||
frp is a fast reverse proxy that allows you to expose a local server located behind a NAT or firewall to the Internet. It currently supports **TCP** and **UDP**, as well as **HTTP** and **HTTPS** protocols, enabling requests to be forwarded to internal services via domain name.
|
kanhole is a fast reverse proxy that allows you to expose a local server located behind a NAT or firewall to the Internet. It currently supports **TCP** and **UDP**, as well as **HTTP** and **HTTPS** protocols, enabling requests to be forwarded to internal services via domain name.
|
||||||
|
|
||||||
frp also offers a P2P connect mode.
|
kanhole also offers a P2P connect mode.
|
||||||
|
|
||||||
|
## What's New in kanhole?
|
||||||
|
|
||||||
|
kanhole builds upon frp with the following enhancements:
|
||||||
|
|
||||||
|
### Modern GUI Client
|
||||||
|
|
||||||
|
kanhole includes a beautiful, modern GUI client built with the Fyne framework:
|
||||||
|
|
||||||
|
- **Setup Wizard**: 4-step guided configuration (Welcome → Server → Auth → Finish)
|
||||||
|
- **Dashboard**: Real-time proxy monitoring, logs, and configuration viewer
|
||||||
|
- **Windows Service Management**: Install, start, stop, and uninstall as a Windows service
|
||||||
|
- **System Tray Integration**: Quick access to controls from the system tray
|
||||||
|
- **Dark Theme**: Modern indigo/pink accent colors with smooth animations
|
||||||
|
|
||||||
|
The GUI client is available as a separate Windows executable with no console window.
|
||||||
|
|
||||||
|
### Windows MSI Installer
|
||||||
|
|
||||||
|
kanhole provides a professional Windows installer built with WiX Toolset v7:
|
||||||
|
|
||||||
|
- **Feature Tree UI**: Choose which components to install
|
||||||
|
- **Windows Service**: Optional auto-start service installation
|
||||||
|
- **Desktop Shortcuts**: Optional desktop and Start Menu shortcuts
|
||||||
|
- **PATH Integration**: Optional system PATH environment variable update
|
||||||
|
- **Silent Install**: Support for unattended installation
|
||||||
|
|
||||||
|
Download the MSI installer from the [releases page](https://github.com/kanhole/kanhole/releases).
|
||||||
|
|
||||||
|
### Enhanced Client Features
|
||||||
|
|
||||||
|
- **Server-based Configuration**: Fetch and auto-reload configuration from kanhole server
|
||||||
|
- **One-time Token Authentication**: Secure client provisioning with temporary tokens
|
||||||
|
- **Admin DB**: SQLite-based configuration storage with web admin interface
|
||||||
|
- **Multi-client Support**: Run multiple clients from a single configuration directory
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@@ -1349,6 +1386,16 @@ Features typically go through three stages:
|
|||||||
* [gofrp/plugin](https://github.com/gofrp/plugin) - A repository for frp plugins that contains a variety of plugins implemented based on the frp extension mechanism, meeting the customization needs of different scenarios.
|
* [gofrp/plugin](https://github.com/gofrp/plugin) - A repository for frp plugins that contains a variety of plugins implemented based on the frp extension mechanism, meeting the customization needs of different scenarios.
|
||||||
* [gofrp/tiny-frpc](https://github.com/gofrp/tiny-frpc) - A lightweight version of the frp client (around 3.5MB at minimum) implemented using the ssh protocol, supporting some of the most commonly used features, suitable for devices with limited resources.
|
* [gofrp/tiny-frpc](https://github.com/gofrp/tiny-frpc) - A lightweight version of the frp client (around 3.5MB at minimum) implemented using the ssh protocol, supporting some of the most commonly used features, suitable for devices with limited resources.
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
kanhole is made possible by the following contributors:
|
||||||
|
|
||||||
|
- **[opencode](https://github.com/opencode)** - GUI client redesign, WiX v7 installer, Windows service integration, and modern UI/UX
|
||||||
|
- **[fatedier](https://github.com/fatedier)** - Original frp project creator and maintainer
|
||||||
|
- **[frp contributors](https://github.com/fatedier/frp/graphs/contributors)** - The amazing frp community
|
||||||
|
|
||||||
|
Special thanks to the frp project and its contributors for creating the foundation that kanhole builds upon.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Interested in getting involved? We would like to help you!
|
Interested in getting involved? We would like to help you!
|
||||||
|
|||||||
Reference in New Issue
Block a user