Skip to content

Commit 8e039f3

Browse files
committed
Improve docs for base command
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent cd2d9b3 commit 8e039f3

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

cmd/inletsctl.go

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,20 @@ var inletsCmd = &cobra.Command{
3333
Use: "inletsctl",
3434
Short: "Create exit nodes for use with inlets.",
3535
Long: `
36-
inletsctl automates the task of creating an exit-node on cloud infrastructure.
37-
Once provisioned, you'll receive a command to connect with. You can use this
38-
tool whether you want to use inlets or inlets-pro for L4 TCP.
36+
Use inletsctl to create a VM (aka exit-node) with the inlets-server
37+
preinstalled on cloud infrastructure. Once provisioned, you'll receive a
38+
connection string for the inlets-pro client.
3939
40-
See also: inlets-operator which does the same job, but for Kubernetes services.
40+
For HTTPS tunnels (L7):
41+
The tunnel server will terminate TLS for you, just include the
42+
--letsencrypt-domain flag for each domain you want to expose via the exit-node.
43+
44+
For TCP tunnels (L4):
45+
Use the --tcp flag to create a TCP tunnel via inletsctl create. This is
46+
best suited to SSH, TLS, reverse proxies, databases, etc.
47+
48+
See also: inlets-operator which automates L4 TCP tunnels for any
49+
Kubernetes LoadBalancer services found in a cluster.
4150
`,
4251
Run: runInlets,
4352
SilenceErrors: true,

0 commit comments

Comments
 (0)