cloudflare/cloudflared
Publicmirrored from https://github.com/cloudflare/cloudflaredAvailable
README.md
60lines · modecode
| 1 | # Cloudflare Tunnel client |
| 2 | |
| 3 | Contains the command-line client for Cloudflare Tunnel, a tunneling daemon that proxies traffic from the Cloudflare network to your origins. |
| 4 | This daemon sits between Cloudflare network and your origin (e.g. a webserver). Cloudflare attracts client requests and sends them to you |
| 5 | via this daemon, without requiring you to poke holes on your firewall --- your origin can remain as closed as possible. |
| 6 | Extensive documentation can be found in the [Cloudflare Tunnel section](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps) of the Cloudflare Docs. |
| 7 | All usages related with proxying to your origins are available under `cloudflared tunnel help`. |
| 8 | |
| 9 | You can also use `cloudflared` to access Tunnel origins (that are protected with `cloudflared tunnel`) for TCP traffic |
| 10 | at Layer 4 (i.e., not HTTP/websocket), which is relevant for use cases such as SSH, RDP, etc. |
| 11 | Such usages are available under `cloudflared access help`. |
| 12 | |
| 13 | You can instead use [WARP client](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/private-networks) |
| 14 | to access private origins behind Tunnels for Layer 4 traffic without requiring `cloudflared access` commands on the client side. |
| 15 | |
| 16 | |
| 17 | ## Before you get started |
| 18 | |
| 19 | Before you use Cloudflare Tunnel, you'll need to complete a few steps in the Cloudflare dashboard: you need to add a |
| 20 | website to your Cloudflare account. Note that today it is possible to use Tunnel without a website (e.g. for private |
| 21 | routing), but for legacy reasons this requirement is still necessary: |
| 22 | 1. [Add a website to Cloudflare](https://support.cloudflare.com/hc/en-us/articles/201720164-Creating-a-Cloudflare-account-and-adding-a-website) |
| 23 | 2. [Change your domain nameservers to Cloudflare](https://support.cloudflare.com/hc/en-us/articles/205195708) |
| 24 | |
| 25 | |
| 26 | ## Installing `cloudflared` |
| 27 | |
| 28 | 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. |
| 29 | |
| 30 | * You can [install on macOS](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation#macos) via Homebrew or by downloading the [latest Darwin amd64 release](https://github.com/cloudflare/cloudflared/releases) |
| 31 | * Binaries, Debian, and RPM packages for Linux [can be found here](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation#linux) |
| 32 | * A Docker image of `cloudflared` is [available on DockerHub](https://hub.docker.com/r/cloudflare/cloudflared) |
| 33 | * You can install on Windows machines with the [steps here](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation#windows) |
| 34 | |
| 35 | User documentation for Cloudflare Tunnel can be found at https://developers.cloudflare.com/cloudflare-one/connections/connect-apps |
| 36 | |
| 37 | |
| 38 | ## Creating Tunnels and routing traffic |
| 39 | |
| 40 | Once installed, you can authenticate `cloudflared` into your Cloudflare account and begin creating Tunnels to serve traffic to your origins. |
| 41 | |
| 42 | * Create a Tunnel with [these instructions](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/create-tunnel) |
| 43 | * Route traffic to that Tunnel: |
| 44 | * Via public [DNS records in Cloudflare](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/routing-to-tunnel/dns) |
| 45 | * Or via a public hostname guided by a [Cloudflare Load Balancer](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/routing-to-tunnel/lb) |
| 46 | * Or from [WARP client private traffic](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/private-networks) |
| 47 | |
| 48 | |
| 49 | ## TryCloudflare |
| 50 | |
| 51 | Want to test Cloudflare Tunnel before adding a website to Cloudflare? You can do so with TryCloudflare using the documentation [available here](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/run-tunnel/trycloudflare). |
| 52 | |
| 53 | ## Deprecated versions |
| 54 | |
| 55 | 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](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation#updating-cloudflared). |
| 56 | |
| 57 | | Version(s) | Deprecation status | |
| 58 | |---|---| |
| 59 | | 2020.5.1 and later | Supported | |
| 60 | | Versions prior to 2020.5.1 | No longer supported | |
| 61 | |