Go to file
James Peter f76b87252e Fixes cloudflare/cloudflared#1273 2024-06-13 16:01:16 +10:00
.github TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
.mac_resources
.teamcity TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
carrier
cfapi TUN-8281: Run cloudflared query list tunnels/routes endpoint in a paginated way 2024-03-19 16:35:40 +00:00
cfio
cmd/cloudflared TUN-8452: Add flag to control QUIC stream-level flow control limit 2024-06-06 11:50:46 -05:00
component-tests TUN-8380: Add sleep before requesting quick tunnel as temporary fix for component tests 2024-04-22 13:50:04 -05:00
config feat: auto tls sni 2024-04-02 14:56:44 -07:00
connection TUN-8422: Add metrics for capnp method calls 2024-05-28 14:14:25 -07:00
credentials
datagramsession TUN-8441: Correct UDP total sessions metric to a counter and add new ICMP metrics 2024-05-30 14:23:10 -07:00
edgediscovery
features TUN-7970: Default to enable post quantum encryption for quic transport 2023-12-07 11:37:46 +00:00
fips
h2mux TUN-7585: Remove h2mux compression 2023-07-18 18:14:19 +00:00
hello TUN-7590: Remove usages of ioutil 2023-07-17 19:08:38 +00:00
ingress TUN-8441: Correct UDP total sessions metric to a counter and add new ICMP metrics 2024-05-30 14:23:10 -07:00
internal/test
ipaccess
logger TUN-7543: Add --debug-stream flag to cloudflared access ssh 2023-06-29 10:29:15 -07:00
management TUN-8333: Bump go-jose dependency to v4 2024-04-10 09:49:40 -07:00
metrics
orchestration TUN-8423: Deprecate older legacy tunnel capnp interfaces 2024-05-23 11:17:49 -07:00
overwatch
packet
proxy Fixes cloudflare/cloudflared#1273 2024-06-13 16:01:16 +10:00
quic TUN-8451: Log QUIC flow control frames and transport parameters received 2024-06-12 19:23:39 +00:00
retry TUN-8427: Fix BackoffHandler's internally shared clock structure 2024-05-23 09:48:34 -07:00
signal
socks TUN-7590: Remove usages of ioutil 2023-07-17 19:08:38 +00:00
ssh_server_tests
sshgen TUN-8333: Bump go-jose dependency to v4 2024-04-10 09:49:40 -07:00
stream TUN-7545: Add support for full bidirectionally streaming with close signal propagation 2023-07-06 11:54:26 +01:00
supervisor TUN-8452: Add flag to control QUIC stream-level flow control limit 2024-06-06 11:50:46 -05:00
tlsconfig TUN-7590: Remove usages of ioutil 2023-07-17 19:08:38 +00:00
token TUN-8427: Fix BackoffHandler's internally shared clock structure 2024-05-23 09:48:34 -07:00
tracing TUN-8052: Update go to 1.21.5 2023-12-15 12:17:21 +00:00
tunneldns TUN-7590: Remove usages of ioutil 2023-07-17 19:08:38 +00:00
tunnelrpc TUN-8422: Add metrics for capnp method calls 2024-05-28 14:14:25 -07:00
tunnelstate
validation TUN-7628: Correct Host parsing for Access 2023-07-25 09:33:11 -07:00
vendor TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
watcher TUN-7584: Bump go 1.20.6 2023-07-26 13:52:40 -07:00
websocket
.docker-images
.dockerignore
.gitignore
CHANGES.md TUN-8242: Update Changes.md file with new remote diagnostics behaviour 2024-02-20 16:22:20 +00:00
Dockerfile TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
Dockerfile.amd64 TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
Dockerfile.arm64 TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
LICENSE
Makefile TUN-8415: Refactor capnp rpc into a single module 2024-05-17 11:22:07 -07:00
README.md TUN-8118: Disable FIPS module to build with go-boring without CGO_ENABLED 2024-01-08 18:16:06 +00:00
RELEASE_NOTES Release 2024.6.0 2024-06-03 11:29:11 -07:00
build-packages-fips.sh TUN-8129: Use the same build command between branch and release builds 2024-01-09 17:07:49 +00:00
build-packages.sh TUN-8176: Support ARM platforms that don't have an FPU or have it enabled in kernel 2024-01-22 16:35:59 +00:00
catalog-info.yaml TUN-7599: Onboard cloudflared to Software Dashboard 2023-07-19 13:30:35 +00:00
cfsetup.yaml TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
check-fips.sh
cloudflared.wxs Remove extraneous `period` from Path Environment Variable (#1009) 2023-12-14 16:32:48 +00:00
cloudflared_man_template
dev.Dockerfile TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
fmt-check.sh
github_message.py
github_release.py
go.mod TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
go.sum TUN-8407: Upgrade go to version 1.22.2 2024-05-07 16:58:57 +01:00
postinst.sh
postrm.sh TUN-8290: Remove `|| true` from postrm.sh 2024-03-07 16:22:56 +00:00
release_pkgs.py TUN-7718: Update R2 Token to no longer encode secret 2023-08-25 13:01:28 +00:00
wix.json

README.md

Cloudflare Tunnel client

Contains the command-line client for Cloudflare Tunnel, a tunneling daemon that proxies traffic from the Cloudflare network to your origins. This daemon sits between Cloudflare network and your origin (e.g. a webserver). Cloudflare attracts client requests and sends them to you via this daemon, without requiring you to poke holes on your firewall --- your origin can remain as closed as possible. Extensive documentation can be found in the Cloudflare Tunnel section of the Cloudflare Docs. All usages related with proxying to your origins are available under cloudflared tunnel help.

You can also use cloudflared to access Tunnel origins (that are protected with cloudflared tunnel) for TCP traffic at Layer 4 (i.e., not HTTP/websocket), which is relevant for use cases such as SSH, RDP, etc. Such usages are available under cloudflared access help.

You can instead use WARP client to access private origins behind Tunnels for Layer 4 traffic without requiring cloudflared access commands on the client side.

Before you get started

Before you use Cloudflare Tunnel, you'll need to complete a few steps in the Cloudflare dashboard: you need to add a website to your Cloudflare account. Note that today it is possible to use Tunnel without a website (e.g. for private routing), but for legacy reasons this requirement is still necessary:

  1. Add a website to Cloudflare
  2. Change your domain nameservers to Cloudflare

Installing cloudflared

Downloads are available as standalone binaries, a Docker image, and Debian, RPM, and Homebrew packages. You can also find releases here on the cloudflared GitHub repository.

User documentation for Cloudflare Tunnel can be found at https://developers.cloudflare.com/cloudflare-one/connections/connect-apps

Creating Tunnels and routing traffic

Once installed, you can authenticate cloudflared into your Cloudflare account and begin creating Tunnels to serve traffic to your origins.

TryCloudflare

Want to test Cloudflare Tunnel before adding a website to Cloudflare? You can do so with TryCloudflare using the documentation available here.

Deprecated versions

Cloudflare currently supports versions of cloudflared that are within one year of the most recent release. Breaking changes unrelated to feature availability may be introduced that will impact versions released more than one year ago. You can read more about upgrading cloudflared in our developer documentation.

For example, as of January 2023 Cloudflare will support cloudflared version 2023.1.1 to cloudflared 2022.1.1.