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
João Oliveirinha 7bcab138c5 Release 2022.5.1 1 year ago
.github Update issue templates 1 year ago
.mac_resources AUTH-2712 mac package build script and better config file handling when started as a service 3 years ago
.teamcity TUN-6161: Set git user/email for brew core release 1 year ago
carrier carrier: fix dropped errors 1 year ago
certutil Fix typos 2 years ago
cfapi TUN-5915: New cloudflared command to allow to retrieve the token credentials for a Tunnel 1 year ago
cfio TUN-6035: Reduce buffer size when proxying data 1 year ago
cmd/cloudflared TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
component-tests TUN-5954: Start cloudflared service in Linux too similarly to other OSs 1 year ago
config TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
connection TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
datagramsession TUN-6166: Fix mocked QUIC transport for UDP proxy manager to return expected error 1 year ago
edgediscovery TUN-5973: Add backoff for non-recoverable errors as well 1 year ago
fips TUN-3905: Cannot run go mod vendor in cloudflared due to fips 2 years 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-6185: Fix tcpOverWSOriginService not using original scheme for String representation 1 year ago
ipaccess TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
logger 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. 2 years ago
metrics TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
orchestration TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
overwatch AUTH-2169 make access login page more generic 3 years ago
proxy TUN-6030: Add ttfb span for origin http request 1 year ago
quic TUN-5697: Listen for UpdateConfiguration RPC in quic transport 1 year 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
supervisor TUN-6070: First connection retries other edge IPs if the error is quic timeout(likely due to firewall blocking UDP) 1 year ago
tlsconfig TUN-5612: Make tls min/max version public visible 1 year ago
token CC-796: Remove dependency on unsupported version of go-oidc 1 year ago
tracing TUN-6130: Fix vendoring due to case sensitive typo in package 1 year ago
tunneldns TUN-5675: Remove github.com/dgrijalva/jwt-go dependency by upgrading coredns version 1 year ago
tunnelrpc TUN-6016: Push local managed tunnels configuration to the edge 1 year ago
tunnelstate TUN-5368: Log connection issues with LogLevel that depends on tunnel state 2 years ago
validation TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2 years ago
vendor TUN-6158: Update golang.org/x/crypto 1 year ago
watcher TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
websocket TUN-6035: Reduce buffer size when proxying data 1 year ago
.docker-images TUN-4130: cloudflared docker images now have a latest tag 1 year 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 TUN-5960: Do not log the tunnel token or json credentials 1 year ago
Dockerfile TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2 years ago
LICENSE TUN-5851: Update all references to point to Apache License 2.0 1 year ago
Makefile Update Makefile 1 year ago
README.md TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2 years ago
RELEASE_NOTES Release 2022.5.1 1 year ago
build-packages-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
build-packages.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
cfsetup.yaml TUN-5958: Fix release to homebrew core 1 year ago
check-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 1 year ago
cloudflared.wxs TUN-4911: Append Environment variable to Path instead of overwriting it 2 years ago
cloudflared_man_template AUTH-2644: Change install location and add man page 3 years ago
dev.Dockerfile TUN-5631: Build everything with go 1.17.5 1 year ago
fmt-check.sh 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. 2 years ago
github_message.py AUTH-3148 fixed cloudflared copy and match all the files in the checksum upload 3 years ago
github_release.py Fix typos 2 years ago
go.mod TUN-6158: Update golang.org/x/crypto 1 year ago
go.sum TUN-6158: Update golang.org/x/crypto 1 year 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-6146: Release_pkgs is now a generic command line script 1 year 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