You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Devin Carr 867360c8dd Release 2023.5.1 1 week ago
.github check.yaml: update actions to v3 (#876) 3 months ago
.mac_resources AUTH-2712 mac package build script and better config file handling when started as a service 3 years ago
.teamcity EDGESTORE-108: Remove deprecated s3v2 signature 3 months ago
carrier TUN-7057: Remove dependency github.com/gorilla/mux 5 months ago
cfapi TUN-7134: Acquire token for cloudflared tail 2 months ago
cfio TUN-6035: Reduce buffer size when proxying data 1 year ago
cmd/cloudflared TUN-7393: Add json output for cloudflared tail 1 month ago
component-tests TUN-7133: Add sampling support for streaming logs 1 month ago
config TUN-7134: Acquire token for cloudflared tail 2 months ago
connection TUN-7227: Migrate to devincarr/quic-go 3 weeks ago
credentials TUN-7134: Acquire token for cloudflared tail 2 months ago
datagramsession TUN-7227: Migrate to devincarr/quic-go 3 weeks ago
edgediscovery TUN-7131: Add cloudflared log event to connection messages and enable streaming logs 2 months ago
features TUN-7131: Add cloudflared log event to connection messages and enable streaming logs 2 months ago
fips RTG-1339 Support post-quantum hybrid key exchange 9 months ago
h2mux TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
hello TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2 years ago
ingress TUN-7354: Don't warn for empty ingress rules when using --token 2 months ago
internal/test TUN-7125: Add management streaming logs WebSocket protocol 2 months ago
ipaccess TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
logger TUN-7127: Disconnect logger level requirement for management 2 months ago
management TUN-7424: Add CORS headers to host_details responses 2 weeks ago
metrics TUN-7147: Revert wrong removal of debug endpoint from metrics port 4 months ago
orchestration TUN-7404: Default configuration version set to -1 4 weeks ago
overwatch AUTH-2169 make access login page more generic 3 years ago
packet ZTC-234: Replace ICMP funnels when ingress connection changes 7 months ago
proxy TUN-7129: Categorize TCP logs for streaming logs 1 month ago
quic TUN-7227: Migrate to devincarr/quic-go 3 weeks ago
retry TUN-3863: Consolidate header handling logic in the connection package; move headers definitions from h2mux to packages that manage them; cleanup header conversions 2 years ago
signal TUN-1562: Refactor connectedSignal to be safe to close multiple times 4 years ago
socks Fix typos 2 years ago
ssh_server_tests Fix typos 2 years ago
sshgen CC-796: Remove dependency on unsupported version of go-oidc 1 year ago
stream TUN-7057: Remove dependency github.com/gorilla/mux 5 months ago
supervisor TUN-7227: Migrate to devincarr/quic-go 3 weeks ago
tlsconfig TUN-6724: Migrate to sentry-go from raven-go 5 months ago
token AUTH-4887 Add aud parameter to token transfer url 1 month ago
tracing TUN-7197: Add connIndex tag to debug messages of incoming requests 3 months ago
tunneldns TUN-7066: Bump coredns to v1.10.0 4 months ago
tunnelrpc TUN-7378: Remove RPC debug logs 1 month ago
tunnelstate TUN-6617: Dont fallback to http2 if QUIC conn was successful. 10 months ago
validation TUN-6917: Bump go to 1.19.3 7 months ago
vendor TUN-7424: Add CORS headers to host_details responses 2 weeks ago
watcher TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
websocket TUN-7057: Remove dependency github.com/gorilla/mux 5 months ago
.docker-images TUN-6825: Fix cloudflared:version images require arch hyphens 8 months ago
.dockerignore TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2 years ago
.gitignore TUN-5853 Add "install" make target and build package manager info into executable 1 year ago
CHANGES.md Release 2023.4.1 1 month ago
Dockerfile Label correct container 8 months ago
Dockerfile.amd64 Label correct container 8 months ago
Dockerfile.arm64 Label correct container 8 months ago
LICENSE TUN-5851: Update all references to point to Apache License 2.0 1 year ago
Makefile Add suport for OpenBSD (#916) 2 months ago
README.md fix link 8 months ago
RELEASE_NOTES Release 2023.5.1 1 week ago
build-packages-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
build-packages.sh TUN-6590: Use Windows Teamcity agent to build binary 8 months ago
cfsetup.yaml TUN-7390: Remove Debian stretch builds 1 month ago
check-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
cloudflared.wxs TUN-7268: Default to Program Files as location for win32 3 months ago
cloudflared_man_template AUTH-2644: Change install location and add man page 3 years ago
dev.Dockerfile TUN-6917: Bump go to 1.19.3 7 months ago
fmt-check.sh TUN-6917: Bump go to 1.19.3 7 months ago
github_message.py TUN-6823: Update github release message to pull from KV 8 months ago
github_release.py TUN-7392: Ignore release checksum upload if asset already uploaded 1 month ago
go.mod TUN-7424: Add CORS headers to host_details responses 2 weeks ago
go.sum TUN-7424: Add CORS headers to host_details responses 2 weeks ago
jet.yaml TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2 years ago
postinst.sh AUTH-2858: Set file to disable autoupdate 3 years ago
postrm.sh AUTH-2858: Set file to disable autoupdate 3 years ago
release_pkgs.py TUN-6362: Add armhf support to cloudflare packaging 11 months ago
wix.json AUTH-2712 mac package build script and better config file handling when started as a service 3 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