What problem it solves

Local services running behind a NAT or firewall cannot be reached directly from the public Internet. frp provides a reverse-proxy path that forwards public traffic to internal services over supported network protocols.

Key features

• Multiple protocol support — Expose internal services through TCP, UDP, HTTP, and HTTPS proxies, including domain-based routing for web requests.

  Source: README

• P2P connection mode — Use the xtcp mode to transmit data directly between clients while retaining a frps server for coordination.

  Source: README

• Flexible configuration — Configure server and client instances with TOML, YAML, or JSON. Environment variables, included proxy files, and hot-reloading support help adapt configurations to different environments.

  Source: README, conf

• Server and client management interfaces — A server dashboard reports status and proxy statistics, while the client admin UI provides configuration and proxy management controls.

  Source: README

• Dynamic proxy management — Create, update, and delete proxies and visitors at runtime through the Web UI or API without restarting frpc. Store-backed entries are persisted and restored after restart.

  Source: README

Quick start

Copied verbatim from the project's README.

# frpc.toml
serverAddr = "{{ .Envs.FRP_SERVER_ADDR }}"
serverPort = 7000

[[proxies]]
name = "ssh"
type = "tcp"
localIP = "127.0.0.1"
localPort = 22
remotePort = {{ .Envs.FRP_SSH_REMOTE_PORT }}

export FRP_SERVER_ADDR=x.x.x.x
export FRP_SSH_REMOTE_PORT=6000
./frpc -c ./frpc.toml

Who it may suit

Inference: may suit operators and developers who need to expose services from a private LAN, provide remote access to internal applications, or manage reverse-proxy configurations.

Topics to discuss

• Which proxy type and deployment pattern would you choose for your internal services?

• How should authentication, encryption, and private access modes be configured for your environment?

• What configuration or monitoring workflows should receive priority in future releases?

Written by ReadmeX AI from the project's README, source and public GitHub data; it may contain mistakes.

Read the original README https://github.com/fatedier/frp#readme

ReadmeX opened this community for a trending project; it is not run by the project. Maintainers can claim it from the community page.