Skip to content

Commit 60927c7

Browse files
EdwardAngertEdwardAngert
authored
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>
1 parent a6e2d2d commit 60927c7

File tree

4 files changed

+10
-42
lines changed

4 files changed

+10
-42
lines changed

‎docs/images/templates/coder-session-token.png

-2.53 KB
Loading

‎docs/images/user-guides/desktop/coder-desktop-workspaces.png

141 KB
Loading

‎docs/user-guides/desktop/desktop-connect-sync.md

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ While active, Coder Connect will list the workspaces you own and will configure
1111

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

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

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

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

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

91-
## Accessing web apps in a secure browser context
91+
## Troubleshooting
92+
93+
### Accessing web apps in a secure browser context
9294

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

96-
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.
97-
98-
> [!NOTE]
99-
> 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`).
100-
101-
If you require secure context web APIs, you will need to mark the workspace hostnames as secure in your browser settings.
98+
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.
99+
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`).
102100

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

105103
<div class="tabs">
106104

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

143141
</div>
144142

145-
## Troubleshooting
146-
147-
### Mac: Issues updating Coder Desktop
148-
149-
> No workspaces!
150-
151-
And
152-
153-
> Internal Error: The VPN must be started with the app open during first-time setup.
143+
</details>
154144

155-
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.
156-
157-
<div class="tabs">
158-
159-
The resolution depends on which version of macOS you use:
160-
161-
### macOS <=14
162-
163-
1. Delete the application from `/Applications`.
164-
1. Restart your device.
165-
166-
### macOS 15+
167-
168-
1. Open **System Settings**
169-
1. Select **General**
170-
1. Select **Login Items & Extensions**
171-
1. Scroll down, and select the **ⓘ** for **Network Extensions**
172-
1. Select the **...** next to Coder Desktop, then **Delete Extension**, and follow the prompts.
173-
1. Re-open Coder Desktop and follow the prompts to reinstall the network extension.
174-
175-
</div>
145+
We are planning some changes to Coder Desktop that will make accessing secure context web apps easier in future versions.

‎docs/user-guides/desktop/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,7 @@ Before you can use Coder Desktop, you will need to sign in.
9595

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

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

102100
1. Copy the session token to the clipboard:
103101

0 commit comments

Comments
 (0)