f985ed567f
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. |
||
---|---|---|
.github/workflows | ||
.mac_resources | ||
.teamcity | ||
carrier | ||
certutil | ||
cmd/cloudflared | ||
component-tests | ||
config | ||
connection | ||
edgediscovery | ||
fips | ||
h2mux | ||
hello | ||
ingress | ||
ipaccess | ||
logger | ||
metrics | ||
origin | ||
overwatch | ||
quic | ||
retry | ||
signal | ||
socks | ||
ssh_server_tests | ||
sshgen | ||
teamnet | ||
tlsconfig | ||
token | ||
tunneldns | ||
tunnelrpc | ||
tunnelstore | ||
validation | ||
vendor | ||
watcher | ||
websocket | ||
.docker-images | ||
.dockerignore | ||
.gitignore | ||
CHANGES.md | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
RELEASE_NOTES | ||
build-packages.sh | ||
cfsetup.yaml | ||
cloudflared.wxs | ||
cloudflared_man_template | ||
dev.Dockerfile | ||
fmt-check.sh | ||
github_message.py | ||
github_release.py | ||
go.mod | ||
go.sum | ||
jet.yaml | ||
postinst.sh | ||
postrm.sh | ||
wix.json |
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.
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.
- You can install on macOS via Homebrew or by downloading the latest Darwin amd64 release
- Binaries, Debian, and RPM packages for Linux can be found here
- A Docker image of
cloudflared
is available on DockerHub - You can install on Windows machines with the steps here
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.
- Create a Tunnel with these instructions
- Route traffic to that Tunnel with DNS records in Cloudflare or with a Cloudflare Load Balancer
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 |