mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: edit troubleshooting steps in Coder Desktop documentation (#18233)
closes #18071 - [x] move `## Accessing web apps in a secure browser context` to the troubleshooting section - [x] use a compacted view for troubleshooting topics to prevent them from occupying a significant space on page - [x] remove `Issues updating Coder Desktop` - [x] Update screenshots --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
co-authored by
EdwardAngert
parent
a6e2d2db99
commit
60927c701d
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 203 KiB |
@@ -11,7 +11,7 @@ While active, Coder Connect will list the workspaces you own and will configure
|
||||
|
||||

|
||||
|
||||
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:
|
||||
|
||||
@@ -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.
|
||||
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`).
|
||||
|
||||
> [!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.
|
||||
|
||||
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">
|
||||
|
||||
@@ -142,34 +140,6 @@ We are planning some changes to Coder Desktop that will make accessing secure co
|
||||
|
||||
</div>
|
||||
|
||||
## Troubleshooting
|
||||
</details>
|
||||
|
||||
### Mac: Issues updating Coder Desktop
|
||||
|
||||
> No workspaces!
|
||||
|
||||
And
|
||||
|
||||
> Internal Error: The VPN must be started with the app open during first-time setup.
|
||||
|
||||
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.
|
||||
|
||||
@@ -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:
|
||||
|
||||

|
||||
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:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user