frp

README | 中文文档

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.

Gold Sponsors

Swiftproxy - Premium Global Residential Proxy Network
_{Reliable residential IPs across 220+ locations, helping frp users test remote access, verify connectivity, and access region-specific network resources worldwide.
Free testing available, with 10% off using code PROXY90.}

The complete IDE crafted for professional Go developers

The sovereign cloud that puts you in control
_{An open source, self-hosted alternative to public clouds, built for data ownership and privacy}

What is frp?

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.

frp also offers a P2P connect mode.

Table of Contents

• Development Status
  • About V2
• Architecture
• Example Usage
  • Access your computer in a LAN network via SSH
  • Multiple SSH services sharing the same port
  • Accessing Internal Web Services with Custom Domains in LAN
  • Forward DNS query requests
  • Forward Unix Domain Socket
  • Expose a simple HTTP file server
  • Enable HTTPS for a local HTTP(S) service
  • Expose your service privately
  • P2P Mode
• Features
  • Configuration Files
  • Using Environment Variables
  • Split Configures Into Different Files
  • Server Dashboard
  • Client Admin UI
    • Dynamic Proxy Management (Store)
  • Monitor
    • Prometheus
  • Authenticating the Client
    • Token Authentication
    • OIDC Authentication
  • Encryption and Compression
    • TLS
  • Hot-Reloading frpc configuration
  • Get proxy status from client
  • Only allowing certain ports on the server
  • Port Reuse
  • Bandwidth Limit
    • For Each Proxy
  • TCP Stream Multiplexing
  • Support KCP Protocol
  • Support QUIC Protocol
  • Connection Pooling
  • Load balancing
  • Service Health Check
  • Rewriting the HTTP Host Header
  • Setting other HTTP Headers
  • Get Real IP
    • HTTP X-Forwarded-For
    • Proxy Protocol
  • Require HTTP Basic Auth (Password) for Web Services
  • Custom Subdomain Names
  • URL Routing
  • TCP Port Multiplexing
  • Connecting to frps via PROXY
  • Port range mapping
  • Client Plugins
  • Server Manage Plugins
  • SSH Tunnel Gateway
  • Virtual Network (VirtualNet)
• Feature Gates
  • Available Feature Gates
  • Enabling Feature Gates
  • Feature Lifecycle
• Related Projects
• Contributing
• Donation
  • GitHub Sponsors
  • PayPal

Development Status

frp is currently under development. You can try the latest release version in the master branch, or use the dev branch to access the version currently in development.

We are currently working on version 2 and attempting to perform some code refactoring and improvements. However, please note that it will not be compatible with version 1.

We will transition from version 0 to version 1 at the appropriate time and will only accept bug fixes and improvements, rather than big feature requests.

About V2

The complexity and difficulty of the v2 version are much higher than anticipated. I can only work on its development during fragmented time periods, and the constant interruptions disrupt productivity significantly. Given this situation, we will continue to optimize and iterate on the current version until we have more free time to proceed with the major version overhaul.