Teleport core service
teleport and admin tool
tctl have been designed to run on Linux and Mac operating systems. The Teleport user client
tsh and UI are available for Linux, Mac, and Windows operating systems.
The following examples install the 64-bit version of Teleport binaries, but 32-bit (i386) and ARM binaries are also available. Check the Latest Release page for the most up-to-date information.
The examples below may include the use of the
sudo keyword, token UUIDs, and users with
admin privileges to make following each step easier when creating resources from scratch.
- We discourage using
sudoin production environments unless it's needed.
- We encourage creating new, non-root, users or new test instances for experimenting with Teleport.
- We encourage adherence to the Principle of Least Privilege (PoLP) and Zero Admin best practices. Don't give users the
adminrole when giving them the more restrictive
access,editorroles will do instead.
- Saving tokens into a file rather than sharing tokens directly as strings.
Learn more about Teleport Role-Based Access Control best practices.
# Install our public key. curl https://deb.releases.teleport.dev/teleport-pubkey.asc | sudo apt-key add - # Add repo to APT add-apt-repository 'deb https://deb.releases.teleport.dev/ stable main' # Update APT Cache apt-get update # Install Teleport apt install teleport
docker pull quay.io/gravitational/teleport:6.2.1
Please follow our Helm Chart Readme for install and setup instructions.
helm repo add teleport https://charts.releases.teleport.dev helm install teleport teleport/teleport
Download MacOS .pkg installer (tsh client only, signed) file, double-click to run the Installer.
tshclient for interacting with Teleport clusters. If you need the
tctladmin tool, use the "Terminal" method instead.
As of version v3.0.1 we have
tsh client binary available for Windows 64-bit
tctl are not supported.
curl https://get.gravitational.com/teleport-v6.2.1-windows-amd64-bin.zip.sha256 # <checksum> <filename> curl -O teleport-v6.2.1-windows-amd64-bin.zip https://get.gravitational.com/teleport-v6.2.1-windows-amd64-bin.zip echo %PATH% # Edit %PATH% if necessary certUtil -hashfile teleport-v6.2.1-windows-amd64-bin.zip SHA256 # SHA256 hash of teleport-v6.2.1-windows-amd64-bin.zip: # <checksum> <filename> # CertUtil: -hashfile command completed successfully. # Verify that the checksums match # Move `tsh` to your %PATH%
Gravitational Teleport is written in Go language. It requires Golang v1.16 or newer. Check the repo README for the latest requirements.
If you don't already have Golang installed you can see installation instructions here. If you are new to Go there are a few quick setup things to note:
- Go installs all dependencies for all projects in a single directory determined by the
$GOPATHvariable. The default directory is
GOPATH=$HOME/gobut you can set it to any directory you wish.
- If you plan to use Golang for more than just this installation you may want to
echo "export GOPATH=$HOME/go" >> ~/.bashrc(or your shell config).
# get the source & build: mkdir -p $GOPATH/src/github.com/gravitational cd $GOPATH/src/github.com/gravitational git clone https://github.com/gravitational/teleport.git cd teleport # Make sure you have `zip` installed - the Makefile uses it make full # create the default data directory before running `teleport` sudo mkdir -p /var/lib/teleport sudo chown $USER /var/lib/teleport
If the build succeeds, the binaries
teleport, tsh, and
tctl are now in the directory
Gravitational Teleport provides a checksum from the Downloads. This should be used to verify the integrity of our binary.
If you download Teleport via an automated system, you can programmatically
obtain the checksum by adding
.sha256 to the binary. This is the method shown
in the installation examples.
export version=v6.2.1 export os=linux # 'darwin' 'linux' or 'windows' export arch=amd64 # '386' 'arm' on linux or 'amd64' for all distros curl https://get.gravitational.com/teleport-$version-$os-$arch-bin.tar.gz.sha256 # <checksum> <filename>
Teleport is officially supported on the platforms listed below. It is worth noting that the open-source community has been successful in building and running Teleport on UNIX variants other than Linux .
|Operating System||Teleport Client||Teleport Server|
|Windows ||yes ||no|
 Teleport is written in Go and it's possible to build it on any OS supported by the Golang toolchain.
 Teleport server does not run on Windows yet, but
tsh (the Teleport client)
can be used on Windows to execute
tsh login to retrieve a user's SSH
certificate and use it with
ssh, the OpenSSH client, running on a Windows