diff --git a/docs/pages/connect-your-client/teleport-connect.mdx b/docs/pages/connect-your-client/teleport-connect.mdx index 1dab2a72611cf..3f1dfc0a65512 100644 --- a/docs/pages/connect-your-client/teleport-connect.mdx +++ b/docs/pages/connect-your-client/teleport-connect.mdx @@ -160,6 +160,13 @@ The top bar of Teleport Connect consists of: The **status bar** at the bottom displays **cluster breadcrumbs** in the bottom left, indicating which cluster the current tab is bound to, and the **Share Feedback** button in the bottom right. +### Background mode +Teleport Connect can run in the background (via the menu bar or system tray), +so you can continue using VNet and connections to databases, Kubernetes clusters, +and apps without keeping the main window open. + +See [the `runInBackground` configuration option](#configuration). + ## Connecting to an SSH server 1. Open a tab with cluster resources by clicking on the plus symbol at the right end of the tab bar. @@ -591,6 +598,7 @@ Below is the list of the supported config properties. |-------------------------------|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| | `theme` | `system` | Color theme for the app. Available modes: `light`, `dark`, `system`. | | `skipVersionCheck` | `false` | Skips the version check and hides the version compatibility warning when logging in to a cluster. | +| `runInBackground` | `true` on macOS/Windows, `false` on Linux | Keeps the app running in the menu bar/system tray even when the main window is closed. On Linux, displaying the system tray icon may require installing shell extensions. | | `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. | | `terminal.windowsBackend` | `auto` | `auto` uses modern [ConPTY](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/) system if available, which requires Windows 10 (19H1) or above. Set to `winpty` to use winpty even if ConPTY is available. |