Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/img/use-teleport/connect-cluster.png
Binary file not shown.
Binary file added docs/img/use-teleport/connect-cluster@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/use-teleport/connect-ui-overview.png
Binary file not shown.
Binary file added docs/img/use-teleport/connect-ui-overview@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- A macOS or Linux device.
- Teleport Connect v14.1+, on the same major version or one version behind the proxy version. See
[version compatibility](../../faq.mdx#version-compatibility).
- A local Teleport user: you authenticate using credentials or passwordless login, you don't
use SSO to log in to the cluster.
- Teleport Connect v14.1+, on the same major version or one version behind the Teleport Proxy
Service version. See [version compatibility](../../faq.mdx#version-compatibility).
- A local Teleport user: you must authenticate using credentials or passwordless login, and not with
SSO.
- Permissions to create join tokens (verb `create` for [the `token` resource](../../access-controls/reference.mdx#teleport-resources)).
2 changes: 1 addition & 1 deletion docs/pages/connect-your-client/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ server and database access within a single window.

1. Browse and connect to all the resources your user is permitted to access:

![An example of Teleport Connect, populated with instances](../../img/use-teleport/connect-ui-overview.png)
![An example of Teleport Connect, populated with instances](../../img/use-teleport/connect-ui-overview@2x.png)

### Web UI

Expand Down
16 changes: 11 additions & 5 deletions docs/pages/connect-your-client/teleport-connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Using Teleport Connect
Teleport Connect provides easy and secure access to SSH servers, databases, and Kubernetes clusters,
with support for other resources coming in the future.

![resources tab in Teleport Connect](../../img/use-teleport/connect-cluster.png)
![resources tab in Teleport Connect](../../img/use-teleport/connect-cluster@2x.png)

## Installation & upgrade

Expand Down Expand Up @@ -46,7 +46,7 @@ $ "Teleport Connect Setup-(=teleport.version=).exe" /S

## User interface

![user interface of Teleport Connect](../../img/use-teleport/connect-ui-overview.png)
![user interface of Teleport Connect](../../img/use-teleport/connect-ui-overview@2x.png)

The top bar of Teleport Connect consists of:

Expand All @@ -69,12 +69,12 @@ which cluster the current tab is bound to, and the **Share Feedback** button in
Connect My Computer makes it possible to add your personal machine to a Teleport cluster in just a
couple of clicks.

It is the easiest way to add a computer to the cluster, whether you're just exploring the
capabilities of Teleport or want your computer to be available in a Teleport-powered home lab.
It is the easiest way to add a computer to the cluster, whether you're exploring the capabilities of
Teleport or want your computer to be available in a Teleport-powered home lab.

Connect My Computer sets up a Teleport agent managed completely by Teleport Connect, without having
to use the terminal to get the job done and without the need for tools like `systemctl` to control
agent lifecycle.
the lifecycle of the agent.

### Prerequisites

Expand All @@ -92,6 +92,8 @@ as logging in as other system users or [host user creation](../server-access/gui
To begin the setup, click on the laptop icon in the top left and select "Connect My Computer". The
new tab will guide you through an interaction-free setup. Click "Connect" to start the setup.

![Connect My Computer in the top bar](../../img/use-teleport/connect-my-computer-top-bar@2x.png)

The setup creates a new role in the cluster which grants access to your device as the current system
user. The role is then added to your user object.

Expand All @@ -110,10 +112,14 @@ Next, the setup downloads a Teleport agent for your platform and runs `teleport
pointed at the current cluster. Once that is done, Connect My Computer starts the agent and waits
for it to show up in the cluster as an SSH node.

![Connect My Computer setup](../../img/use-teleport/connect-my-computer-setup@2x.png)

After the agent joins the cluster, the tab transitions to showing the status of the agent. From
here, you can connect to the node made available by the agent, stop and start the agent, as well as
completely remove it. Manually logging out of the cluster will remove the agent as well.

![Connect My Computer status](../../img/use-teleport/connect-my-computer-status@2x.png)

Your computer will be shared while Teleport Connect is open. To stop sharing, close Teleport Connect
or stop the agent through the Connect My Computer tab. Sharing will resume on app restart, unless
you stop the agent before exiting. The agent stops immediately if Teleport Connect unexpectedly
Expand Down