forked from gravitational/teleport
-
Notifications
You must be signed in to change notification settings - Fork 0
/
usage.go
46 lines (33 loc) · 1.42 KB
/
usage.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main
const (
GlobalHelpString = "CLI Admin tool for the Teleport Auth service. Runs on a host where Teleport Auth is running."
AddUserHelp = `Notes:
1. tctl will generate a signup token and give you a URL to share with a user.
He will have to configure the mandatory 2nd facto auth and select a password.
2. A Teleport user account is not the same as a local UNIX users on SSH nodes.
You must assign a list of allowed local users for every Teleport login.
Examples:
> tctl users add joe admin,nginx
This creates a Teleport identity 'joe' who can login as 'admin' or 'nginx'
to any SSH node connected to this auth server.
> tctl users add joe
If the list of local users is not given, 'joe' will only be able to connect
as 'joe' to SSH nodes.
`
AddNodeHelp = `Notes:
This command generates and prints an invitation token another node can use to
join the cluster.
Examples:
> tctl nodes add
Generates a token when can be used to add a regular SSH node to the cluster.
The token genrated single-use token will be valid for 30 minutes.
> tctl nodes add --roles=node,proxy --ttl=1h
Generates a token when can be used to add an SSH node to the cluster which
will also be a proxy node. This token can be used multiple times within an
hour.
`
ListNodesHelp = `Notes:
SSH nodes send periodic heartbeat to the Auth service. This command prints
the list of current online nodes.
`
)