docs: add faq for gateway reconnects #12007
Conversation
| @@ -530,3 +530,23 @@ prerequisites for Linux, please look at the VSCode docs. | |||
| https://code.visualstudio.com/docs/remote/linux#_local-linux-prerequisites | |||
|
|
|||
| </details> | |||
|
|
|||
| <details style="margin-bottom: 28px;"> | |||
There was a problem hiding this comment.
It looks like the closing details is missing, probably the browser will auto-close it since it is at the end but it might trip someone up if they are adding a new section.
| Note that your SSH config file will be overwritten by the JetBrains Gateway | ||
| client if it is re-authenticated to your Coder deployment. |
There was a problem hiding this comment.
I think we might specify that only the blocks between the comments are overwritten just in case it sounds like it wipes the entire config file. Since those blocks are overwritten we have to add the setting in a separate block rather than add it to an existing block.
| 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: |
There was a problem hiding this comment.
| 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: |
| If you leave your JetBrains IDE open for some time while connected to Coder, you | ||
| may encounter a message similar to the below: |
There was a problem hiding this comment.
This is nitpicking I think, but my thinking is that not all disconnects will require the fix, just the ones that are persistently hung, and possibly mentioning a VPN will make it more discoverable since I think that is the main way to trigger this.
| 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 | ||
| Host coder-jetbrains--* | ||
| ServerAliveInterval 5 |
There was a problem hiding this comment.
People can probably look this up just fine but I wonder if we should add something like:
This will make SSH check that it can contact the server every five seconds. If it fails to do so
ServerAliveCountMaxtimes (3 by default for a total of 15 seconds) then it will close the connection which forces JetBrains to recreate the hung session.
this PR adds an FAQ and solution for JetBrains Gateway disconnects/reconnects. @code-asher recommended the below change to a user's SSH config file and they confirmed it resolved the disconnects:
we support a server-side flag to append
ServerAliveInternalto Coder's SSH config entries, but this does not apply to Gateway entries. i opened an issue on this here: coder/jetbrains-coder#354here is the original IntelliJ support ticket created by the end-user: https://intellij-support.jetbrains.com/hc/en-us/community/posts/16295898616082-PyCharm-No-Connection-while-using-JetBrains-Gateway-Coder