frp
A fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.
File Explorer
Download Latest Version (.zip)- config.yml
- bug_report.yaml
- config.yml
- feature_request.yaml
- build-and-push-image.yml
- golangci-lint.yml
- goreleaser.yml
- stale.yml
- FUNDING.yml
- pull_request_template.md
- assets.go
- types.go
- event.go
- health.go
- proxy_definition.go
- types.go
- visitor_definition.go
- controller.go
- controller_test.go
- general_tcp.go
- proxy.go
- proxy_manager.go
- proxy_test.go
- proxy_wrapper.go
- sudp.go
- udp.go
- xtcp.go
- xtcp_test.go
- stcp.go
- sudp.go
- visitor.go
- visitor_manager.go
- xtcp.go
- api_router.go
- config_manager.go
- config_manager_test.go
- connector.go
- control.go
- control_session.go
- control_session_test.go
- control_udp_test.go
- service.go
- service_shutdown_test.go
- service_test.go
- admin.go
- nathole.go
- proxy.go
- root.go
- verify.go
- verify_test.go
- main.go
- main.go
- root.go
- verify.go
- frpc_legacy_full.ini
- frps_legacy_full.ini
- frpc.toml
- frpc_full_example.toml
- frps.toml
- frps_full_example.toml
- release.md
- architecture.jpg
- dashboard.png
- sponsor_daytona.png
- sponsor_jetbrains.jpg
- sponsor_olares.jpeg
- deprecations.md
- server_plugin.md
- ssh_tunnel_gateway.md
- virtual_net.md
- Dockerfile-for-frpc
- Dockerfile-for-frps
- download.sh
- run-e2e-compatibility.sh
- run-e2e.sh
- legacy.go
- auth.go
- oidc.go
- oidc_test.go
- pass.go
- token.go
- client.go
- conversion.go
- parse.go
- proxy.go
- README.md
- server.go
- utils.go
- value.go
- visitor.go
- aggregator.go
- aggregator_test.go
- base_source.go
- base_source_test.go
- clone.go
- config_source.go
- config_source_test.go
- source.go
- store.go
- store_test.go
- validation.go
- types.go
- types_test.go
- auth.go
- auth_test.go
- client.go
- client_test.go
- common.go
- name.go
- name_test.go
- oidc.go
- oidc_test.go
- plugin.go
- proxy.go
- proxy_test.go
- server.go
- server_test.go
- validation.go
- validator.go
- visitor.go
- api.go
- client.go
- client_test.go
- clone_test.go
- common.go
- decode.go
- decode_test.go
- proxy.go
- proxy_plugin.go
- proxy_test.go
- server.go
- server_test.go
- store.go
- value_source.go
- value_source_test.go
- visitor.go
- visitor_plugin.go
- flags.go
- load.go
- load_test.go
- template.go
- errors.go
- server.go
- server.go
- server_test.go
- types.go
- server.go
- metrics.go
- conn_test.go
- ctl.go
- handler.go
- msg.go
- msg_test.go
- udp_benchmark_test.go
- udp_binary.go
- udp_binary_test.go
- wire_v2.go
- wire_v2_test.go
- names.go
- names_test.go
- analysis.go
- analysis_test.go
- classify.go
- controller.go
- discovery.go
- discovery_test.go
- nathole.go
- utils.go
- server.go
- http2http.go
- http2https.go
- http_common.go
- http_proxy.go
- http_proxy_test.go
- https2http.go
- https2https.go
- plugin.go
- socks5.go
- static_file.go
- tls2raw.go
- unix_domain_socket.go
- virtual_net.go
- http.go
- manager.go
- manager_test.go
- plugin.go
- tracer.go
- types.go
- plugin.go
- virtual_net.go
- feature_gate.go
- unsafe.go
- udp.go
- udp_test.go
- crypto.go
- wire.go
- wire_test.go
- client.go
- gateway.go
- server.go
- server_test.go
- terminal.go
- message.go
- tls.go
- context.go
- error.go
- handler.go
- http.go
- middleware.go
- server.go
- json_v1.go
- raw_message.go
- limiter.go
- limiter_test.go
- reader.go
- writer.go
- log.go
- counter.go
- counter_test.go
- date_counter.go
- date_counter_test.go
- metrics.go
- conn.go
- conn_test.go
- dial.go
- dns.go
- http.go
- kcp.go
- listener.go
- proxyprotocol.go
- proxyprotocol_test.go
- tls.go
- udp.go
- websocket.go
- system.go
- system_android.go
- httpconnect.go
- types.go
- util.go
- util_test.go
- version.go
- http.go
- http_test.go
- https.go
- https_test.go
- resource.go
- router.go
- router_test.go
- vhost.go
- backoff.go
- backoff_test.go
- ctx.go
- log_writer.go
- xlog.go
- xlog_test.go
- client.go
- controller.go
- message.go
- tun.go
- tun_darwin.go
- tun_linux.go
- tun_unsupported.go
- resource.go
- base.go
- base_test.go
- group.go
- http.go
- https.go
- listener.go
- listener_test.go
- registry.go
- registry_test.go
- tcp.go
- tcpmux.go
- types.go
- v2.go
- controller.go
- controller_test.go
- controller_v2.go
- controller_v2_proxy_spec_test.go
- controller_v2_test.go
- metrics.go
- ports.go
- ports_test.go
- http.go
- https.go
- proxy.go
- proxy_test.go
- stcp.go
- sudp.go
- sudp_benchmark_test.go
- sudp_test.go
- tcp.go
- tcpmux.go
- udp.go
- xtcp.go
- xtcp_test.go
- registry.go
- registry_test.go
- visitor.go
- visitor_test.go
- api_router.go
- control.go
- control_test.go
- service.go
- service_test.go
- compatibility_test.go
- consts.go
- client.go
- expect.go
- framework.go
- log.go
- mockservers.go
- process.go
- request.go
- test_context.go
- util.go
- basic.go
- client.go
- client_server.go
- cmd.go
- config.go
- http.go
- server.go
- tcpmux.go
- xtcp.go
- bandwidth_limit.go
- chaos.go
- group.go
- heartbeat.go
- monitor.go
- real_ip.go
- client.go
- server.go
- server.go
- oidcserver.go
- server.go
- interface.go
- generator.go
- selfsigned.go
- plugin.go
- port.go
- util.go
- process.go
- halfopen.go
- request.go
- rpc.go
- client.go
- annotations.go
- basic.go
- client.go
- client_server.go
- cmd.go
- config.go
- http.go
- oidc.go
- server.go
- tcpmux.go
- token_source.go
- wire.go
- xtcp.go
- bandwidth_limit.go
- chaos.go
- control_replacement.go
- group.go
- heartbeat.go
- monitor.go
- real_ip.go
- ssh_tunnel.go
- store.go
- client.go
- server.go
- e2e.go
- e2e_test.go
- examples.go
- suites.go
- favicon.ico
- frpc.ts
- http.ts
- _form-layout.scss
- dark.css
- var.css
- github.svg
- logo.svg
- ProxyAuthSection.vue
- ProxyBackendSection.vue
- ProxyBaseSection.vue
- ProxyFormLayout.vue
- ProxyHealthSection.vue
- ProxyHttpSection.vue
- ProxyLoadBalanceSection.vue
- ProxyMetadataSection.vue
- ProxyNatSection.vue
- ProxyRemoteSection.vue
- ProxyTransportSection.vue
- VisitorBaseSection.vue
- VisitorConnectionSection.vue
- VisitorFormLayout.vue
- VisitorPluginSection.vue
- VisitorTransportSection.vue
- VisitorXtcpSection.vue
- ConfigField.vue
- ConfigSection.vue
- KeyValueEditor.vue
- ProxyCard.vue
- StatusPills.vue
- StringListEditor.vue
- useResponsive.ts
- index.ts
- client.ts
- proxy.ts
- visitor.ts
- constants.ts
- index.ts
- proxy-converters.ts
- proxy-form.ts
- proxy-status.ts
- proxy-store.ts
- format.ts
- ClientConfigure.vue
- ProxyDetail.vue
- ProxyEdit.vue
- ProxyList.vue
- VisitorDetail.vue
- VisitorEdit.vue
- VisitorList.vue
- App.vue
- env.d.ts
- main.ts
- svg.d.ts
- config-field.test.ts
- proxy-converters.test.ts
- .gitignore
- .prettierrc.json
- auto-imports.d.ts
- components.d.ts
- embed.go
- embed_stub.go
- eslint.config.js
- index.html
- Makefile
- package.json
- README.md
- tsconfig.json
- tsconfig.node.json
- vite.config.mts
- favicon.ico
- client.ts
- http.ts
- proxy.ts
- server.ts
- dark.css
- var.css
- github.svg
- logo.svg
- ClientCard.vue
- ProxyCard.vue
- StatCard.vue
- Traffic.vue
- useResponsive.ts
- index.ts
- client.ts
- proxy.ts
- server.ts
- client.ts
- format.ts
- proxy.ts
- ClientDetail.vue
- Clients.vue
- Proxies.vue
- ProxyDetail.vue
- ServerOverview.vue
- App.vue
- env.d.ts
- main.ts
- svg.d.ts
- stat-card.test.ts
- .gitignore
- .prettierrc.json
- auto-imports.d.ts
- components.d.ts
- embed.go
- embed_stub.go
- eslint.config.js
- index.html
- Makefile
- package.json
- README.md
- tsconfig.json
- tsconfig.node.json
- vite.config.mts
- ActionButton.vue
- BaseDialog.vue
- ConfirmDialog.vue
- FilterDropdown.vue
- PopoverMenu.vue
- PopoverMenuItem.vue
- _index.scss
- _mixins.scss
- _variables.scss
- action-button.test.ts
- package.json
- setup.test.ts
- setup.ts
- package-lock.json
- package.json
- vitest.config.mts
- .gitignore
- .golangci.yml
- .goreleaser.yml
- AGENTS.md
- CLAUDE.md
- go.mod
- go.sum
- LICENSE
- Makefile
- Makefile.cross-compiles
- package.sh
- README.md
- README_zh.md
- Release.md
# Installation Guide
1. Get the code
git clone https://github.com/fatedier/frp
Downloads the entire project code from GitHub to your computer.
cd frp
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
cd web/frpc
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)