You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guides/desktop/index.md
+68-16Lines changed: 68 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Coder Desktop (Early Access)
1
+
# Coder Desktop (Beta)
2
2
3
3
Use Coder Desktop to work on your workspaces as though they're on your LAN, no
4
4
port-forwarding required.
@@ -22,7 +22,7 @@ You can install Coder Desktop on macOS or Windows.
22
22
23
23
Alternatively, you can manually install Coder Desktop from the [releases page](https://github.com/coder/coder-desktop-macos/releases).
24
24
25
-
1. Open **Coder Desktop** from the Applications directory. When macOS asks if you want to open it, select **Open**.
25
+
1. Open **Coder Desktop** from the Applications directory.
26
26
27
27
1. The application is treated as a system VPN. macOS will prompt you to confirm with:
28
28
@@ -79,11 +79,11 @@ Before you can use Coder Desktop, you will need to sign in.
79
79
80
80
## macOS
81
81
82
-
<Imageheight="325px"src="../../images/user-guides/desktop/coder-desktop-mac-pre-sign-in.png"alt="Coder Desktop menu before the user signs in"align="center" />
82
+
83
83
84
84
## Windows
85
85
86
-
<Imageheight="325px"src="../../images/user-guides/desktop/coder-desktop-win-pre-sign-in.png"alt="Coder Desktop menu before the user signs in"align="center" />
86
+
87
87
88
88
</div>
89
89
@@ -97,19 +97,19 @@ Before you can use Coder Desktop, you will need to sign in.
97
97
98
98
1. In your web browser, you may be prompted to sign in to Coder with your credentials:
99
99
100
-
<Imageheight="412px"src="../../images/templates/coder-login-web.png"alt="Sign in to your Coder deployment"align="center" />
100
+
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
115
@@ -129,28 +129,80 @@ While active, Coder Connect will list the workspaces you own and will configure
129
129
130
130
To copy the `.coder` hostname of a workspace agent, you can click the copy icon beside it.
131
131
132
-
On macOS you can use `ping6`in your terminal to verify the connection to your workspace:
132
+
You can also connect to the SSH server in your workspace using any SSH client, such as OpenSSH or PuTTY:
133
133
134
134
```shell
135
-
ping6 -c 5 your-workspace.coder
135
+
ssh your-workspace.coder
136
136
```
137
137
138
-
On Windows, you can use `ping` in a Command Prompt or PowerShell terminal to verify the connection to your workspace:
138
+
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.
139
+
140
+
> [!NOTE]
141
+
> 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.
142
+
143
+
### Ping your workspace
144
+
145
+
<divclass="tabs">
146
+
147
+
### macOS
148
+
149
+
Use `ping6` in your terminal to verify the connection to your workspace:
139
150
140
151
```shell
141
-
ping -n 5 your-workspace.coder
152
+
ping6 -c 5 your-workspace.coder
142
153
```
143
154
144
-
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.
155
+
### Windows
145
156
146
-
You can also connect to the SSH server in your workspace using any SSH client, such as OpenSSH or PuTTY:
157
+
Use `ping` in a Command Prompt or PowerShell terminal to verify the connection to your workspace:
147
158
148
159
```shell
149
-
ssh your-workspace.coder
160
+
ping -n 5 your-workspace.coder
150
161
```
151
162
163
+
</div>
164
+
165
+
## Sync a local directory with your workspace
166
+
167
+
Coder Desktop file sync provides bidirectional synchronization between a local directory and your workspace.
168
+
You can work offline, add screenshots to documentation, or use local development tools while keeping your files in sync with your workspace.
169
+
170
+
1. Create a new local directory.
171
+
172
+
If you select an existing clone of your repository, Desktop will recognize it as conflicting files.
173
+
174
+
1. In the Coder Desktop app, select **File sync**.
For more information about the current status, hover your mouse over the status.
187
+
188
+
File sync excludes version control system directories like `.git/` from synchronization, so keep your Git-cloned repository wherever you run Git commands.
189
+
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.
190
+
152
191
> [!NOTE]
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.
192
+
> Coder Desktop uses `alpha` and `beta` to distinguish between the:
193
+
>
194
+
> - Local directory: `alpha`
195
+
> - Remote directory: `beta`
196
+
197
+
### File sync conflicts
198
+
199
+
File sync shows a `Conflicts` status when it detects conflicting files.
200
+
201
+
You can hover your mouse over the status for the list of conflicts:
0 commit comments