|
1 | 1 | # Argo Tunnel client |
2 | 2 |
|
3 | | -Contains the command-line client and its libraries for Argo Tunnel, a tunneling daemon that proxies any local webserver through the Cloudflare network. |
| 3 | +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](https://developers.cloudflare.com/argo-tunnel/) of the Cloudflare Docs. |
4 | 4 |
|
5 | | -## Getting started |
| 5 | +## Before you get started |
6 | 6 |
|
7 | | - go install github.com/cloudflare/cloudflared/cmd/cloudflared |
| 7 | +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. |
| 8 | + |
| 9 | +1. [Add a website to Cloudflare](https://support.cloudflare.com/hc/en-us/articles/201720164-Creating-a-Cloudflare-account-and-adding-a-website) |
| 10 | +2. [Change your domain nameservers to Cloudflare](https://support.cloudflare.com/hc/en-us/articles/205195708) |
| 11 | + |
| 12 | +## Installing `cloudflared` |
| 13 | + |
| 14 | +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. |
| 15 | + |
| 16 | +* You can [install on macOS](https://developers.cloudflare.com/argo-tunnel/getting-started/installation#macos) via Homebrew or by downloading the [latest Darwin amd64 release](https://github.com/cloudflare/cloudflared/releases) |
| 17 | +* Binaries, Debian, and RPM packages for Linux [can be found here](https://developers.cloudflare.com/argo-tunnel/getting-started/installation#linux) |
| 18 | +* A Docker image of `cloudflared` is [available on DockerHub](https://hub.docker.com/r/cloudflare/cloudflared) |
| 19 | +* You can install on Windows machines with the [steps here](https://developers.cloudflare.com/argo-tunnel/getting-started/installation#windows) |
8 | 20 |
|
9 | 21 | User documentation for Argo Tunnel can be found at https://developers.cloudflare.com/argo-tunnel/ |
| 22 | + |
| 23 | +## Creating Tunnels and routing traffic |
| 24 | + |
| 25 | +Once installed, you can authenticate `cloudflared` into your Cloudflare account and begin creating Tunnels that serve traffic for hostnames in your account. |
| 26 | + |
| 27 | +* Create a Tunnel with [these instructions](https://developers.cloudflare.com/argo-tunnel/create-tunnel) |
| 28 | +* Route traffic to that Tunnel with [DNS records in Cloudflare](https://developers.cloudflare.com/argo-tunnel/routing-to-tunnel/dns) or with a [Cloudflare Load Balancer](https://developers.cloudflare.com/argo-tunnel/routing-to-tunnel/lb) |
| 29 | + |
| 30 | +## TryCloudflare |
| 31 | + |
| 32 | +Want to test Argo Tunnel before adding a website to Cloudflare? You can do so with TryCloudflare using the documentation [available here](https://developers.cloudflare.com/argo-tunnel/learning/trycloudflare). |
0 commit comments