Fork me on GitHub
Teleport

Installation

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.

Linux

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.

Tip

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.

Generally:

  1. We discourage using sudo in production environments unless it's needed.
  2. We encourage creating new, non-root, users or new test instances for experimenting with Teleport.
  3. We encourage adherence to the Principle of Least Privilege (PoLP) and Zero Admin best practices. Don't give users the admin role when giving them the more restrictive access,editor roles will do instead.
  4. 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

Please follow our Getting started with Teleport using Docker or with Teleport Enterprise using Docker for install and setup instructions.

docker pull quay.io/gravitational/teleport:7.1.2

Helm

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

MacOS

Download MacOS .pkg installer (tsh client only, signed) file, double-click to run the Installer.

Note
This method only installs the tsh client for interacting with Teleport clusters. If you need the teleport server or tctl admin tool, use the "Terminal" method instead.

Windows (tsh client only)

As of version v3.0.1 we have tsh client binary available for Windows 64-bit architecture - teleport and tctl are not supported.

curl https://get.gravitational.com/teleport-v7.1.2-windows-amd64-bin.zip.sha256

<checksum> <filename>

curl -O teleport-v7.1.2-windows-amd64-bin.zip https://get.gravitational.com/teleport-v7.1.2-windows-amd64-bin.zip
echo %PATH% # Edit %PATH% if necessary
certUtil -hashfile teleport-v7.1.2-windows-amd64-bin.zip SHA256

SHA256 hash of teleport-v7.1.2-windows-amd64-bin.zip:

<checksum> <filename>

CertUtil: -hashfile command completed successfully.

Verify that the checksums match

Move `tsh` to your %PATH%

Installing from source

Gravitational Teleport is written in Go language. It requires Golang v1.16 or newer. Check the repo README for the latest requirements.

Install Go

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 $GOPATH variable. The default directory is GOPATH=$HOME/go but 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).

Build Teleport

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 $GOPATH/src/github.com/gravitational/teleport/build

Checksums

Gravitational Teleport provides a checksum from the Downloads. This should be used to verify the integrity of our binary.

Teleport Checksum

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=v7.1.2
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>

Operating System support

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 [1].

Operating SystemTeleport ClientTeleport Server
Linux v2.6.23+yesyes
MacOS v10.12+yesyes
Windows [2]yes [2]no

[1] Teleport is written in Go and it's possible to build it on any OS supported by the Golang toolchain.

[2] 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 client machine.

Have a suggestion or can’t find something?
IMPROVE THE DOCS