4dc96f41c9
if login_fail_exit is false, when frpc first login to server failed, it
will continues relogin to server every 30 seconds.
|
||
|---|---|---|
| .github | ||
| assets | ||
| client | ||
| cmd | ||
| conf | ||
| doc | ||
| Godeps | ||
| models | ||
| server | ||
| tests | ||
| utils | ||
| vendor | ||
| web/frps | ||
| .dockerignore | ||
| .gitignore | ||
| .travis.yml | ||
| Dockerfile | ||
| Dockerfile_alpine | ||
| LICENSE | ||
| Makefile | ||
| Makefile.cross-compiles | ||
| package.sh | ||
| README_zh.md | ||
| README.md | ||
frp
What is frp?
frp is a fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet. Now, it supports tcp, udp, http and https protocol when requests can be forwarded by domains to backward web services.
Table of Contents
- What can I do with frp?
- Status
- Architecture
- Example Usage
- Features
- Development Plan
- Contributing
- Donation
What can I do with frp?
- Expose any http and https service behind a NAT or firewall to the internet by a server with public IP address(Name-based Virtual Host Support).
- Expose any tcp or udp service behind a NAT or firewall to the internet by a server with public IP address.
Status
frp is under development and you can try it with latest release version. Master branch for releasing stable version when dev branch for developing.
We may change any protocol and can't promise backward compatible. Please check the release log when upgrading.
Architecture
Example Usage
Firstly, download the latest programs from Release page according to your os and arch.
Put frps and frps.ini to your server with public IP.
Put frpc and frpc.ini to your server in LAN.
Access your computer in LAN by SSH
- Modify frps.ini:
# frps.ini
[common]
bind_port = 7000
- Start frps:
./frps -c ./frps.ini
- Modify frpc.ini,
server_addris your frps's server IP:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[ssh]
type = tcp
local_ip = 127.0.0.1
local_port = 22
remote_port = 6000
- Start frpc:
./frpc -c ./frpc.ini
- Connect to server in LAN by ssh assuming that username is test:
ssh -oPort=6000 test@x.x.x.x
Visit your web service in LAN by custom domains
Sometimes we want to expose a local web service behind a NAT network to others for testing with your own domain name and unfortunately we can't resolve a domain name to a local ip.
However, we can expose a http or https service using frp.
- Modify frps.ini, configure http port 8080:
# frps.ini
[common]
bind_port = 7000
vhost_http_port = 8080
- Start frps:
./frps -c ./frps.ini
- Modify frpc.ini and set remote frps server's IP as x.x.x.x. The
local_portis the port of your web service:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[web]
type = http
local_port = 80
custom_domains = www.yourdomain.com
- Start frpc:
./frpc -c ./frpc.ini
-
Resolve A record of
www.yourdomain.comto IPx.x.x.xor CNAME record to your origin domain. -
Now visit your local web service using url
http://www.yourdomain.com:8080.
Forward DNS query request
- Modify frps.ini, configure a reverse proxy named [dns]:
# frps.ini
[common]
bind_port = 7000
- Start frps:
./frps -c ./frps.ini
- Modify frpc.ini, set remote frps's server IP as x.x.x.x, forward dns query request to google dns server
8.8.8.8:53:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[dns]
type = udp
local_ip = 8.8.8.8
local_port = 53
remote_port = 6000
- Start frpc:
./frpc -c ./frpc.ini
- Send dns query request by dig:
dig @x.x.x.x -p 6000 www.goolge.com
Features
Dashboard
Check frp's status and proxies's statistics information by Dashboard.
Configure a port for dashboard to enable this feature:
[common]
dashboard_port = 7500
# dashboard's username and password are both optional，if not set, default is admin.
dashboard_user = admin
dashboard_pwd = admin
Then visit http://[server_addr]:7500 to see dashboard, default username and password are both admin.
Authentication
Since v0.10.0, you only need to set privilege_token in frps.ini and frpc.ini.
Note that time duration between server of frpc and frps mustn't exceed 15 minutes because timestamp is used for authentication.
Howerver, this timeout duration can be modified by setting authentication_timeout in frps's configure file. It's defalut value is 900, means 15 minutes. If it is equals 0, then frps will not check authentication timeout.
Encryption and Compression
Defalut value is false, you could decide if the proxy will use encryption or compression:
# frpc.ini
[ssh]
type = tcp
local_port = 22
remote_port = 6000
use_encryption = true
use_compression = true
Reload configures without frps stopped
This feature is removed since v0.10.0.
Privilege Mode
Privilege mode is the default and only mode support in frp since v0.10.0. All proxy configurations are set in client.
Port White List
privilege_allow_ports in frps.ini is used for preventing abuse of ports:
# frps.ini
[common]
privilege_allow_ports = 2000-3000,3001,3003,4000-50000
privilege_allow_ports consists of a specific port or a range of ports divided by ,.
TCP Stream Multiplexing
frp support tcp stream multiplexing since v0.10.0 like HTTP2 Multiplexing. All user requests to same frpc can use only one tcp connection.
You can disable this feature by modify frps.ini and frpc.ini:
# frps.ini and frpc.ini, must be same
[common]
tcp_mux = false
Connection Pool
By default, frps send message to frpc for create a new connection to backward service when getting an user request.If a proxy's connection pool is enabled, there will be a specified number of connections pre-established.
This feature is fit for a large number of short connections.
- Configure the limit of pool count each proxy can use in frps.ini:
# frps.ini
[common]
max_pool_count = 5
- Enable and specify the number of connection pool:
# frpc.ini
[common]
pool_count = 1
Rewriting the Host Header
When forwarding to a local port, frp does not modify the tunneled HTTP requests at all, they are copied to your server byte-for-byte as they are received. Some application servers use the Host header for determining which development site to display. For this reason, frp can rewrite your requests with a modified Host header. Use the host_header_rewrite switch to rewrite incoming HTTP requests.
# frpc.ini
[web]
type = http
local_port = 80
custom_domains = test.yourdomain.com
host_header_rewrite = dev.yourdomain.com
If host_header_rewrite is specified, the Host header will be rewritten to match the hostname portion of the forwarding address.
Password protecting your web service
Anyone who can guess your tunnel URL can access your local web server unless you protect it with a password.
This enforces HTTP Basic Auth on all requests with the username and password you specify in frpc's configure file.
It can only be enabled when proxy type is http.
# frpc.ini
[web]
type = http
local_port = 80
custom_domains = test.yourdomain.com
http_user = abc
http_pwd = abc
Visit http://test.yourdomain.com and now you need to input username and password.
Custom subdomain names
It is convenient to use subdomain configure for http、https type when many people use one frps server together.
# frps.ini
subdomain_host = frps.com
Resolve *.frps.com to the frps server's IP.
# frpc.ini
[web]
type = http
local_port = 80
subdomain = test
Now you can visit your web service by host test.frps.com.
Note that if subdomain_host is not empty, custom_domains should not be the subdomain of subdomain_host.
URL routing
frp support forward http requests to different backward web services by url routing.
locations specify the prefix of URL used for routing. frps first searches for the most specific prefix location given by literal strings regardless of the listed order.
# frpc.ini
[web01]
type = http
local_port = 80
custom_domains = web.yourdomain.com
locations = /
[web02]
type = http
local_port = 81
custom_domains = web.yourdomain.com
locations = /news,/about
Http requests with url prefix /news and /about will be forwarded to web02 and others to web01.
Connect frps by HTTP PROXY
frpc can connect frps using HTTP PROXY if you set os environment HTTP_PROXY or configure http_proxy param in frpc.ini file.
# frpc.ini
server_addr = x.x.x.x
server_port = 7000
http_proxy = http://user:pwd@192.168.1.128:8080
Development Plan
- Log http request information in frps.
- Direct reverse proxy, like haproxy.
- Load balance to different service in frpc.
- Frpc can directly be a webserver for static files.
- Full control mode, dynamically modify frpc's configure with dashboard in frps.
- P2p communicate by make udp hole to penetrate NAT.
- Client Plugin (http proxy).
- kubernetes ingress support.
Contributing
Interested in getting involved? We would like to help you!
- Take a look at our issues list and consider sending a Pull Request to dev branch.
- If you want to add a new feature, please create an issue first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.
- Sorry for my poor english and improvement for this document is welcome even some typo fix.
- If you have some wanderful ideas, send email to fatedier@gmail.com.
Note: We prefer you to give your advise in issues, so others with a same question can search it quickly and we don't need to answer them repeatly.
Donation
If frp help you a lot, you can support us by:
frp QQ group: 606194980
AliPay
Paypal
Donate money by paypal to my account fatedier@gmail.com.