From f7814e66860ea6e4971959c540d5a3cac4823405 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Cie=C5=9Blak?= Date: Tue, 10 Oct 2023 11:40:49 +0200 Subject: [PATCH] Reword Troubleshooting section in Connect docs --- .../connect-your-client/teleport-connect.mdx | 40 ++++++++++++------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/docs/pages/connect-your-client/teleport-connect.mdx b/docs/pages/connect-your-client/teleport-connect.mdx index b36c89a85ccb8..f200886cb9f86 100644 --- a/docs/pages/connect-your-client/teleport-connect.mdx +++ b/docs/pages/connect-your-client/teleport-connect.mdx @@ -255,27 +255,39 @@ The changes will take effect at the next launch. ## Troubleshooting -Logging out of a cluster, closing the app and logging in again resets all app state related to that -cluster. This can help if you encounter a bug which renders the user interface partially unusable. -It might also help if you have issues with connecting to an active cluster that don't happen in the -Web UI. +Resetting the app state might help with UI crashes caused by Teleport Connect getting into an +abnormal state. This might happen after downgrading Teleport Connect or performing substantial +server-side changes. Those UI crashes typically manifest as a blank window or an Internal Error +alert. + +To reset the state related to a particular cluster: + +1. Log out of the cluster. +1. Close Teleport Connect. +1. Open Teleport Connect, then log back in to the cluster. + +To completely wipe all app state: + +1. Close Teleport Connect. +1. Remove the internal `tsh` folder and the `app_state.json` file to log out of all clusters and + clear all remembered tabs and connections. -To force the app to log you out of all clusters, close the app and remove the `~/Library/Application -Support/Teleport Connect/tsh` folder. Removing the file `~/Library/Application -Support/Teleport Connect/app_state.json` will clear all remembered tabs and connections. +```code +$ rm -rf ~/Library/Application\ Support/Teleport\ Connect/{tsh,app_state.json} +``` -To force the app to log you out of all clusters, close the app and remove the `~/.config/Teleport -Connect/tsh` folder. Removing the file `/.config/Teleport Connect/app_state.json` will clear -all remembered tabs and connections. +```code +$ rm -rf ~/.config/Teleport\ Connect/{tsh,app_state.json} +``` -To force the app to log you out of all clusters, close the app and remove the -`C:\Users\%UserName%\AppData\Roaming\Teleport Connect\tsh` folder. Removing the file -`C:\Users\%UserName%\AppData\Roaming\Teleport Connect\app_state.json` will clear all remembered tabs -and connections. +```code +$ rmdir /s /q C:\Users\%UserName%\AppData\Roaming\"Teleport Connect"\tsh +$ del C:\Users\%UserName%\AppData\Roaming\"Teleport Connect"\app_state.json +```