Go JavaScript CSS Makefile Shell C Other
Switch branches/tags
Clone or download
russjones Merge pull request #2077 from gravitational/rjones/protobuf-web-term
Use protobufs to communicate between proxy and web client.
Latest commit 0561ab1 Jul 16, 2018
Failed to load latest commit information.
assets Add Jenkins jobs for building OSS/Enterprise AMIs for submitting to A… Jun 7, 2018
build.assets Add support for running tests in K8s Jun 15, 2018
docker Update test plan and add sshd flow Mar 2, 2018
docs Fix documentation typos Jul 6, 2018
e @ 4d7cc9e Update Enterprise reference. Jun 22, 2018
examples Idiomatic helm chart for Teleport Jul 6, 2018
fixtures Process ENV_PATH and ENV_SUPATH from login.defs. Jun 14, 2017
integration Updated dir backend to a flat keyspace. Added UpsertItems endpoint to Jul 13, 2018
lib Use protobufs to communicate between proxy and web client. Jul 16, 2018
modules/pam_teleport Added PAM support to Teleport. Mar 20, 2018
tool Updated dir backend to a flat keyspace. Added UpsertItems endpoint to Jul 13, 2018
vagrant Issue 1536 - adds Vagrant support for VMware Fusion Jan 2, 2018
vendor Use protobufs to communicate between proxy and web client. Jul 16, 2018
web Use protobufs to communicate between proxy and web client. Jul 16, 2018
.gitattributes fix linguist stats for project Jun 2, 2016
.gitignore Changes to RBAC chapter Apr 6, 2018
.gitmodules Added enterprise submodule Jun 22, 2017
CHANGELOG.md Updated CHANGELOG.md. Jul 13, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Dec 18, 2017
Gopkg.lock Use protobufs to communicate between proxy and web client. Jul 16, 2018
Gopkg.toml Use protobufs to communicate between proxy and web client. Jul 16, 2018
LICENSE Apply apache license to teleport Oct 31, 2015
Makefile Remove -i flag from "go build". Jun 22, 2018
README.md Updated downlad links to the new location Jun 25, 2018
constants.go Use protobufs to communicate between proxy and web client. Jul 16, 2018
doc.go Added proper comments to `teleport` package Jan 4, 2017
roles.go Mutual TLS Auth server and clients. Dec 27, 2017
version.go Release 2.7.0-alpha.5 Jun 21, 2018
version.mk Added proper comments to `teleport` package Jan 4, 2017


Gravitational Teleport

Gravitational Teleport is a modern SSH server for remotely accessing clusters of Linux servers via SSH or HTTPS. It is intended to be used instead of sshd for organizations who need:

  • SSH audit with session recording/replay.
  • Easily manage SSH trust between teams, organizations and data centers.
  • SSH into behind-firewall clusters without any open ports.
  • Role-based access control (RBAC) for SSH protocol.

In addition to its hallmark features, Teleport is interesting for smaller teams because it facilitates easy adoption of the best SSH practices like:

  • No need to distribute keys: Teleport uses certificate-based access with automatic certificate expiration time.
  • 2nd factor authentication (2FA) for SSH.
  • Collaboratively troubleshoot issues through session sharing.
  • Single sign-on (SSO) for SSH and your organization identities via OpenID Connect or SAML with endpoints like Okta or Active Directory.
  • Cluster introspection: every SSH node and its status can be queried via CLI and Web UI.

Teleport is built on top of the high-quality Golang SSH implementation and it is fully compatible with OpenSSH and can be used with sshd servers and ssh clients.

Project Links Description
Teleport Website The official website of the project
Documentation Admin guide, user manual and more
Demo Video 3-minute video overview of the UI.
Teleconsole The free service to "invite" SSH clients behind NAT, built on top of Teleport
Blog Our blog where we publish Teleport news

Installing and Running

Download the latest binary release, unpack the .tar.gz and run sudo ./install. This will copy Teleport binaries into /usr/local/bin.

Then you can run Teleport as a single-node cluster:

$ sudo teleport start 

In a production environment Teleport must run as root. But to play, just do chown $USER /var/lib/teleport and run it under $USER, in this case you will not be able to login as someone else though.

Building Teleport

Teleport source code consists of the actual Teleport daemon binary written in Golang, and also it has a web UI (located in /web directory) written in Javascript. The WebUI is not changed often and we keep it checked into Git under /dist, so you only need to build Golang:

Make sure you have Golang v1.8.3 or newer, then run:

# 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 full

# create the default data directory before starting:
$ sudo mkdir -p /var/lib/teleport
$ sudo chown $USER /var/lib/teleport

If the build succeds the binaries will be placed in $GOPATH/src/github.com/gravitational/teleport/build

NOTE: The Go compiler is somewhat sensitive to amount of memory: you will need at least 1GB of virtual memory to compile Teleport. 512MB instance without swap will not work.

Rebuilding Web UI

To enable speedy iterations on the Web UI, teleport can load the web UI assets from the source directory. To enable this behavior, set the environment variable DEBUG=1 and rebuild with the default target:

$ make

# Run Teleport as a single-node cluster in development mode: 
$ DEBUG=1 ./build/teleport start -d

Keep the server running in this mode, and make your UI changes in /dist directory. Refer to web/README.md for instructions on how to update the Web UI.

Why did We Build Teleport?

Mature tech companies with significant infrastructure footprints tend to implement most of these patterns internally. Teleport allows smaller companies without significant in-house SSH expertise to easily adopt them, as well. Teleport comes with an accessible Web UI and a very permissive Apache 2.0 license to facilitate adoption and use.

Being a complete standalone tool, Teleport can be used as a software library enabling trust management in complex multi-cluster, multi-region scenarios across many teams within multiple organizations.

More Information


The best way to contribute is to create issues or pull requests right here on Github. You can also reach the Gravitational team through their website

Is Teleport Secure and Production Ready?

Teleport has completed several security audits from the nationally recognized technology security companies. Some of them have been made public. We are comfortable with the use of Teleport from a security perspective.

However, Teleport is still a relatively young product so you may experience usability issues. We are actively supporting Teleport and addressing any issues that are submitted to this repo. Ask questions, send pull requests, report issues and don't be shy! :)

The latest stable Teleport build can be found in Releases

Known Issues

  • Teleport does not officially support IPv6 yet.

Who Built Teleport?

Teleport was created by Gravitational Inc. We have built Teleport by borrowing from our previous experiences at Rackspace. It has been extracted from Telekube, our Kubernetes distribution optimized for deploying and remotely controlling complex applications into multiple environments at the same time:

  • Multiple cloud regions
  • Colocation
  • Private enterprise clouds located behind firewalls