Repo brief: fatedier/frp

Generated by RepoPilot · document generated 2026-09-16 · concise human review Evidence snapshot · analyzed 2026-09-16T08:42:33.379Z · commit 832df8dff66d

Verdict

Healthy — Healthy across all four use cases

• Last commit 1d ago
• 11 active contributors
• Apache-2.0 licensed
• CI configured
• 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

What it is

frp is a fast reverse proxy written in Go that exposes local servers behind NAT/firewall to the internet over TCP, UDP, HTTP, and HTTPS protocols, with P2P connection modes and domain-based request forwarding. It solves the core problem of accessing internal services from outside a restricted network without modifying firewall rules. Monorepo structure with /pkg/auth/ handling auth schemes (legacy, OIDC, token-based), /pkg/config/ managing configuration loading from multiple sources with schema validation in /pkg/config/v1/, and legacy conversion logic in /pkg/config/legacy/. The layout suggests client/server separation with shared config abstractions.

Start here

Open these first:

• pkg/config/v1/decode.go — Core configuration decoder that transforms raw config into runtime structures; all config flows through here.
• pkg/msg/wire_v2.go — Wire protocol implementation for frp message marshaling/unmarshaling; defines client-server communication format.
• pkg/config/v1/validation/validation.go — Central validation dispatcher ensuring all config objects are sanitized before runtime use.
• pkg/auth/auth.go — Authentication provider abstraction supporting OIDC, token, and legacy modes; entry point for credential verification.
• pkg/config/load.go — Configuration loading orchestrator that assembles sources and applies transformations for both client and server.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

Clone the repository and verify the Go environment matches the go.mod requirement (Go 1.25.0+). Since a Makefile is present in the language breakdown, check it for build targets: `git clone https://github.com/fatedier/f…

Daily commands:

Exact commands depend on Makefile contents (not fully shown), but likely: make build for binary compilation, or go run ./cmd/frp... for direct execution. The presence of cmd/ directory (inferred from typical Go la…

…shortened for this brief.

Key cautions & unknowns

• Single-maintainer risk — top contributor 88% of recent commits
• The /pkg/config/legacy/ package exists alongside v1; migrations are required and may have incompatibilities. OIDC auth requires proper OAuth2 provider setup (golang.org/x/oauth2) not visible in file structure. The…
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests
• OpenSSF Scorecard

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.