diff --git a/website/content/docs/api-clients/desktop.mdx b/website/content/docs/api-clients/desktop.mdx index abed8d1a0..9e89e2f99 100644 --- a/website/content/docs/api-clients/desktop.mdx +++ b/website/content/docs/api-clients/desktop.mdx @@ -8,8 +8,8 @@ description: |- # Boundary Desktop Boundary Desktop is a standalone application that provides a simple interface -for browsing and connecting to targets on your local computer (macOS currently -supported). Launch a session in Boundary Desktop and then make a connection +for browsing and connecting to targets on your local computer (macOS and Windows +currently supported). Launch a session in Boundary Desktop and then make a connection using your favorite tooling! ## Getting Started @@ -23,25 +23,76 @@ $ boundary dev ### Install Boundary Desktop -1. Download the latest .dmg installer from our [releases page](https://releases.hashicorp.com/boundary-desktop). Alternatively, if you're a homebrew user, you can run `brew install hashicorp-boundary-desktop` -1. Double-click the downloaded .dmg to run the installer -1. Drag and drop Boundary into the applications folder - ![](/img/boundary-desktop-drag-to-install.png) +1. Download the latest .dmg installer or .exe archive from our [releases page](https://releases.hashicorp.com/boundary-desktop). Alternatively, if you're a homebrew user, you can run `brew install hashicorp-boundary-desktop` +1. In macOS, double-click the downloaded .dmg to run the installer by draggin and dropping Boundary into the applications folder + ![](/img/desktop/macos/boundary-desktop-drag-to-install.png) +1. In Windows, extract downloaded archive and find .exe to launch ### Run Boundary Desktop 1. Open the Boundary Desktop application - ![](/img/boundary-desktop-open.png) + + + + +![](/img/desktop/macos/boundary-desktop-open.png) + + + + +![](/img/desktop/windows/boundary-desktop-open.png) + + + + 1. You'll be prompted for the Boundary server origin, this is the URL for the client to connect to the Boundary API. If you are running a local `dev` mode server, this URL will be `http://localhost:9200` - ![](/img/boundary-desktop-origin.png) + + + + +![](/img/desktop/macos/boundary-desktop-origin.png) + + + + +![](/img/desktop/windows/boundary-desktop-origin.png) + + + + 1. You can now login to Boundary. We're using a `dev` mode server in this example with the username `admin` and the password `password` - ![](/img/boundary-desktop-login.png) + + + + +![](/img/desktop/macos/boundary-desktop-login.png) + + + + +![](/img/desktop/windows/boundary-desktop-login.png) + + + + 1. After logging in, you should see the targets your user is authorized to connect to. Since we are using a `dev` mode server we see the default generated target for `127.0.0.1:22` - ![](/img/boundary-desktop-landing.png) + + + + +![](/img/desktop/macos/boundary-desktop-landing.png) + + + + +![](/img/desktop/windows/boundary-desktop-landing.png) + + + ### Connect! @@ -49,10 +100,35 @@ $ boundary dev 1. Click on `connect` next to the default target. A pop-up window will display the local address of the proxy and the ephemeral port for the session - ![](/img/boundary-desktop-connect.png) + + + + +![](/img/desktop/macos/boundary-desktop-connect.png) + + + + +![](/img/desktop/windows/boundary-desktop-connect.png) + + + + 1. Navigate to the `Sessions` pane and you'll see this session is in `pending` state because we haven't made a connection to it yet (but will!) - ![](/img/boundary-desktop-pending.png) + + + + +![](/img/desktop/macos/boundary-desktop-pending.png) + + + + +![](/img/desktop/windows/boundary-desktop-pending.png) + + + -> The next step assumes you have a SSH server running that the default target will connect to. @@ -70,7 +146,33 @@ $ ``` 1. Navigate back to the sessions view and you'll see this session is now active - ![](/img/boundary-desktop-active.png) + + + + +![](/img/desktop/macos/boundary-desktop-active.png) + + + + +![](/img/desktop/windows/boundary-desktop-active.png) + + + + 1. Click `Cancel` to cancel the session and you'll see the status go to `canceling` briefly, then `terminated` - ![](/img/boundary-desktop-terminated.png) + + + + +![](/img/desktop/macos/boundary-desktop-terminated.png) + + + + +![](/img/desktop/windows/boundary-desktop-terminated.png) + + + + 1. Navigate back to the CLI and you'll see your SSH session has closed diff --git a/website/public/img/boundary-desktop-active.png b/website/public/img/desktop/macos/boundary-desktop-active.png similarity index 100% rename from website/public/img/boundary-desktop-active.png rename to website/public/img/desktop/macos/boundary-desktop-active.png diff --git a/website/public/img/boundary-desktop-connect.png b/website/public/img/desktop/macos/boundary-desktop-connect.png similarity index 100% rename from website/public/img/boundary-desktop-connect.png rename to website/public/img/desktop/macos/boundary-desktop-connect.png diff --git a/website/public/img/boundary-desktop-drag-to-install.png b/website/public/img/desktop/macos/boundary-desktop-drag-to-install.png similarity index 100% rename from website/public/img/boundary-desktop-drag-to-install.png rename to website/public/img/desktop/macos/boundary-desktop-drag-to-install.png diff --git a/website/public/img/boundary-desktop-landing.png b/website/public/img/desktop/macos/boundary-desktop-landing.png similarity index 100% rename from website/public/img/boundary-desktop-landing.png rename to website/public/img/desktop/macos/boundary-desktop-landing.png diff --git a/website/public/img/boundary-desktop-login.png b/website/public/img/desktop/macos/boundary-desktop-login.png similarity index 100% rename from website/public/img/boundary-desktop-login.png rename to website/public/img/desktop/macos/boundary-desktop-login.png diff --git a/website/public/img/boundary-desktop-open.png b/website/public/img/desktop/macos/boundary-desktop-open.png similarity index 100% rename from website/public/img/boundary-desktop-open.png rename to website/public/img/desktop/macos/boundary-desktop-open.png diff --git a/website/public/img/boundary-desktop-origin.png b/website/public/img/desktop/macos/boundary-desktop-origin.png similarity index 100% rename from website/public/img/boundary-desktop-origin.png rename to website/public/img/desktop/macos/boundary-desktop-origin.png diff --git a/website/public/img/boundary-desktop-pending.png b/website/public/img/desktop/macos/boundary-desktop-pending.png similarity index 100% rename from website/public/img/boundary-desktop-pending.png rename to website/public/img/desktop/macos/boundary-desktop-pending.png diff --git a/website/public/img/boundary-desktop-terminated.png b/website/public/img/desktop/macos/boundary-desktop-terminated.png similarity index 100% rename from website/public/img/boundary-desktop-terminated.png rename to website/public/img/desktop/macos/boundary-desktop-terminated.png diff --git a/website/public/img/desktop/windows/boundary-desktop-active.png b/website/public/img/desktop/windows/boundary-desktop-active.png new file mode 100644 index 000000000..bac5c7bb4 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-active.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-connect.png b/website/public/img/desktop/windows/boundary-desktop-connect.png new file mode 100644 index 000000000..3f9d778e2 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-connect.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-landing.png b/website/public/img/desktop/windows/boundary-desktop-landing.png new file mode 100644 index 000000000..7ec1df305 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-landing.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-login.png b/website/public/img/desktop/windows/boundary-desktop-login.png new file mode 100644 index 000000000..1c65552e2 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-login.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-open.png b/website/public/img/desktop/windows/boundary-desktop-open.png new file mode 100644 index 000000000..077e518f8 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-open.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-origin.png b/website/public/img/desktop/windows/boundary-desktop-origin.png new file mode 100644 index 000000000..f30bf22fc Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-origin.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-pending.png b/website/public/img/desktop/windows/boundary-desktop-pending.png new file mode 100644 index 000000000..f9c546dcf Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-pending.png differ diff --git a/website/public/img/desktop/windows/boundary-desktop-terminated.png b/website/public/img/desktop/windows/boundary-desktop-terminated.png new file mode 100644 index 000000000..872313355 Binary files /dev/null and b/website/public/img/desktop/windows/boundary-desktop-terminated.png differ