diff --git a/docs/img/use-teleport/connect-cluster.png b/docs/img/use-teleport/connect-cluster.png index 8a4e4f58efc17..ad0fb1af9c0d3 100644 Binary files a/docs/img/use-teleport/connect-cluster.png and b/docs/img/use-teleport/connect-cluster.png differ diff --git a/docs/img/use-teleport/connect-ui-overview.png b/docs/img/use-teleport/connect-ui-overview.png index 6abdcb85e5711..24e9430c5cd16 100644 Binary files a/docs/img/use-teleport/connect-ui-overview.png and b/docs/img/use-teleport/connect-ui-overview.png differ diff --git a/docs/pages/connect-your-client/teleport-connect.mdx b/docs/pages/connect-your-client/teleport-connect.mdx index 1a4bf46514c68..8e7f397eaac72 100644 --- a/docs/pages/connect-your-client/teleport-connect.mdx +++ b/docs/pages/connect-your-client/teleport-connect.mdx @@ -54,10 +54,12 @@ The top bar of Teleport Connect consists of: Teleport clusters as well as log in or out of the clusters. - The **connection list** (the top left) showing recent connections, allowing you to seamlessly switch between them. -- The **command bar** (in the middle), which launches any command you input in a new terminal tab. -- The **cluster selector** (to the left of the command bar), which shows up only if you have set up +- The **search bar** (in the middle), which allows you to search for resources across clusters. +- The **cluster selector** (to the left of the search bar), which shows up only if you have set up Trusted Clusters and there are leaf clusters connected to the root cluster. It lets you browse - leaf cluster resources. It also changes which cluster the commands in the command bar are going to target. + leaf cluster resources. Also, the "Open new terminal" action will bind new terminal tabs to the selected cluster. +- The **additional actions menu** (to the left of the profile selector), containing options such as + opening a config file or creating an access request in an Enterprise cluster. ## Connecting to an SSH server @@ -67,8 +69,7 @@ The top bar of Teleport Connect consists of: 3. Select or enter the SSH user you wish to log in as and press `Enter`. 4. A new tab will open with a shell session on the chosen server. -Alternatively, you can type `tsh ssh` into the command bar in the Teleport Connect window, and the autocompletion will help -you connect to a server. +Alternatively, you can look for the server in the search bar and press `Enter` to connect to it. ## Connecting to a Kubernetes cluster @@ -81,6 +82,8 @@ you connect to a server. the `$KUBECONFIG` environment variable (`kubectl`, `helm`, etc.) will work without additional configuration. To identify the path to this config for use in other tools, run `echo $KUBECONFIG`. +Alternatively, you can look for the cluster in the search bar and press `Enter` to connect to it. + ## Connecting to a database 1. Open a tab with cluster resources by clicking on the plus symbol at the end of the tab bar. You @@ -90,6 +93,8 @@ you connect to a server. 4. Select or enter the database user you with to use and press `Enter`. 5. A new tab will open with a new connection established between your device and the database server. +Alternatively, you can look for the database in the search bar and press `Enter` to connect to it. + This connection will remain active until you click the Close Connection button or close Teleport Connect. The port number will persist between app restarts—you can set up your favorite client without worrying about the port suddenly changing. @@ -141,8 +146,8 @@ through tsh will not make that cluster show up in Teleport Connect. -To add tsh to `PATH`, execute `tsh install` from the command bar in Teleport Connect. This will -symlink tsh to `/usr/local/bin`. You can remove the symlink with `tsh uninstall`. +To add tsh to `PATH`, open the additional actions menu and select "Install tsh in PATH". This will +symlink tsh to `/usr/local/bin`. You can remove the symlink by selecting "Remove tsh from PATH". If you used the tsh macOS .pkg installer before, this will overwrite the symlink made by that installer. @@ -160,7 +165,7 @@ installation directory to the `Path` user environment variable. ## Configuration Teleport Connect can be configured by editing the `app_config.json` file, which it creates on first launch. -To open it, click the More Options icon `⋮` -> Open Config File. +To open the config file, select "Open config file" from the additional actions menu. The file will open in your default editor. `Ctrl+1` - `Ctrl+9` on Windows
`Alt+1` - `Alt+9` on Linux | Shortcut to open tab 1–9. | | `keymap.closeTab` | `Command+W` on macOS
`Ctrl+W` on Windows/Linux | Shortcut to close a tab. | | `keymap.newTab` | `Command+T` on macOS
`Ctrl+T` on Windows/Linux | Shortcut to open a new tab. | +| `keymap.newTerminalTab` | `Shift+Command+T` on macOS
`Ctrl+Shift+T` on Windows/Linux | Shortcut to open a new terminal tab. | | `keymap.previousTab` | `Shift+Command+Tab` on macOS
`Ctrl+Shift+Tab` on Windows/Linux | Shortcut to go to the previous tab. | | `keymap.nextTab` | `Command+Tab` on macOS
`Ctrl+Tab` on Windows/Linux | Shortcut to go to the next tab. | | `keymap.openConnections` | `Command+P` on macOS
`Ctrl+P` on Windows/Linux | Shortcut to open the connection list. | | `keymap.openClusters` | `Command+E` on macOS
`Ctrl+E` on Windows/Linux | Shortcut to open the cluster selector. | | `keymap.openProfiles` | `Command+I` on macOS
`Ctrl+I` on Windows/Linux | Shortcut to open the profile selector. | -| `keymap.openCommandBar` | `Command+K` on macOS
`Ctrl+K` on Windows/Linux | Shortcut to open the command bar. | +| `keymap.openSearchBar` | `Command+K` on macOS
`Ctrl+K` on Windows/Linux | Shortcut to open the search bar. | | `terminal.fontFamily` | `Menlo, Monaco, monospace` on macOS
`Consolas, monospace` on Windows
`'Droid Sans Mono', monospace` on Linux | Font family for the terminal. | | `terminal.fontSize` | 15 | Font size for the terminal. | @@ -330,7 +336,7 @@ To remove the local user data directory: ```code $ rm -rf ~/Library/Application\ Support/Teleport\ Connect -``` +``` diff --git a/web/packages/teleterm/src/ui/TopBar/MoreOptions.tsx b/web/packages/teleterm/src/ui/TopBar/AdditionalActions.tsx similarity index 98% rename from web/packages/teleterm/src/ui/TopBar/MoreOptions.tsx rename to web/packages/teleterm/src/ui/TopBar/AdditionalActions.tsx index 7bc7e318c1aa7..72f6f2e46fd1d 100644 --- a/web/packages/teleterm/src/ui/TopBar/MoreOptions.tsx +++ b/web/packages/teleterm/src/ui/TopBar/AdditionalActions.tsx @@ -137,7 +137,7 @@ function getActiveRootCluster(ctx: IAppContext): Cluster | undefined { return ctx.clustersService.findCluster(clusterUri); } -export function MoreOptions() { +export function AdditionalActions() { const [isPopoverOpened, setIsPopoverOpened] = useState(false); const selectorRef = useRef(); @@ -155,7 +155,7 @@ export function MoreOptions() { setIsPopoverOpened(true)} > diff --git a/web/packages/teleterm/src/ui/TopBar/TopBar.tsx b/web/packages/teleterm/src/ui/TopBar/TopBar.tsx index 8bd66ea77ab16..e61ec37bb7609 100644 --- a/web/packages/teleterm/src/ui/TopBar/TopBar.tsx +++ b/web/packages/teleterm/src/ui/TopBar/TopBar.tsx @@ -25,7 +25,7 @@ import { useAppContext } from '../appContextProvider'; import { Connections } from './Connections'; import { Clusters } from './Clusters'; import { Identity } from './Identity'; -import { MoreOptions } from './MoreOptions'; +import { AdditionalActions } from './AdditionalActions'; export function TopBar() { const { configService } = useAppContext(); @@ -41,7 +41,7 @@ export function TopBar() { {isSearchBarEnabled ? : } - +