Go to file
Nuno Diegues 092e76eb55 TUN-5954: Start cloudflared service in Linux too similarly to other OSs 2022-03-25 13:57:47 +00:00
.github Update issue templates 2022-02-14 14:02:45 -06:00
.mac_resources AUTH-2712 mac package build script and better config file handling when started as a service 2020-06-25 16:44:57 -05:00
.teamcity TUN-5895 run brew bump-formula-pr on release 2022-03-22 19:45:25 +00:00
carrier Fix typos 2021-11-12 17:38:06 +02:00
certutil Fix typos 2021-11-12 17:38:06 +02:00
cfapi TUN-5915: New cloudflared command to allow to retrieve the token credentials for a Tunnel 2022-03-23 10:35:16 +00:00
cmd/cloudflared TUN-5954: Start cloudflared service in Linux too similarly to other OSs 2022-03-25 13:57:47 +00:00
component-tests TUN-5954: Start cloudflared service in Linux too similarly to other OSs 2022-03-25 13:57:47 +00:00
config TUN-5869: Add configuration endpoint in metrics server 2022-03-22 08:11:59 -07:00
connection TUN-5915: New cloudflared command to allow to retrieve the token credentials for a Tunnel 2022-03-23 10:35:16 +00:00
datagramsession TUN-5659: Proxy UDP with zero-byte payload 2022-01-21 09:42:05 +00:00
edgediscovery TUN-5138: Switch to QUIC on auto protocol based on threshold 2021-10-14 09:18:20 +01:00
fips TUN-3905: Cannot run go mod vendor in cloudflared due to fips 2021-03-09 17:31:59 +04:00
h2mux TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
hello TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2021-09-29 08:27:47 +00:00
ingress TUN-5869: Add configuration endpoint in metrics server 2022-03-22 08:11:59 -07:00
ipaccess TUN-4017: Add support for using cloudflared as a full socks proxy. 2021-03-10 21:26:12 +00:00
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. 2021-03-24 10:53:29 -05:00
metrics TUN-5869: Add configuration endpoint in metrics server 2022-03-22 08:11:59 -07:00
orchestration TUN-5869: Add configuration endpoint in metrics server 2022-03-22 08:11:59 -07:00
overwatch AUTH-2169 make access login page more generic 2020-06-08 11:20:30 -05:00
proxy TUN-5836: QUIC transport no longer sets body to nil in any condition 2022-03-07 11:39:07 +00:00
quic TUN-5697: Listen for UpdateConfiguration RPC in quic transport 2022-02-18 09:12:39 +00:00
retry TUN-3863: Consolidate header handling logic in the connection package; move headers definitions from h2mux to packages that manage them; cleanup header conversions 2021-03-29 21:57:56 +00:00
signal TUN-1562: Refactor connectedSignal to be safe to close multiple times 2019-03-05 15:51:35 -06:00
socks Fix typos 2021-11-12 17:38:06 +02:00
ssh_server_tests Fix typos 2021-11-12 17:38:06 +02:00
sshgen CC-796: Remove dependency on unsupported version of go-oidc 2022-03-18 18:16:10 +00:00
supervisor TUN-5833: Create constant for allow-remote-config 2022-03-10 10:48:03 +00:00
tlsconfig TUN-5612: Make tls min/max version public visible 2022-01-03 18:13:57 +00:00
token CC-796: Remove dependency on unsupported version of go-oidc 2022-03-18 18:16:10 +00:00
tunneldns TUN-5675: Remove github.com/dgrijalva/jwt-go dependency by upgrading coredns version 2022-01-25 15:24:13 +00:00
tunnelrpc TUN-5697: Listen for UpdateConfiguration RPC in quic transport 2022-02-18 09:12:39 +00:00
tunnelstate TUN-5368: Log connection issues with LogLevel that depends on tunnel state 2021-11-10 09:00:05 +00:00
validation TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2021-09-29 08:27:47 +00:00
vendor CC-796: Remove dependency on unsupported version of go-oidc 2022-03-18 18:16:10 +00:00
watcher TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
websocket TUN-5836: Avoid websocket#Stream function from crashing cloudflared with unexpected memory access 2022-03-04 18:42:41 +00:00
.docker-images AUTH-2871: fix rpm builds 2020-07-08 14:39:28 +00:00
.dockerignore TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
.gitignore TUN-5853 Add "install" make target and build package manager info into executable 2022-03-08 15:31:14 -06:00
CHANGES.md TUN-5954: Start cloudflared service in Linux too similarly to other OSs 2022-03-25 13:57:47 +00:00
Dockerfile TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
LICENSE TUN-5851: Update all references to point to Apache License 2.0 2022-03-08 17:35:31 +00:00
Makefile TUN-5853 Add "install" make target and build package manager info into executable 2022-03-08 15:31:14 -06:00
README.md TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2021-09-29 08:27:47 +00:00
RELEASE_NOTES Release 2022.3.3 2022-03-18 18:30:38 +00:00
build-packages-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
build-packages.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
cfsetup.yaml TUN-5895 run brew bump-formula-pr on release 2022-03-22 19:45:25 +00:00
check-fips.sh TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
cloudflared.wxs TUN-4911: Append Environment variable to Path instead of overwriting it 2021-08-09 15:45:29 +01:00
cloudflared_man_template AUTH-2644: Change install location and add man page 2020-07-06 19:27:25 +00:00
dev.Dockerfile TUN-5631: Build everything with go 1.17.5 2022-01-10 12:34:04 +00:00
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. 2021-03-24 10:53:29 -05:00
github_message.py AUTH-3148 fixed cloudflared copy and match all the files in the checksum upload 2020-10-06 11:39:40 -05:00
github_release.py Fix typos 2021-11-12 17:38:06 +02:00
go.mod CC-796: Remove dependency on unsupported version of go-oidc 2022-03-18 18:16:10 +00:00
go.sum CC-796: Remove dependency on unsupported version of go-oidc 2022-03-18 18:16:10 +00:00
jet.yaml TUN-5164: Update README and clean up references to Argo Tunnel (using Cloudflare Tunnel instead) 2021-09-29 08:27:47 +00:00
postinst.sh AUTH-2858: Set file to disable autoupdate 2020-07-10 18:03:07 +00:00
postrm.sh AUTH-2858: Set file to disable autoupdate 2020-07-10 18:03:07 +00:00
wix.json AUTH-2712 mac package build script and better config file handling when started as a service 2020-06-25 16:44:57 -05:00

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