Skip to content

Commit 470e6c3

Browse files
committed
TUN-5918: Clean up text in cloudflared tunnel --help
1 parent e2a8302 commit 470e6c3

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

cmd/cloudflared/tunnel/cmd.go

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -127,26 +127,34 @@ func buildTunnelCommand(subcommands []*cli.Command) *cli.Command {
127127
Name: "tunnel",
128128
Action: cliutil.ConfiguredAction(TunnelCommand),
129129
Category: "Tunnel",
130-
Usage: "Make a locally-running web service accessible over the internet using Cloudflare Tunnel.",
130+
Usage: "Use Cloudflare Tunnel to expose private services to the Internet or to Cloudflare connected private users.",
131131
ArgsUsage: " ",
132-
Description: `Cloudflare Tunnel asks you to specify a hostname on a Cloudflare-powered
133-
domain you control and a local address. Traffic from that hostname is routed
134-
(optionally via a Cloudflare Load Balancer) to this machine and appears on the
135-
specified port where it can be served.
132+
Description: ` Cloudflare Tunnel allows to expose private services without opening any ingress port on this machine. It can expose:
133+
A) Locally reachable HTTP-based private services to the Internet on DNS with Cloudflare as authority (which you can
134+
then protect with Cloudflare Access).
135+
B) Locally reachable TCP/UDP-based private services to Cloudflare connected private users in the same account, e.g.,
136+
those enrolled to a Zero Trust WARP Client.
136137
137-
This feature requires your Cloudflare account be subscribed to the Cloudflare Smart Routing feature.
138+
You can manage your Tunnels via dash.teams.cloudflare.com. This approach will only require you to run a single command
139+
later in each machine where you wish to run a Tunnel.
138140
139-
To use, begin by calling login to download a certificate:
141+
Alternatively, you can manage your Tunnels via the command line. Begin by obtaining a certificate to be able to do so:
140142
141-
$ cloudflared tunnel login
143+
$ cloudflared tunnel login
142144
143-
With your certificate installed you can then launch your first tunnel,
144-
replacing my.site.com with a subdomain of your site:
145+
With your certificate installed you can then get started with Tunnels:
145146
146-
$ cloudflared tunnel --hostname my.site.com --url http://localhost:8080
147+
$ cloudflared tunnel create my-first-tunnel
148+
$ cloudflared tunnel route dns my-first-tunnel my-first-tunnel.mydomain.com
149+
$ cloudflared tunnel run --hello-world my-first-tunnel
147150
148-
If you have a web server running on port 8080 (in this example), it will be available on
149-
the internet!`,
151+
You can now access my-first-tunnel.mydomain.com and be served an example page by your local cloudflared process.
152+
153+
For exposing local TCP/UDP services by IP to your privately connected users, check out:
154+
155+
$ cloudflared tunnel route ip --help
156+
157+
See https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/ for more info.`,
150158
Subcommands: subcommands,
151159
Flags: tunnelFlags(false),
152160
}

0 commit comments

Comments
 (0)