gravitational/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport.git synced 2026-10-12 02:15:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for running Connect in background (#58858)

Browse Source 
* Add docs for running Connect in background

* Review fixes

* Review fixes
This commit is contained in:
Grzegorz Zdunek
2025-09-09 09:48:12 +00:00
committed by GitHub
parent 07ee5ba23c
commit 575c42fbcf
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pages/connect-your-client/teleport-connect.mdx
+8
View File
@@ -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. |
web/packages/teleterm/src/mainProcess/windowsManager.ts
+1 -1
View File
@@ -486,7 +486,7 @@ export class WindowsManager {
? 'Keep Teleport Connect running in the menu bar?'
: 'Keep Teleport Connect running in the system tray?',
detail:
'VNet and connections to databases, kube clusters and apps will remain active.',
'VNet and connections to databases, Kubernetes clusters, and apps will remain active.',
buttons: ['Keep Running', 'Quit'],
noLink: true,
defaultId: 0,