Skip to content

Add docs for running Connect in background#58858

Merged
gzdunek merged 3 commits intomasterfrom
gzdunek/run-in-background-docs
Sep 9, 2025
Merged

Add docs for running Connect in background#58858
gzdunek merged 3 commits intomasterfrom
gzdunek/run-in-background-docs

Conversation

@gzdunek
Copy link
Copy Markdown
Contributor

@gzdunek gzdunek commented Sep 8, 2025

Docs for #58575

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 8, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
gzdunek/run-in-background-docs 5493109 3 ❌FAILED gzdunek-run-in-background-docs 2025-09-09 09:44:38

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
and apps without keeping the main window open.

See `runInBackground` [configuration option](#configuration).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to add an example configuration snippet here so the user doesn't need to hop around?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered it, but ultimately decided to keep it as a link to the config option. It provides the platform defaults and details about Linux requirements.

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread web/packages/teleterm/src/mainProcess/windowsManager.ts Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
@gzdunek gzdunek enabled auto-merge September 9, 2025 09:41
@gzdunek gzdunek added this pull request to the merge queue Sep 9, 2025
Merged via the queue into master with commit 575c42f Sep 9, 2025
43 of 44 checks passed
@gzdunek gzdunek deleted the gzdunek/run-in-background-docs branch September 9, 2025 10:04
@backport-bot-workflows
Copy link
Copy Markdown
Contributor

@gzdunek See the table below for backport results.

Branch Result
branch/v17 Failed
branch/v18 Failed

gzdunek added a commit that referenced this pull request Sep 9, 2025
gzdunek added a commit that referenced this pull request Sep 9, 2025
github-merge-queue bot pushed a commit that referenced this pull request Sep 10, 2025
* Allow Connect to run in background (#58575)

* Add tray icons for Mac and Linux

* Fix resources path

* Add config option

* Set tray when the app launches

* Integrate app with tray

* Notify UI when window visibility changes

* Terminate foreground sessions when window is hidden

* Open dialogs first before showing window

* Improve docs

* Rely on `window.isVisible()` to tell if window is hidden or not

* Change `WindowsManagerIpc.WindowVisibility` to `RendererIpc.WindowVisibility`

* Rename "window visibility" to "background mode"

* Revert "Open dialogs first before showing window"

This reverts commit b17147c.

* Simplify mounting/unmounting documents

* Use different GUIDs for packaged and dev app

* Make sure window is not destroyed before using it

* Renames

* Improve dialog message

* Add `isDestroyed` to window mock

* Fix comment

* `database` -> `databases`

* Improve readability

(cherry picked from commit 6cef4f3)

* Dialog improvements from #58858
github-merge-queue bot pushed a commit that referenced this pull request Sep 10, 2025
* Allow Connect to run in background (#58575)

* Add tray icons for Mac and Linux

* Fix resources path

* Add config option

* Set tray when the app launches

* Integrate app with tray

* Notify UI when window visibility changes

* Terminate foreground sessions when window is hidden

* Open dialogs first before showing window

* Improve docs

* Rely on `window.isVisible()` to tell if window is hidden or not

* Change `WindowsManagerIpc.WindowVisibility` to `RendererIpc.WindowVisibility`

* Rename "window visibility" to "background mode"

* Revert "Open dialogs first before showing window"

This reverts commit b17147c.

* Simplify mounting/unmounting documents

* Use different GUIDs for packaged and dev app

* Make sure window is not destroyed before using it

* Renames

* Improve dialog message

* Add `isDestroyed` to window mock

* Fix comment

* `database` -> `databases`

* Improve readability

(cherry picked from commit 6cef4f3)

* Dialog improvements from #58858
mmcallister pushed a commit that referenced this pull request Sep 22, 2025
* Add docs for running Connect in background

* Review fixes

* Review fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants