Skip to content

Commit

Permalink
Add shell switcher docs (#46470)
Browse files Browse the repository at this point in the history
* Add shell switcher docs

* Replace `PATH/Path` env var with more general `PATH`

* Use ImageOptim to reduce image size by half

* Rename screenshot

* `session` -> `tab`

* `Terminal` -> `terminal`

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
  • Loading branch information
gzdunek and ravicious authored Sep 11, 2024
1 parent 6ca412f commit 052e411
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 13 additions & 1 deletion docs/pages/connect-your-client/teleport-connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,25 @@ actions menu or press `` Ctrl+Shift+` ``.

Any tsh command executed within the tab targets the current cluster. Teleport Connect accomplishes
this by setting the environment variables `TELEPORT_PROXY` and `TELEPORT_CLUSTER` for the session.
Additionally, Teleport Connect prepends the `PATH`/`Path` environment variable in the session with the
Additionally, Teleport Connect prepends the `PATH` environment variable in the session with the
directory containing the tsh binary, even if [tsh is not globally available](#using-tsh-outside-of-teleport-connect).

When using [trusted clusters](../admin-guides/management/admin/trustedclusters.mdx), the cluster selector allows
you to determine which cluster the shell session will be bound to. The selected cluster will be
reflected in both the tab title and the status bar.

### Changing the terminal shell

By default, Teleport Connect launches the user shell on macOS/Linux and PowerShell on Windows.
To switch to a different shell, right-click on a terminal tab (either a local terminal or a Kubernetes session).
From the menu, choose a predefined shell (on Windows) or provide the path to a custom shell.

The selected shell will be used only for that tab unless you choose to set it as the default.
![Changing the terminal shell in Teleport Connect on Windows](../../img/use-teleport/connect-shell-switcher@2x.png)

The configuration is stored under `terminal.shell` and `terminal.customShell` config properties.
For more details, refer to the [Configuration](#configuration) section.

## Connecting to a Kubernetes cluster

1. Open a tab with cluster resources by clicking on the plus symbol at the right end of the tab bar.
Expand Down

0 comments on commit 052e411

Please sign in to comment.