Go to file
Nuno Diegues f985ed567f TUN-5128: Enforce maximum grace period
This maximum grace period will be honored by Cloudflare edge such that
either side will close the connection after unregistration at most
by this time (3min as of this commit):
 - If the connection is unused, it is already closed as soon as possible.
 - If the connection is still used, it is closed on the cloudflared configured grace-period.

Even if cloudflared does not close the connection by the grace-period time,
the edge will do so.
2021-09-21 16:48:37 +00:00
.github/workflows TUN-5012: Use patched go-sumtype 2021-08-30 10:10:25 +01: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 AUTH-3103 CI build fixes 2020-09-18 19:33:30 +00:00
carrier TUN-4168: Transparently proxy websocket connections using stdlib HTTP client instead of gorilla/websocket; move websocket client code into carrier package since it's only used by access subcommands now (#345). 2021-04-07 16:25:46 +00:00
certutil TUN-2943: Copy certutil from edge into cloudflared 2020-05-04 17:37:29 -05:00
cmd/cloudflared TUN-5128: Enforce maximum grace period 2021-09-21 16:48:37 +00:00
component-tests TUN-5000: De-flake logging to dir component test in Windows by increasing to buffer to cope with more logging 2021-08-27 18:13:45 +00:00
config TUN-4359: Warn about unused keys in 'tunnel ingress validate' 2021-05-13 02:05:19 +01:00
connection TUN-5128: Enforce maximum grace period 2021-09-21 16:48:37 +00:00
edgediscovery TUN-5011: Use the region parameter in fallback SRV lookup 2021-08-31 22:16:21 -05:00
fips TUN-3905: Cannot run go mod vendor in cloudflared due to fips 2021-03-09 17:31:59 +04:00
h2mux TUN-4456: Replaced instances of Tick() with Ticker() in h2mux paths 2021-05-25 18:07:06 +01:00
hello TUN-3890: Code coverage for cloudflared in CI 2021-02-09 13:16:00 -06:00
ingress TUN-4701: Split Proxy into ProxyHTTP and ProxyTCP 2021-07-19 13:43:59 +00: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-4821: Make quick tunnels the default in cloudflared 2021-08-26 15:53:02 +00:00
origin TUN-5118: Quic connection now detects duplicate connections similar to http2 2021-09-21 06:30:09 +00:00
overwatch AUTH-2169 make access login page more generic 2020-06-08 11:20:30 -05:00
quic TUN-4613: Add a no-op protocol version slot 2021-08-24 15:21:26 +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 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
ssh_server_tests TUN-4795: Remove Equinox releases 2021-08-05 08:24:36 +00:00
sshgen Setup a Github action for checking the cloudflared build 2021-05-04 14:31:22 +01:00
teamnet TUN-3809: Allow routes ip show to output as JSON or YAML 2021-02-23 14:19:47 +00:00
tlsconfig TUN-3983: Renew CA certs in cloudflared 2021-03-01 16:30:28 +00:00
token AUTH-3475: Updated GetAppInfo error message 2021-06-25 10:37:48 -05:00
tunneldns TUN-4063: Cleanup dependencies between packages. 2021-03-09 14:02:59 +00:00
tunnelrpc 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
tunnelstore TUN-4847: Allow to list tunnels by prefix name or exclusion prefix name 2021-07-30 12:00:26 +01:00
validation 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
vendor TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
watcher Setup a Github action for checking the cloudflared build 2021-05-04 14:31:22 +01:00
websocket TUN-4168: Transparently proxy websocket connections using stdlib HTTP client instead of gorilla/websocket; move websocket client code into carrier package since it's only used by access subcommands now (#345). 2021-04-07 16:25:46 +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-4761: Added a build-all-packages target to cfsetup 2021-07-22 16:36:49 +01:00
CHANGES.md TUN-4821: Make quick tunnels the default in cloudflared 2021-08-26 15:53:02 +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-595: Add License/Readme files to cloudflared 2018-05-03 02:17:07 -05:00
Makefile Merge pull request #436 from Mongey/cm-arm-darwin 2021-09-13 10:54:42 -05:00
README.md Fix TryCloudflare link 2021-09-15 16:41:18 +05:30
RELEASE_NOTES Release 2021.9.1 2021-09-21 08:13:07 +01:00
build-packages.sh TUN-4875: Added amd64-linux builds back to releases 2021-08-04 08:18:43 +01:00
cfsetup.yaml TUN-5003: Fix cfsetup for non-FIPS golang version 2021-08-27 19:14:22 +01: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-4357: Bump Go to 1.16 2021-05-13 02:05:18 +01: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 TUN-4772: Release built executables with packages 2021-07-30 13:56:19 +00:00
go.mod TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
go.sum TUN-5129: Use go 1.17 and copy .git folder to docker build to compute version 2021-09-21 15:50:35 +00:00
jet.yaml TRAFFIC-448: build cloudflare for junos and publish to s3 2020-09-24 19:23:53 +04: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

Argo Tunnel client

Contains the command-line client for Argo Tunnel, a tunneling daemon that proxies any local webserver through the Cloudflare network. Extensive documentation can be found in the Argo Tunnel section of the Cloudflare Docs.

Before you get started

Before you use Argo Tunnel, you'll need to complete a few steps in the Cloudflare dashboard. The website you add to Cloudflare will be used to route traffic to your Tunnel.

  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 Argo 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 that serve traffic for hostnames in your account.

TryCloudflare

Want to test Argo 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