mirror of https://github.com/coder/coder.git
docs: fix jetbrains reconnect faq (#12073)
* docs: fix jetbrains reconnect faq * make: fmt * add asher feedback
This commit is contained in:
parent
390217b396
commit
bb308851f5
22
docs/faqs.md
22
docs/faqs.md
|
@ -534,19 +534,31 @@ https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites
|
||||||
<details style="margin-bottom: 28px;">
|
<details style="margin-bottom: 28px;">
|
||||||
<summary style="font-size: larger; font-weight: bold;">How can I resolve disconnects when connected to Coder via JetBrains Gateway?</summary>
|
<summary style="font-size: larger; font-weight: bold;">How can I resolve disconnects when connected to Coder via JetBrains Gateway?</summary>
|
||||||
|
|
||||||
If you leave your JetBrains IDE open for some time while connected to Coder, you
|
If your JetBrains IDE is disconnected for a long period of time due to a network
|
||||||
may encounter a message similar to the below:
|
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
|
```console
|
||||||
No internet connection. Changes in the document might be lost. Trying to reconnect…
|
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
|
```console
|
||||||
Host coder-jetbrains--*
|
Host coder-jetbrains--*
|
||||||
ServerAliveInterval 5
|
ServerAliveInterval 5
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that your SSH config file will be overwritten by the JetBrains Gateway
|
This will make SSH check that it can contact the server every five seconds. If
|
||||||
client if it is re-authenticated to your Coder deployment.
|
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.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
Loading…
Reference in New Issue