curben
/
cloudflared-mirror
mirror of https://github.com/cloudflare/cloudflared.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

TUN-5918: Clean up text in cloudflared tunnel --help

This commit is contained in:
Nuno Diegues 2022-03-22 11:22:18 +00:00
parent e2a8302bbc
commit 470e6c35c5
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
cmd/cloudflared/tunnel/cmd.go
View File

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