Go to file
Sudarsan Reddy c6b4bac76f TUN-7480: Added a timeout for unregisterUDP.
I deliberately kept this as an unregistertimeout because that was the
intent. In the future we could change this to a UDPConnConfig if we want
to pass multiple values here.

The idea of this PR is simply to add a configurable unregister UDP
timeout.
2023-10-22 15:09:33 +02:00
.github check.yaml: update actions to v3 (#876) 2023-02-28 16:18:14 +00: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 EDGESTORE-108: Remove deprecated s3v2 signature 2023-03-09 18:24:42 +00:00
carrier TUN-7057: Remove dependency github.com/gorilla/mux 2022-12-24 21:05:51 -07:00
cfapi TUN-7134: Acquire token for cloudflared tail 2023-04-12 09:43:38 -07:00
cfio TUN-6035: Reduce buffer size when proxying data 2022-04-11 14:41:33 +00:00
cmd/cloudflared TUN-7480: Added a timeout for unregisterUDP. 2023-10-22 15:09:33 +02:00
component-tests TUN-7133: Add sampling support for streaming logs 2023-04-24 09:39:26 -07:00
config TUN-7134: Acquire token for cloudflared tail 2023-04-12 09:43:38 -07:00
connection TUN-7480: Added a timeout for unregisterUDP. 2023-10-22 15:09:33 +02:00
credentials TUN-7134: Acquire token for cloudflared tail 2023-04-12 09:43:38 -07:00
datagramsession TUN-7477: Add UDP/TCP session metrics 2023-10-22 15:09:33 +02:00
edgediscovery TUN-7131: Add cloudflared log event to connection messages and enable streaming logs 2023-04-12 14:41:11 -07:00
features TUN-7131: Add cloudflared log event to connection messages and enable streaming logs 2023-04-12 14:41:11 -07:00
fips RTG-1339 Support post-quantum hybrid key exchange 2022-09-07 19:32:53 +00: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-7463: Add default ingress rule if no ingress rules are provided when updating the configuration 2023-10-22 15:09:33 +02:00
internal/test TUN-7125: Add management streaming logs WebSocket protocol 2023-04-05 16:25:16 +00:00
ipaccess TUN-6016: Push local managed tunnels configuration to the edge 2022-05-06 15:43:24 +00:00
logger TUN-7127: Disconnect logger level requirement for management 2023-04-06 11:31:47 -07:00
management TUN-7424: Add CORS headers to host_details responses 2023-05-16 22:18:57 -07:00
metrics TUN-7147: Revert wrong removal of debug endpoint from metrics port 2023-01-31 11:51:29 +00:00
orchestration TUN-7463: Add default ingress rule if no ingress rules are provided when updating the configuration 2023-10-22 15:09:33 +02:00
overwatch AUTH-2169 make access login page more generic 2020-06-08 11:20:30 -05:00
packet ZTC-234: Replace ICMP funnels when ingress connection changes 2022-11-11 19:43:26 +00:00
proxy TUN-7477: Add UDP/TCP session metrics 2023-10-22 15:09:33 +02:00
quic TUN-7480: Added a timeout for unregisterUDP. 2023-10-22 15:09:33 +02: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
stream TUN-7057: Remove dependency github.com/gorilla/mux 2022-12-24 21:05:51 -07:00
supervisor TUN-7480: Added a timeout for unregisterUDP. 2023-10-22 15:09:33 +02:00
tlsconfig TUN-6724: Migrate to sentry-go from raven-go 2023-01-11 15:48:03 +00:00
token AUTH-4887 Add aud parameter to token transfer url 2023-04-19 21:01:24 +00:00
tracing TUN-7197: Add connIndex tag to debug messages of incoming requests 2023-02-22 16:08:24 +00:00
tunneldns TUN-7066: Bump coredns to v1.10.0 2023-01-26 09:30:08 -08:00
tunnelrpc TUN-7378: Remove RPC debug logs 2023-04-19 18:35:51 +00:00
tunnelstate TUN-6617: Dont fallback to http2 if QUIC conn was successful. 2022-08-12 08:40:03 +00:00
validation TUN-6917: Bump go to 1.19.3 2022-11-07 09:19:19 -08:00
vendor TUN-7424: Add CORS headers to host_details responses 2023-05-16 22:18:57 -07:00
watcher TUN-5551: Reintroduce FIPS compliance for linux amd64 now as separate binaries 2021-12-20 21:50:42 +00:00
websocket TUN-7057: Remove dependency github.com/gorilla/mux 2022-12-24 21:05:51 -07:00
.docker-images arm to .docker-images 2023-06-10 17:57:01 +02: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 Release 2023.4.1 2023-04-17 10:04:12 -07:00
Dockerfile Label correct container 2022-10-12 11:44:03 +01:00
Dockerfile.amd64 Label correct container 2022-10-12 11:44:03 +01:00
Dockerfile.arm Dockerfile to support arm 32bit 2023-06-10 17:27:09 +02:00
Dockerfile.arm64 Label correct container 2022-10-12 11:44:03 +01:00
LICENSE TUN-5851: Update all references to point to Apache License 2.0 2022-03-08 17:35:31 +00:00
Makefile TUN-7447: Add a cover build to report code coverage 2023-05-31 14:59:05 +01:00
README.md fix link 2022-10-12 11:46:18 +01:00
RELEASE_NOTES Release 2023.6.0 2023-10-22 15:09:33 +02: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-6590: Use Windows Teamcity agent to build binary 2022-09-21 19:34:36 +00:00
cfsetup.yaml TUN-7447: Add a cover build to report code coverage 2023-05-31 14:59:05 +01: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-7268: Default to Program Files as location for win32 2023-03-10 12:37:59 +00:00
cloudflared_man_template AUTH-2644: Change install location and add man page 2020-07-06 19:27:25 +00:00
dev.Dockerfile TUN-6917: Bump go to 1.19.3 2022-11-07 09:19:19 -08:00
fmt-check.sh TUN-6917: Bump go to 1.19.3 2022-11-07 09:19:19 -08:00
github_message.py TUN-6823: Update github release message to pull from KV 2022-10-11 15:43:06 +00:00
github_release.py TUN-7392: Ignore release checksum upload if asset already uploaded 2023-04-26 13:46:35 -07:00
go.mod TUN-7424: Add CORS headers to host_details responses 2023-05-16 22:18:57 -07:00
go.sum TUN-7424: Add CORS headers to host_details responses 2023-05-16 22:18:57 -07: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
release_pkgs.py TUN-6362: Add armhf support to cloudflare packaging 2022-06-20 12:05:03 +01: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