41dffd7f3c
Corrects the pattern of using errgroup's and context cancellation to simplify the logic for canceling extra routines for the QUIC connection. This is because the extra context cancellation is redundant with the fact that the errgroup also cancels it's own provided context when a routine returns (error or not). For the datagram handler specifically, since it can respond faster to a context cancellation from the QUIC connection, we wrap the error before surfacing it outside of the QUIC connection scope to the supervisor. Additionally, the supervisor will look for this error type to check if it should retry the QUIC connection. These two operations are required because the supervisor does not look for a context canceled error when deciding to retry a connection. If a context canceled from the datagram handler were to be returned up to the supervisor on the initial connection, the cloudflared application would exit. We want to ensure that cloudflared maintains connection attempts even if any of the services on-top of a QUIC connection fail (datagram handler in this case). Additional logging is also introduced along these paths to help with understanding the error conditions from the specific handlers on-top of a QUIC connection. Related CUSTESC-53681 Closes TUN-9610 |
||
|---|---|---|
| .github | ||
| .mac_resources | ||
| .teamcity | ||
| carrier | ||
| cfapi | ||
| cfio | ||
| client | ||
| cmd/cloudflared | ||
| component-tests | ||
| config | ||
| connection | ||
| credentials | ||
| datagramsession | ||
| diagnostic | ||
| edgediscovery | ||
| features | ||
| fips | ||
| flow | ||
| hello | ||
| ingress | ||
| internal/test | ||
| ipaccess | ||
| logger | ||
| management | ||
| metrics | ||
| mocks | ||
| orchestration | ||
| overwatch | ||
| packet | ||
| proxy | ||
| quic | ||
| retry | ||
| signal | ||
| socks | ||
| sshgen | ||
| stream | ||
| supervisor | ||
| tlsconfig | ||
| token | ||
| tracing | ||
| tunneldns | ||
| tunnelrpc | ||
| tunnelstate | ||
| validation | ||
| vendor | ||
| watcher | ||
| websocket | ||
| .docker-images | ||
| .dockerignore | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .golangci.yaml | ||
| CHANGES.md | ||
| Dockerfile | ||
| Dockerfile.amd64 | ||
| Dockerfile.arm64 | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| RELEASE_NOTES | ||
| build-packages-fips.sh | ||
| build-packages.sh | ||
| catalog-info.yaml | ||
| cfsetup.yaml | ||
| check-fips.sh | ||
| cloudflared.wxs | ||
| cloudflared_man_template | ||
| fmt-check.sh | ||
| github_message.py | ||
| github_release.py | ||
| go.mod | ||
| go.sum | ||
| postinst.sh | ||
| postrm.sh | ||
| release_pkgs.py | ||
| wix.json | ||
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:
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
cloudflaredis available on DockerHub - You can install on Windows machines with the steps here
- To build from source, install the required version of go, mentioned in the Development section below. Then you can run
make cloudflared.
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.
- Create a Tunnel with these instructions
- Route traffic to that Tunnel:
- Via public DNS records in Cloudflare
- Or via a public hostname guided by a Cloudflare Load Balancer
- Or from WARP client private traffic
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 that are within one year of the most recent release. Breaking changes unrelated to feature availability may be introduced that will impact versions released more than one year ago. You can read more about upgrading cloudflared in our developer documentation.
For example, as of January 2023 Cloudflare will support cloudflared version 2023.1.1 to cloudflared 2022.1.1.
Development
Requirements
- GNU Make
- capnp
- go >= 1.24
- Optional tools:
Build
To build cloudflared locally run make cloudflared
Test
To locally run the tests run make test
Linting
To format the code and keep a good code quality use make fmt and make lint
Mocks
After changes on interfaces you might need to regenerate the mocks, so run make mock