Skip to content

Commit 02acfd0

Browse files
docs: move important note about Coder CLI and Desktop requirements for Fleet and remove unecessary README explanations
1 parent a665405 commit 02acfd0

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

registry/coder/modules/fleet-ide/README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ module "fleet_ide" {
2929
- JetBrains Fleet must be installed locally on your development machine
3030
- Download Fleet from: https://www.jetbrains.com/fleet/
3131

32+
> [IMPORTANT]
33+
> Fleet needs you to either have Coder CLI installed with `coder config-ssh` run or [Coder Desktop](https://coder.com/docs/user-guides/desktop).
34+
3235
## Examples
3336

3437
### Basic usage
@@ -67,21 +70,3 @@ module "fleet_ide" {
6770
order = 1
6871
}
6972
```
70-
71-
## How it works
72-
73-
1. The module creates an external app link in your Coder workspace
74-
2. When clicked, it generates a `fleet://` URI that instructs Fleet to connect via SSH
75-
3. Fleet connects to your workspace using the SSH credentials provided by Coder
76-
> [IMPORTANT]
77-
> Fleet needs you to either have Coder CLI installed with `coder config-ssh` run or [Coder Desktop](https://coder.com/docs/user-guides/desktop).
78-
79-
## SSH Connection
80-
81-
Fleet uses SSH to connect to your workspace. The connection URL format is:
82-
83-
```
84-
fleet://fleet.ssh/<workspace-url>?pwd=<folder>
85-
```
86-
87-
Fleet will automatically manage the SSH connection and handle connection reuse as needed.

0 commit comments

Comments
 (0)