teleport/docs
2016-12-16 22:07:28 -08:00
..
draw.io Documentation changes 2016-06-22 15:26:30 -07:00
img Fixed styles for teleport docs 2016-09-25 23:21:21 -07:00
theme Fixed image paths for the docs 2016-09-25 23:37:51 -07:00
admin-guide.md Docs changes to address issue #594 2016-12-16 22:07:28 -08:00
architecture.md Typo BoldDB->BoltDB 2016-09-29 09:48:43 +02:00
faq.md Fixed typos 2016-09-18 13:01:07 +10:00
quickstart.md Updated documentation to reflect packaging changes. 2016-11-17 20:34:08 -08:00
README.md Fixed typos 2016-09-18 13:01:07 +10:00
user-manual.md Fixed typos 2016-09-18 13:01:07 +10:00

Overview

Introduction

Gravitational Teleport ("Teleport") is a tool for remotely accessing isolated clusters of Linux servers via SSH or HTTPS. Unlike traditional key-based access, Teleport enables teams to easily adopt the following practices:

  • Avoid key distribution and trust on first use issues by using auto-expiring keys signed by a cluster certificate authority (CA).
  • Enforce 2nd factor authentication.
  • Connect to clusters located behind firewalls without direct Internet access via SSH bastions.
  • Record and replay SSH sessions for knowledge sharing and auditing purposes.
  • Collaboratively troubleshoot issues through session sharing.
  • Discover online servers and Docker containers within a cluster with dynamic node labels.

Teleport is built on top of the high-quality Golang SSH implementation and it is fully compatible with OpenSSH.

Why 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.

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 Gravity, our system for helping our clients to deploy and remotely manage their SaaS applications on many cloud regions or even on-premise.

Resources

To get started with Teleport we recommend starting with the Architecture Document. Then if you want to jump right in and play with Teleport, you can read the Quick Start. For a deeper understanding of how everything works and recommended production setup, please review the Admin Manual to setup Teleport and the User Manual for daily usage. There is also an FAQ where we'll be collecting common questions. Finally, you can always type tsh, tctl or teleport in terminal after Teleport has been installed to review those reference guides.

The best way to ask questions or file issues regarding Teleport is by creating a Github issue or pull request. Otherwise, you can reach us through the contact form or chat on our website.