mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
docs: add file sync to coder desktop docs (#17463)
closes #16869 section could use more about: - [x] sync direction options? - [x] how to resolve conflicts - [x] EA --> Beta [preview](https://coder.com/docs/@16869-desktop-file-sync/user-guides/desktop) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
co-authored by
EdwardAngert
EdwardAngert
parent
df56a13947
commit
74934e174e
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 126 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 62 KiB |
+1
-1
@@ -193,7 +193,7 @@
|
||||
"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": ["early access"]
|
||||
"state": ["beta"]
|
||||
},
|
||||
{
|
||||
"title": "Workspace Management",
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Coder Desktop (Early Access)
|
||||
# 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. When macOS asks if you want to open it, select **Open**.
|
||||
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
|
||||
|
||||
<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" />
|
||||
|
||||
|
||||
## Windows
|
||||
|
||||
<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" />
|
||||
|
||||
|
||||
</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:
|
||||
|
||||
<Image height="412px" src="../../images/templates/coder-login-web.png" alt="Sign in to your Coder deployment" align="center" />
|
||||
|
||||
|
||||
1. Copy the session token to the clipboard:
|
||||
|
||||
<Image height="350px" src="../../images/templates/coder-session-token.png" alt="Copy session token" align="center" />
|
||||
|
||||
|
||||
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. macOS: Allow the VPN configuration for Coder Desktop if you are prompted:
|
||||
|
||||
<Image height="350px" src="../../images/user-guides/desktop/mac-allow-vpn.png" alt="Copy session token" align="center" />
|
||||
|
||||
|
||||
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,29 +129,81 @@ 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.
|
||||
|
||||
On macOS you can use `ping6` in your terminal to verify the connection to your workspace:
|
||||
|
||||
```shell
|
||||
ping6 -c 5 your-workspace.coder
|
||||
```
|
||||
|
||||
On Windows, you can use `ping` in a Command Prompt or PowerShell terminal to verify the connection to your workspace:
|
||||
|
||||
```shell
|
||||
ping -n 5 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.
|
||||
|
||||
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
|
||||
|
||||
<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
|
||||
|
||||
Some web applications require a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) to function correctly.
|
||||
|
||||
Reference in New Issue
Block a user