Skip to content

Commit

Permalink
Document the new --use-local-ssh-agent flag for tsh
Browse files Browse the repository at this point in the history
The flag is used to bypass the local SSH agent even when it's running.
Specifically, this helps with agents that don't support certs.

The flag was added in #3721

Updates #3169
  • Loading branch information
Andrew Lytvynov authored and awly committed May 20, 2020
1 parent 186f973 commit cfd914f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/4.3/admin-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1266,11 +1266,14 @@ $ tsh login --proxy=proxy.example.com joe
$ ssh-add -L
```

!!! warning "GNOME Keyring SSH Agent"

It is well-known that Gnome Keyring SSH
agent, used by many popular Linux desktops like Ubuntu, does not support SSH
certificates. We recommend using the `ssh-agent` command from `openssh-client` package.
!!! warning "GNOME Keyring SSH Agent and GPG Agent"

It is well-known that Gnome Keyring SSH agent, used by many popular Linux
desktops like Ubuntu, and gpg-agent from GnuPG do not support SSH
certificates. We recommend using the `ssh-agent` from OpenSSH.
Alternatively, you can disable SSH agent integration entirely using
`--no-use-local-ssh-agent` flag or `TELEPORT_USE_LOCAL_SSH_AGENT=false`
environment variable with `tsh`.

### OpenSSH Rate Limiting

Expand Down
4 changes: 4 additions & 0 deletions docs/4.3/user-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ $ ssh-add -L
SSH agent can be used to feed the certificate to other SSH clients, for example
to OpenSSH `ssh`.

If you wish to disable SSH agent integration, pass `--no-use-local-ssh-agent`
to `tsh`. You can also set the `TELEPORT_USE_LOCAL_SSH_AGENT` environment
variable to `false` in your shell profile to make this permanent.

### Identity Files

[`tsh login`](cli-docs.md#tsh-login) can also save the user certificate into a
Expand Down

0 comments on commit cfd914f

Please sign in to comment.