From bb308851f5000b293bc08be330775c8f7e93d1ab Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 9 Feb 2024 18:44:33 -0500 Subject: [PATCH] docs: fix jetbrains reconnect faq (#12073) * docs: fix jetbrains reconnect faq * make: fmt * add asher feedback --- docs/faqs.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/faqs.md b/docs/faqs.md index c347f75b9e..7b09bb516a 100644 --- a/docs/faqs.md +++ b/docs/faqs.md @@ -534,19 +534,31 @@ https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites
How can I resolve disconnects when connected to Coder via JetBrains Gateway? -If you leave your JetBrains IDE open for some time while connected to Coder, you -may encounter a message similar to the below: +If your JetBrains IDE is disconnected for a long period of time due to a network +change (for example turning off a VPN), you may find that the IDE will not +reconnect once the network is re-established (for example turning a VPN back +on). When this happens a persistent message will appear similar to the below: ```console No internet connection. Changes in the document might be lost. Trying to reconnect… ``` -To resolve this, add this entry to your SSH host file on your local machine: +To resolve this, add this entry to your SSH config file on your local machine: ```console Host coder-jetbrains--* ServerAliveInterval 5 ``` -Note that your SSH config file will be overwritten by the JetBrains Gateway -client if it is re-authenticated to your Coder deployment. +This will make SSH check that it can contact the server every five seconds. If +it fails to do so `ServerAliveCountMax` times (3 by default for a total of 15 +seconds) then it will close the connection which forces JetBrains to recreate +the hung session. You can tweak `ServerAliveInterval` and `ServerAliveCountMax` +to increase or decrease the total timeout. + +Note that the JetBrains Gateway configuration blocks for each host in your SSH +config file will be overwritten by the JetBrains Gateway client when it +re-authenticates to your Coder deployment so you must add the above config as a +separate block and not add it to any existing ones. + +