Introduction to Teleport Clients
- Available for:
This guide covers the basics of authenticating to Teleport and accessing resources. It's written for end-users of resources protected by Teleport, and includes links to more detailed documentation at the end.
tsh lets you authenticate to Teleport and list and connect to resources. After
downloading and installing
tsh, sign in to
your Teleport cluster:
The Teleport Connect app provides all the same access to resources as
a friendly graphic user interface. After downloading
and installing Teleport Connect, you can log in and initiate sessions for
server and database access within a single window.
Click CONNECT to connect to the Teleport cluster:
Provide the address of your Teleport Cluster (e.g.
https://example.teleport.sh) and click NEXT.
Teleport Connect will ask you for your username, password, and MFA.
If Teleport is integrated with an external Identity Provider (IdP), you might be prompted to authenticate with that service in a browser window.
Browse and connect to all the resources your user is permitted to access:
Teleport provides a web interface for users to interact with Teleport, e.g., by
accessing resources or creating Access Requests. This is usually found at the
same URL used to connect to Teleport with (e.g.
but you should confirm the Web UI URL with the team that manages your Teleport
The Web UI provides similar access to resources as Teleport Connect, and additional access to to Request and Activity logs for users with the right permissions.
tsh scp will let you transfer files to servers behind Teleport:
tsh scp some-file.ext server.example.com:some-file.ext 7% |███████ | (25/342 MB, 2.9 MB/s) [9s:1m48s]
Desktop access is available through the Teleport Web UI.
- In your browser, navigate to your Teleport cluster (for example,
- From the menu on the right, select Desktops.
- Next to the desktop you want to access, click CONNECT. Select or type in a username available to your Teleport user.
- Teleport will open a new browser tab or window and begin the RDP session. Note that you may need to wait a moment for Teleport to log you in as the specified user.
This guide covers the basic installation and access of Teleport for end users, but the rest of the Connect your Client section provides more detailed information.
tshis the CLI tool for accessing resources through Teleport. With it, you can authenticate to Teleport, list available services, and connect to them either directly or through proxy tunnels.
Learn more about it from Using the tsh Command Line Tool.
Teleport Connect is a graphic utility for connecting to resources through Teleport. You use it to connect to servers, databases, and Kubernetes clusters. See Using Teleport Connect.
- Database Access GUI Clients details how to connect many popular database GUI clients through Teleport.