Skip to content

docs: edit troubleshooting steps in Coder Desktop documentation #18233

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.

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 4 commits into from
Jun 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/images/templates/coder-session-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/user-guides/desktop/coder-desktop-workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 9 additions & 39 deletions docs/user-guides/desktop/desktop-connect-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ While active, Coder Connect will list the workspaces you own and will configure

![Coder Desktop list of workspaces](../../images/user-guides/desktop/coder-desktop-workspaces.png)

To copy the `.coder` hostname of a workspace agent, you can click the copy icon beside it.
To copy the `.coder` hostname of a workspace agent, select the copy icon beside it.

You can also connect to the SSH server in your workspace using any SSH client, such as OpenSSH or PuTTY:

Expand Down Expand Up @@ -88,19 +88,17 @@ You can hover your mouse over the status for the list of conflicts:

If you encounter a synchronization conflict, delete the conflicting file that contains changes you don't want to keep.

## Accessing web apps in a secure browser context
## Troubleshooting

### Accessing web apps in a secure browser context

Some web applications require a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) to function correctly.
A browser typically considers an origin secure if the connection is to `localhost`, or over `HTTPS`.

As Coder Connect uses its own hostnames and does not provide TLS to the browser, Google Chrome and Firefox will not allow any web APIs that require a secure context.

> [!NOTE]
> Despite the browser showing an insecure connection without `HTTPS`, the underlying tunnel is encrypted with WireGuard in the same fashion as other Coder workspace connections (e.g. `coder port-forward`).

If you require secure context web APIs, you will need to mark the workspace hostnames as secure in your browser settings.
Because Coder Connect uses its own hostnames and does not provide TLS to the browser, Google Chrome and Firefox will not allow any web APIs that require a secure context.
Even though the browser displays a warning about an insecure connection without `HTTPS`, the underlying tunnel is encrypted with WireGuard in the same fashion as other Coder workspace connections (e.g. `coder port-forward`).

We are planning some changes to Coder Desktop that will make accessing secure context web apps easier. Stay tuned for updates.
<details><summary>If you require secure context web APIs, identify the workspace hostnames as secure in your browser settings.</summary>

<div class="tabs">

Expand Down Expand Up @@ -142,34 +140,6 @@ We are planning some changes to Coder Desktop that will make accessing secure co

</div>

## Troubleshooting

### Mac: Issues updating Coder Desktop

> No workspaces!

And

> Internal Error: The VPN must be started with the app open during first-time setup.
</details>

Due to an issue with the way Coder Desktop works with the macOS [interprocess communication mechanism](https://developer.apple.com/documentation/xpc)(XPC) system network extension, core Desktop functionality can break when you upgrade the application.

<div class="tabs">

The resolution depends on which version of macOS you use:

### macOS <=14

1. Delete the application from `/Applications`.
1. Restart your device.

### macOS 15+

1. Open **System Settings**
1. Select **General**
1. Select **Login Items & Extensions**
1. Scroll down, and select the **ⓘ** for **Network Extensions**
1. Select the **...** next to Coder Desktop, then **Delete Extension**, and follow the prompts.
1. Re-open Coder Desktop and follow the prompts to reinstall the network extension.

</div>
We are planning some changes to Coder Desktop that will make accessing secure context web apps easier in future versions.
4 changes: 1 addition & 3 deletions docs/user-guides/desktop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,7 @@ Before you can use Coder Desktop, you will need to sign in.

Windows: Select **Generate a token via the Web UI**.

1. In your web browser, you may be prompted to sign in to Coder with your credentials:

![Sign in to your Coder deployment](../../images/templates/coder-login-web.png)
1. In your web browser, you may be prompted to sign in to Coder with your credentials.

1. Copy the session token to the clipboard:

Expand Down
Loading