No Description

João Oliveirinha c4ee819e1c Release 2023.2.1 2 years ago
.github 2b3707e2b9 TUN-6717: Update Github action to run with Go 1.19 3 years ago
.mac_resources 0c65daaa7d AUTH-2712 mac package build script and better config file handling when started as a service 5 years ago
.teamcity 78ca8002d2 TUN-7003: Add back a missing fi 2 years ago
carrier 887e486a63 TUN-7057: Remove dependency github.com/gorilla/mux 2 years ago
certutil 19106cd609 TUN-6935: Cloudflared should use APIToken instead of serviceKey 3 years ago
cfapi 4616e9fcc2 ZTC-446: Allow to force delete a vnet 2 years ago
cfio d1a4710aa2 TUN-6035: Reduce buffer size when proxying data 3 years ago
cmd 62dcb8a1d1 Revert "TUN-7065: Remove classic tunnel creation" 2 years ago
component-tests 62dcb8a1d1 Revert "TUN-7065: Remove classic tunnel creation" 2 years ago
config 61ccc0b303 TUN-6994: Improve logging config file not found 3 years ago
connection 62dcb8a1d1 Revert "TUN-7065: Remove classic tunnel creation" 2 years ago
datagramsession 40ea6a5080 TUN-6829: Allow user of datagramsession to control logging level of errors 3 years ago
edgediscovery b8b35d99fa TUN-7002: Randomise first region selection 3 years ago
fips 11cbff4ff7 RTG-1339 Support post-quantum hybrid key exchange 3 years ago
h2mux 70e675f42c TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 3 years ago
hello cbdf88ea28 TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 4 years ago
ingress 62dcb8a1d1 Revert "TUN-7065: Remove classic tunnel creation" 2 years ago
ipaccess 99d4e48656 TUN-6016: Push local managed tunnels configuration to the edge 3 years ago
logger da4d0b2bae TUN-4067: Reformat code for consistent import order, grouping, and fix formatting. Added goimports target to the Makefile to make this easier in the future. 4 years ago
metrics d8f2b768f8 TUN-7147: Revert wrong removal of debug endpoint from metrics port 2 years ago
orchestration 49438f30f5 TUN-6813: Only proxy ICMP packets when warp-routing is enabled 3 years ago
overwatch 2f70b05c64 AUTH-2169 make access login page more generic 5 years ago
packet 2baea15387 ZTC-234: Replace ICMP funnels when ingress connection changes 3 years ago
proxy 93e569fa23 TUN-7146: Avoid data race in closing origin connection too early 2 years ago
quic 7ef9bb89d3 TUN-7000: Reduce metric cardinality of closedConnections metric by removing error as tag 3 years ago
retry 8ca0d86c85 TUN-3863: Consolidate header handling logic in the connection package; move headers definitions from h2mux to packages that manage them; cleanup header conversions 4 years ago
signal 073c5bfdaa TUN-1562: Refactor connectedSignal to be safe to close multiple times 6 years ago
socks 197a70c9c4 Fix typos 4 years ago
ssh_server_tests 197a70c9c4 Fix typos 4 years ago
sshgen 9422ea8ed8 CC-796: Remove dependency on unsupported version of go-oidc 3 years ago
stream 887e486a63 TUN-7057: Remove dependency github.com/gorilla/mux 2 years ago
supervisor 62dcb8a1d1 Revert "TUN-7065: Remove classic tunnel creation" 2 years ago
tlsconfig 794e8e622f TUN-6724: Migrate to sentry-go from raven-go 2 years ago
token 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
tracing c3c050aa79 TUN-6867: Clear spans right after they are serialized to avoid returning duplicate spans 3 years ago
tunneldns 207f4e2c8d TUN-7066: Bump coredns to v1.10.0 2 years ago
tunnelrpc 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
tunnelstate 99f39225f1 TUN-6617: Dont fallback to http2 if QUIC conn was successful. 3 years ago
validation 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
vendor 207f4e2c8d TUN-7066: Bump coredns to v1.10.0 2 years ago
watcher 70e675f42c TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 3 years ago
websocket 887e486a63 TUN-7057: Remove dependency github.com/gorilla/mux 2 years ago
.docker-images e89bceca5e TUN-6825: Fix cloudflared:version images require arch hyphens 3 years ago
.dockerignore d54c8cc745 TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 4 years ago
.gitignore 9552bb7bc7 TUN-5853 Add "install" make target and build package manager info into executable 3 years ago
CHANGES.md 045439f0ab TUN-7010: Changelog for release 2022.12.0 2 years ago
Dockerfile c280d62fe5 Label correct container 3 years ago
Dockerfile.amd64 c280d62fe5 Label correct container 3 years ago
Dockerfile.arm64 c280d62fe5 Label correct container 3 years ago
LICENSE c54e8cd8e6 TUN-5851: Update all references to point to Apache License 2.0 3 years ago
Makefile 87bd36c924 TUN-7064: RPM digests are now sha256 instead of md5sum 2 years ago
README.md 90e5255a0d fix link 3 years ago
RELEASE_NOTES 8a9f076a26 Release 2023.2.1 2 years ago
build-packages-fips.sh 70e675f42c TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 3 years ago
build-packages.sh b0f0741a9b TUN-6590: Use Windows Teamcity agent to build binary 3 years ago
cfsetup.yaml 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
check-fips.sh 70e675f42c TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 3 years ago
cloudflared.wxs ca85df10ff TUN-4911: Append Environment variable to Path instead of overwriting it 4 years ago
cloudflared_man_template 1ed9e0fceb AUTH-2644: Change install location and add man page 5 years ago
dev.Dockerfile 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
fmt-check.sh 515ad7cbee TUN-6917: Bump go to 1.19.3 3 years ago
github_message.py 4642316167 TUN-6823: Update github release message to pull from KV 3 years ago
github_release.py 197a70c9c4 Fix typos 4 years ago
go.mod 207f4e2c8d TUN-7066: Bump coredns to v1.10.0 2 years ago
go.sum 207f4e2c8d TUN-7066: Bump coredns to v1.10.0 2 years ago
jet.yaml cbdf88ea28 TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 4 years ago
postinst.sh 28d556b8d4 AUTH-2858: Set file to disable autoupdate 5 years ago
postrm.sh 28d556b8d4 AUTH-2858: Set file to disable autoupdate 5 years ago
release_pkgs.py 135c8e6d13 TUN-6362: Add armhf support to cloudflare packaging 3 years ago
wix.json 0c65daaa7d AUTH-2712 mac package build script and better config file handling when started as a service 5 years ago

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 2020.5.1 and later. Breaking changes unrelated to feature availability may be introduced that will impact versions released prior to 2020.5.1. You can read more about upgrading cloudflared in our developer documentation.

Version(s) Deprecation status
2020.5.1 and later Supported
Versions prior to 2020.5.1 No longer supported