From 8d4a1a53331492480a7473f6f8bf710ad75cd497 Mon Sep 17 00:00:00 2001
From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Date: Tue, 27 May 2025 18:04:56 +0000
Subject: [PATCH 1/2] separate install and use
---
docs/manifest.json | 10 +-
.../desktop/desktop-connect-sync.md | 175 ++++++++++++++++++
docs/user-guides/desktop/index.md | 169 +----------------
3 files changed, 186 insertions(+), 168 deletions(-)
create mode 100644 docs/user-guides/desktop/desktop-connect-sync.md
diff --git a/docs/manifest.json b/docs/manifest.json
index 1ec955c6244cc..a7a45bb489563 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -198,7 +198,15 @@
"description": "Use Coder Desktop to access your workspace like it's a local machine",
"path": "./user-guides/desktop/index.md",
"icon_path": "./images/icons/computer-code.svg",
- "state": ["beta"]
+ "state": ["beta"],
+ "children": [
+ {
+ "title": "Coder Desktop connect and sync",
+ "description": "Use Coder Desktop to manage your workspace code and files locally",
+ "path": "./user-guides/desktop/desktop-connect-sync.md",
+ "state": ["beta"]
+ }
+ ]
},
{
"title": "Workspace Management",
diff --git a/docs/user-guides/desktop/desktop-connect-sync.md b/docs/user-guides/desktop/desktop-connect-sync.md
new file mode 100644
index 0000000000000..80c6b5107ad2f
--- /dev/null
+++ b/docs/user-guides/desktop/desktop-connect-sync.md
@@ -0,0 +1,175 @@
+# Coder Desktop Connect and Sync
+
+Use Coder Desktop to work on your workspaces and files as though they're on your LAN.
+
+> [!NOTE]
+> Coder Desktop requires a Coder deployment running [v2.20.0](https://github.com/coder/coder/releases/tag/v2.20.0) or later.
+
+## Coder Connect
+
+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`.
+
+
+
+To copy the `.coder` hostname of a workspace agent, you can click 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:
+
+ ```shell
+ ssh your-workspace.coder
+ ```
+
+Any services listening on ports in your workspace will be available on the same hostname. For example, you can access a web server on port `8080` by visiting `http://your-workspace.coder:8080` in your browser.
+
+> [!NOTE]
+> 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.
+
+### Ping your workspace
+
+
+
+### macOS
+
+Use `ping6` in your terminal to verify the connection to your workspace:
+
+ ```shell
+ ping6 -c 5 your-workspace.coder
+ ```
+
+### Windows
+
+Use `ping` in a Command Prompt or PowerShell terminal to verify the connection to your workspace:
+
+ ```shell
+ ping -n 5 your-workspace.coder
+ ```
+
+
+
+## Sync a local directory with your workspace
+
+Coder Desktop file sync provides bidirectional synchronization between a local directory and your workspace.
+You can work offline, add screenshots to documentation, or use local development tools while keeping your files in sync with your workspace.
+
+1. Create a new local directory.
+
+ If you select an existing clone of your repository, Desktop will recognize it as conflicting files.
+
+1. In the Coder Desktop app, select **File sync**.
+
+ 
+
+1. Select the **+** in the corner to select the local path, workspace, and remote path, then select **Add**:
+
+ 
+
+1. File sync clones your workspace directory to your local directory, then watches for changes:
+
+ 
+
+ For more information about the current status, hover your mouse over the status.
+
+File sync excludes version control system directories like `.git/` from synchronization, so keep your Git-cloned repository wherever you run Git commands.
+This means that if you use an IDE with a built-in terminal to edit files on your remote workspace, that should be the Git clone and your local directory should be for file syncs.
+
+> [!NOTE]
+> Coder Desktop uses `alpha` and `beta` to distinguish between the:
+>
+> - Local directory: `alpha`
+> - Remote directory: `beta`
+
+### File sync conflicts
+
+File sync shows a `Conflicts` status when it detects conflicting files.
+
+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
+
+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.
+
+We are planning some changes to Coder Desktop that will make accessing secure context web apps easier. Stay tuned for updates.
+
+
+
+### Chrome
+
+1. Open Chrome and visit `chrome://flags/#unsafely-treat-insecure-origin-as-secure`.
+
+1. Enter the full workspace hostname, including the `http` scheme and the port (e.g. `http://your-workspace.coder:8080`), into the **Insecure origins treated as secure** text field.
+
+ If you need to enter multiple URLs, use a comma to separate them.
+
+ 
+
+1. Ensure that the dropdown to the right of the text field is set to **Enabled**.
+
+1. You will be prompted to relaunch Google Chrome at the bottom of the page. Select **Relaunch** to restart Google Chrome.
+
+1. On relaunch and subsequent launches, Google Chrome will show a banner stating "You are using an unsupported command-line flag". This banner can be safely dismissed.
+
+1. Web apps accessed on the configured hostnames and ports will now function correctly in a secure context.
+
+### Firefox
+
+1. Open Firefox and visit `about:config`.
+
+1. Read the warning and select **Accept the Risk and Continue** to access the Firefox configuration page.
+
+1. Enter `dom.securecontext.allowlist` into the search bar at the top.
+
+1. Select **String** on the entry with the same name at the bottom of the list, then select the plus icon on the right.
+
+1. In the text field, enter the full workspace hostname, without the `http` scheme and port: `your-workspace.coder`. Then select the tick icon.
+
+ If you need to enter multiple URLs, use a comma to separate them.
+
+ 
+
+1. Web apps accessed on the configured hostnames will now function correctly in a secure context without requiring a restart.
+
+
+
+## Troubleshooting
+
+### 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.
+
+
+
+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.
+
+
diff --git a/docs/user-guides/desktop/index.md b/docs/user-guides/desktop/index.md
index 69a32837a8b87..1f28f46d7c733 100644
--- a/docs/user-guides/desktop/index.md
+++ b/docs/user-guides/desktop/index.md
@@ -121,171 +121,6 @@ Before you can use Coder Desktop, you will need to sign in.
1. Coder Connect is now running!
-## Coder Connect
+## Next Steps
-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`.
-
-
-
-To copy the `.coder` hostname of a workspace agent, you can click 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:
-
- ```shell
- ssh your-workspace.coder
- ```
-
-Any services listening on ports in your workspace will be available on the same hostname. For example, you can access a web server on port `8080` by visiting `http://your-workspace.coder:8080` in your browser.
-
-> [!NOTE]
-> 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.
-
-### Ping your workspace
-
-
-
-### macOS
-
-Use `ping6` in your terminal to verify the connection to your workspace:
-
- ```shell
- ping6 -c 5 your-workspace.coder
- ```
-
-### Windows
-
-Use `ping` in a Command Prompt or PowerShell terminal to verify the connection to your workspace:
-
- ```shell
- ping -n 5 your-workspace.coder
- ```
-
-
-
-## Sync a local directory with your workspace
-
-Coder Desktop file sync provides bidirectional synchronization between a local directory and your workspace.
-You can work offline, add screenshots to documentation, or use local development tools while keeping your files in sync with your workspace.
-
-1. Create a new local directory.
-
- If you select an existing clone of your repository, Desktop will recognize it as conflicting files.
-
-1. In the Coder Desktop app, select **File sync**.
-
- 
-
-1. Select the **+** in the corner to select the local path, workspace, and remote path, then select **Add**:
-
- 
-
-1. File sync clones your workspace directory to your local directory, then watches for changes:
-
- 
-
- For more information about the current status, hover your mouse over the status.
-
-File sync excludes version control system directories like `.git/` from synchronization, so keep your Git-cloned repository wherever you run Git commands.
-This means that if you use an IDE with a built-in terminal to edit files on your remote workspace, that should be the Git clone and your local directory should be for file syncs.
-
-> [!NOTE]
-> Coder Desktop uses `alpha` and `beta` to distinguish between the:
->
-> - Local directory: `alpha`
-> - Remote directory: `beta`
-
-### File sync conflicts
-
-File sync shows a `Conflicts` status when it detects conflicting files.
-
-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
-
-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.
-
-We are planning some changes to Coder Desktop that will make accessing secure context web apps easier. Stay tuned for updates.
-
-
-
-### Chrome
-
-1. Open Chrome and visit `chrome://flags/#unsafely-treat-insecure-origin-as-secure`.
-
-1. Enter the full workspace hostname, including the `http` scheme and the port (e.g. `http://your-workspace.coder:8080`), into the **Insecure origins treated as secure** text field.
-
- If you need to enter multiple URLs, use a comma to separate them.
-
- 
-
-1. Ensure that the dropdown to the right of the text field is set to **Enabled**.
-
-1. You will be prompted to relaunch Google Chrome at the bottom of the page. Select **Relaunch** to restart Google Chrome.
-
-1. On relaunch and subsequent launches, Google Chrome will show a banner stating "You are using an unsupported command-line flag". This banner can be safely dismissed.
-
-1. Web apps accessed on the configured hostnames and ports will now function correctly in a secure context.
-
-### Firefox
-
-1. Open Firefox and visit `about:config`.
-
-1. Read the warning and select **Accept the Risk and Continue** to access the Firefox configuration page.
-
-1. Enter `dom.securecontext.allowlist` into the search bar at the top.
-
-1. Select **String** on the entry with the same name at the bottom of the list, then select the plus icon on the right.
-
-1. In the text field, enter the full workspace hostname, without the `http` scheme and port: `your-workspace.coder`. Then select the tick icon.
-
- If you need to enter multiple URLs, use a comma to separate them.
-
- 
-
-1. Web apps accessed on the configured hostnames will now function correctly in a secure context without requiring a restart.
-
-
-
-## Troubleshooting
-
-### 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.
-
-
-
-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.
-
-
+- [Connect to and work on your workspace](./desktop-connect-sync.md)
From 9c841c3a83324ce98c9199994644fe55abcd3ab0 Mon Sep 17 00:00:00 2001
From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Date: Thu, 29 May 2025 16:26:32 +0000
Subject: [PATCH 2/2] re-add change to version from old PR
---
docs/user-guides/desktop/desktop-connect-sync.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/user-guides/desktop/desktop-connect-sync.md b/docs/user-guides/desktop/desktop-connect-sync.md
index 80c6b5107ad2f..1a09c9b7c5f5d 100644
--- a/docs/user-guides/desktop/desktop-connect-sync.md
+++ b/docs/user-guides/desktop/desktop-connect-sync.md
@@ -22,7 +22,7 @@ You can also connect to the SSH server in your workspace using any SSH client, s
Any services listening on ports in your workspace will be available on the same hostname. For example, you can access a web server on port `8080` by visiting `http://your-workspace.coder:8080` in your browser.
> [!NOTE]
-> 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.
+> For Coder versions v2.21.3 and earlier: the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the Coder Connect tunnel to connect to workspaces.
### Ping your workspace
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy