- Notifications
You must be signed in to change notification settings - Fork907
docs: add file sync to coder desktop docs#17463
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
940bfe6
749d839
9dd403e
b1f9356
c43c528
42e7648
e02a3ab
006439a
55c7334
b57d879
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -1,4 +1,4 @@ | ||||||||||
# Coder Desktop (Beta) | ||||||||||
Use Coder Desktop to work on your workspaces as though they're on your LAN, no | ||||||||||
port-forwarding required. | ||||||||||
@@ -22,7 +22,7 @@ You can install Coder Desktop on macOS or Windows. | ||||||||||
Alternatively, you can manually install Coder Desktop from the [releases page](https://github.com/coder/coder-desktop-macos/releases). | ||||||||||
1. Open **Coder Desktop** from the Applications directory. | ||||||||||
1. The application is treated as a system VPN. macOS will prompt you to confirm with: | ||||||||||
@@ -79,11 +79,11 @@ Before you can use Coder Desktop, you will need to sign in. | ||||||||||
## macOS | ||||||||||
 | ||||||||||
## Windows | ||||||||||
 | ||||||||||
</div> | ||||||||||
@@ -97,19 +97,19 @@ Before you can use Coder Desktop, you will need to sign in. | ||||||||||
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: | ||||||||||
 | ||||||||||
1. Paste the token in the **Session Token** field of the **Sign In** screen, then select **Sign In**: | ||||||||||
 | ||||||||||
1. macOS: Allow the VPN configuration for Coder Desktop if you are prompted: | ||||||||||
 | ||||||||||
1. Select the Coder icon in the menu bar (macOS) or system tray (Windows), and click the **Coder Connect** toggle to enable the connection. | ||||||||||
@@ -129,28 +129,80 @@ 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. | ||||||||||
You can also connect to the SSH serverin yourworkspace 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. | ||||||||||
Comment on lines +140 to +141 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This is no longer true if the user is running a Coder deployment of version 2.22 or later. IDE extensions connected to older server versions still have this issue. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Better to remove the note instead of making it more explicit to explain the difference in behaviour. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Why's that? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I am in favor of simpler docs. Eventually, all users, when upgraded to version 2.22, will be using the Coder Connect tunnels. So IMO its better to leave this out. Or we can say, as per version 2.22 of Coder IDE, extensions can also make use of the Coder Connect tunnel to improve performance There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @matifali - does this feel like a good balance? for now, because it's all but the newest version, I think we need to have some indication of who's affected There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. It's perfect. | ||||||||||
### Ping your workspace | ||||||||||
<div class="tabs"> | ||||||||||
### 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 | ||||||||||
``` | ||||||||||
</div> | ||||||||||
## 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 | ||||||||||
Uh oh!
There was an error while loading.Please reload this page.