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.

# 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:6.1.0

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-v6.1.0-windows-amd64-bin.zip.sha256
# <checksum> <filename>
> curl -O teleport-v6.1.0-windows-amd64-bin.zip https://get.gravitational.com/teleport-v6.1.0-windows-amd64-bin.zip
> echo %PATH% # Edit %PATH% if necessary
> certUtil -hashfile teleport-v6.1.0-windows-amd64-bin.zip SHA256
SHA256 hash of teleport-v6.1.0-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 set up 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=v6.1.0
$ 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>
Have a suggestion or can’t find something?
IMPROVE THE DOCS