Skip to content

docs: add faq for gateway reconnects #12007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 4, 2024
Merged

docs: add faq for gateway reconnects #12007

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc958d0
docs: add faq for gateway reconnects
ericpaulsen Feb 3, 2024
fd1258b
make: fmt
ericpaulsen Feb 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;">
Copy link
Member

Choose a reason for hiding this comment

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

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.

<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
may encounter a message similar to the below:
Comment on lines +537 to +538
Copy link
Member

Choose a reason for hiding this comment

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

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.

Suggested change
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:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Member

Choose a reason for hiding this comment

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

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 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.

```

Note that your SSH config file will be overwritten by the JetBrains Gateway
client if it is re-authenticated to your Coder deployment.
Comment on lines +551 to +552
Copy link
Member

@code-asher code-asher Feb 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.