teleport/docs/2.5
Ben Arent b0b7263296
Updated mkdocs base image used in Docs (#3314)
* WIP to update MkDocs base theme.
2020-02-04 15:58:15 -08:00
..
draw.io 2.5 docs 2018-02-25 18:27:34 -08:00
img fix docs typos and okta smal screenshots with unclear url 2018-11-18 11:00:00 -08:00
admin-guide.md Fix for #2951 (#2953) 2019-09-03 11:37:33 -07:00
architecture.md Documented certificate rotation 2018-05-03 17:44:29 -07:00
enterprise.md Spelling fix: retreive -> retrieve in all docs 2019-02-14 09:08:58 -08:00
faq.md Updated the links to "Teleport Pro" in the FAQ 2018-03-13 11:00:33 -07:00
index.md Updated mkdocs base image used in Docs (#3314) 2020-02-04 15:58:15 -08:00
oidc.md Update broken Keycloak link in docs 2019-05-31 14:13:20 -03:00
quickstart-enterprise.md minor edits to enterprise quickstart docs 2018-04-23 13:13:39 -07:00
quickstart.md Updated downlad links to the new location 2018-06-25 13:26:39 -07:00
README.md Update READMEs to correct Telekube URL 2018-04-04 09:03:25 -07:00
ssh_adfs.md Update ADFS docs (#3030) 2019-09-27 18:24:38 -03:00
ssh_okta.md Fix more options for Okta (#3019) 2019-09-24 16:42:52 -07:00
ssh_one_login.md Separated SAML guide into separate provider-specific pages 2018-04-06 16:34:31 -07:00
ssh_rbac.md Documented multi-role behavior 2018-04-19 17:59:12 -07:00
ssh_sso.md Spelling fix: retreive -> retrieve in all docs 2019-02-14 09:08:58 -08:00
trustedclusters.md Move --cluster to its correct location as a command subflag (#2758) 2019-06-05 13:46:30 -03:00
user-manual.md Move --cluster to its correct location as a command subflag (#2758) 2019-06-05 13:46:30 -03: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 Telekube, 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.