Skip to content

Commit

Permalink
docs: improved
Browse files Browse the repository at this point in the history
  • Loading branch information
inertial-frame committed May 21, 2021
1 parent 71397f0 commit 2308914
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/pages/architecture/users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Let's look at this table:

| Teleport User | Allowed OS Logins | Description |
| - | - | - |
| joe | joe, root | Teleport user 'joe' can log in into member nodes as OS user 'joe' or 'root' |
| juliet | juliet | Teleport user 'juliet' can log in into member nodes only as OS user 'juliet' |
| ross | | If no OS login is specified, it defaults to the same name as the Teleport user, here this is "ross". |
| joe | joe, root | Teleport user `joe` can log in into member nodes as OS user `joe` or `root`. |
| juliet | juliet | Teleport user `juliet` can log in into member nodes only as OS user `juliet`. |
| ross | | If no OS login is specified, it defaults to the same name as the Teleport user, here this is `ross`. |

To add a new user to Teleport, you have to use the `tctl` tool on the same node
where the auth server is running, i.e. `teleport` was started with
Expand Down
10 changes: 5 additions & 5 deletions docs/pages/trustedclusters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The user
experience looks like this:

```bash
# login using the root "root" cluster credentials:
# Log in using the root "root" cluster credentials:
tsh login --proxy=root.example.com

# SSH into some host inside the "root" cluster:
Expand Down Expand Up @@ -146,15 +146,15 @@ Consider the security implications when deciding which token method to use. Shor
### Dynamic Join Tokens
Creating a token dynamically with a CLI tool offers the advantage of applying a *time to live* (TTL) interval on it, i.e. it will be impossible to re-use such token after a specified time.
Creating a token dynamically with a CLI tool offers the advantage of applying a time-to-live (TTL) interval on it, i.e. it will be impossible to re-use such token after a specified time.
To create a token using the CLI tool, execute this command on the *auth server*
of cluster "root":
```bash
# Generates a trusted cluster token to allow an inbound connection from a leaf cluster:
sudo tctl tokens add --type=trusted_cluster --ttl=5m
# Example output
# Example output:
# The cluster invite token: ba4825847f0378bcdfe18113c4998498
# This token will expire in 5 minutes

Expand Down Expand Up @@ -319,7 +319,7 @@ map user roles from one cluster to another, you can even capture parts of the re
role name and use reference it to name the local role:

```yaml
# in this example, remote users with a remote role called 'remote-one' will be
# In this example, remote users with a remote role called 'remote-one' will be
# mapped to a local role called 'local-one', and `remote-two` becomes `local-two`, etc:
- remote: "^remote-(.*)$"
local: [local-$1]
Expand Down Expand Up @@ -566,7 +566,7 @@ servers on both clusters. Usually, this can be done by adding `--debug` flag to
file for both auth servers:

```yaml
# snippet from /etc/teleport.yaml
# Snippet from /etc/teleport.yaml
teleport:
log:
output: stderr
Expand Down

0 comments on commit 2308914

Please sign in to comment.