Skip to content

Commit 0e878a8

Browse files
docs: rename codervpn to coder connect (coder#16833)
part of: coder/internal#459 - [x] Text - [x] Screenshots - [x] MacOS - [x] Windows [preview](https://coder.com/docs/@459-coder-connect/user-guides/desktop) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: M Atif Ali <atif@coder.com>
1 parent 12e5718 commit 0e878a8

6 files changed

+21
-9
lines changed
Binary file not shown.

docs/user-guides/desktop/index.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,17 @@ Before you can use Coder Desktop, you will need to sign in.
7575

7676
1. Open the Desktop menu and select **Sign in**:
7777

78-
<Image height="325px" src="../../images/user-guides/desktop/coder-desktop-pre-sign-in.png" alt="Coder Desktop menu before the user signs in" align="center" />
78+
<div class="tabs">
79+
80+
## macOS
81+
82+
<Image height="325px" src="../../images/user-guides/desktop/coder-desktop-mac-pre-sign-in.png" alt="Coder Desktop menu before the user signs in" align="center" />
83+
84+
## Windows
85+
86+
<Image height="325px" src="../../images/user-guides/desktop/coder-desktop-win-pre-sign-in.png" alt="Coder Desktop menu before the user signs in" align="center" />
87+
88+
</div>
7989

8090
1. In the **Sign In** window, enter your Coder deployment's URL and select **Next**:
8191

@@ -101,17 +111,19 @@ Before you can use Coder Desktop, you will need to sign in.
101111

102112
<Image height="350px" src="../../images/user-guides/desktop/mac-allow-vpn.png" alt="Copy session token" align="center" />
103113

104-
1. Select the Coder icon in the menu bar (macOS) or system tray (Windows), and click the CoderVPN toggle to start the VPN.
114+
1. Select the Coder icon in the menu bar (macOS) or system tray (Windows), and click the **Coder Connect** toggle to enable the connection.
115+
116+
![Coder Desktop on Windows - enable Coder Connect](../../images/user-guides/desktop/coder-desktop-win-enable-coder-connect.png)
105117

106118
This may take a few moments, as Coder Desktop will download the necessary components from the Coder server if they have been updated.
107119

108-
1. macOS: You may be prompted to enter your password to allow CoderVPN to start.
120+
1. macOS: You may be prompted to enter your password to allow Coder Connect to start.
109121

110-
1. CoderVPN is now running!
122+
1. Coder Connect is now running!
111123

112-
## CoderVPN
124+
## Coder Connect
113125

114-
While active, CoderVPN will list your owned workspaces and configure your system to be able to connect to them over private IPv6 addresses and custom hostnames ending in `.coder`.
126+
While active, Coder Connect will list the workspaces you own and will configure your system to connect to them over private IPv6 addresses and custom hostnames ending in `.coder`.
115127

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

@@ -138,14 +150,14 @@ You can also connect to the SSH server in your workspace using any SSH client, s
138150
```
139151

140152
> [!NOTE]
141-
> Currently, the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the CoderVPN tunnel to connect to workspaces.
153+
> Currently, the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the Coder Connect tunnel to connect to workspaces.
142154
143155
## Accessing web apps in a secure browser context
144156

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

148-
As CoderVPN 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.
160+
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.
149161

150162
> [!NOTE]
151163
> 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`).
@@ -184,7 +196,7 @@ We are planning some changes to Coder Desktop that will make accessing secure co
184196

185197
1. Select **String** on the entry with the same name at the bottom of the list, then select the plus icon on the right.
186198

187-
1. In the text field, enter the full workspace hostname, without the `http` scheme and port (e.g. `your-workspace.coder`), and then select the tick icon.
199+
1. In the text field, enter the full workspace hostname, without the `http` scheme and port: `your-workspace.coder`. Then select the tick icon.
188200

189201
If you need to enter multiple URLs, use a comma to separate them.
190202

0 commit comments

Comments
 (0)