Skip to content

Commit 768f5f6

Browse files
authored
chore: update README.md (#145)
1 parent a32ef21 commit 768f5f6

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

README.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -92,22 +92,16 @@ jetbrains://gateway/com.coder.toolbox
9292
| ide_build_number | Specific build number of the JetBrains IDE to install on the workspace | No |
9393
| folder | Absolute path to the project folder to open in the remote IDE (URL-encoded) | No |
9494

95-
If only a single agent is available, specifying an agent ID is optional. However, if multiple agents exist,
96-
you must provide either the ID to target a specific one. Note that this version of the Coder Toolbox plugin
97-
does not automatically start agents if they are offline, so please ensure the selected agent is running before
98-
proceeding.
95+
> [!NOTE]
96+
> If only a single agent is available, specifying an agent ID is optional. However, if multiple agents exist,
97+
> you must provide either the ID to target a specific one. Note that this version of the Coder Toolbox plugin
98+
> does not automatically start agents if they are offline, so please ensure the selected agent is running before
99+
> proceeding.
99100
100101
If `ide_product_code` and `ide_build_number` is missing, Toolbox will only open and highlight the workspace environment
101102
page. Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
102103
experience, it’s recommended to ensure the workspace is running prior to initiating the connection.
103104

104-
> ⚠️ Note: `folder` should point to a remote IDEA project that has already been opened and appears in the `Projects`
105-
> tab.
106-
> If the path refers to a project that doesn't exist, the remote IDE won’t start or load it.
107-
108-
> Until [TBX-14952](https://youtrack.jetbrains.com/issue/TBX-14952/) is fixed, it's best to either use a path to a
109-
> previously opened project or leave it empty.
110-
111105
## Configuring and Testing workspace polling with HTTP & SOCKS5 Proxy
112106

113107
This section explains how to set up a local proxy (without authentication which is not yet supported) and verify that
@@ -122,7 +116,6 @@ interception.
122116
2. Start the proxy:
123117

124118
```bash
125-
126119
mitmweb --ssl-insecure --set stream_large_bodies="10m"
127120
```
128121

@@ -170,7 +163,8 @@ Steps to enable debug logging:
170163

171164
There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
172165

173-
> ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
166+
> [!WARNING]
167+
> Toolbox does not persist log level configuration between restarts.
174168
175169
#### Viewing the Logs
176170

@@ -187,67 +181,67 @@ storage paths. The options can be configured from the plugin's main Workspaces p
187181

188182
### CLI related settings
189183

190-
```Binary source``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
184+
- `Binary source` specifies the source URL or relative path from which the Coder CLI should be downloaded.
191185
If a relative path is provided, it is resolved against the deployment domain.
192186

193-
```Enable downloads``` allows automatic downloading of the CLI if the current version is missing or outdated.
187+
- `Enable downloads` allows automatic downloading of the CLI if the current version is missing or outdated.
194188

195-
```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
189+
- `Binary directory` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
196190
directory.
197191

198-
```Enable binary directory fallback``` if enabled, falls back to the data directory when the specified binary
192+
- `Enable binary directory fallback` if enabled, falls back to the data directory when the specified binary
199193
directory is not writable.
200194

201-
```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not
195+
- `Data directory` directory where plugin-specific data such as session tokens and binaries are stored if not
202196
overridden by the binary directory setting.
203197

204-
```Header command``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
198+
- `Header command` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
205199
The environment variable CODER_URL will be available to the command process.
206200

207201
### TLS settings
208202

209203
The following options control the secure communication behavior of the plugin with Coder deployment and its available
210204
API.
211205

212-
```TLS cert path``` path to a client certificate file for TLS authentication with Coder deployment.
206+
- `TLS cert path` path to a client certificate file for TLS authentication with Coder deployment.
213207
The certificate should be in X.509 PEM format.
214208

215-
```TLS key path``` path to the private key corresponding to the TLS certificate from above.
209+
- `TLS key path` path to the private key corresponding to the TLS certificate from above.
216210
The certificate should be in X.509 PEM format.
217211

218-
```TLS CA path``` the path of a file containing certificates for an alternate certificate authority used to verify TLS
212+
- `TLS CA path` the path of a file containing certificates for an alternate certificate authority used to verify TLS
219213
certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
220214
proxy certificates.
221215

222-
```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname
216+
- `TLS alternate hostname` overrides the hostname used in TLS verification. This is useful when the hostname
223217
used to connect to the Coder deployment does not match the hostname in the TLS certificate.
224218

225219
### SSH settings
226220

227221
The following options control the SSH behavior of the Coder CLI.
228222

229-
```Disable autostart``` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
223+
- `Disable autostart` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
230224
workspaces constantly active.
231225

232-
```Enable SSH wildcard config``` enables or disables wildcard entries in the SSH configuration, which allow generic
226+
- `Enable SSH wildcard config` enables or disables wildcard entries in the SSH configuration, which allow generic
233227
rules for matching multiple workspaces.
234228

235-
```SSH proxy log directory``` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
229+
- `SSH proxy log directory` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
236230

237-
```SSH network metrics directory``` directory where network information used by the SSH proxy is stored.
231+
- `SSH network metrics directory` directory where network information used by the SSH proxy is stored.
238232

239-
```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of
233+
- `Extra SSH options` additional options appended to the SSH configuration. Can be used to customize the behavior of
240234
SSH connections.
241235

242236
### Saving Changes
243237

244238
Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard
245-
support,
246-
may trigger regeneration of SSH configurations.
239+
support, may trigger regeneration of SSH configurations.
247240

248241
### Security considerations
249242

250-
> ⚠️ **Attention:** Token authentication is required when TLS certificates are not configured.
243+
> [!IMPORTANT]
244+
> Token authentication is required when TLS certificates are not configured.
251245
252246
## Releasing
253247

@@ -261,4 +255,4 @@ may trigger regeneration of SSH configurations.
261255
- do **not** add any lambdas, handlers, or class handles to Java runtime hooks.
262256
- do **not** create threads manually (including via libraries). If you must, ensure they are properly cleaned up in the plugin's `CoderRemoteProvider#close()` method.
263257
- do **not** bundle libraries that are already provided by Toolbox.
264-
- do **not** perform any ill-intentioned actions.
258+
- do **not** perform any ill-intentioned actions.

0 commit comments

Comments
 (0)