teleport README

The project's README from github.com/gravitational/teleport. As one markdown file: README.md.

Teleport provides connectivity, authentication, access controls and audit for infrastructure.

You might use Teleport to:

Teleport works with SSH, Kubernetes, databases, RDP, cloud consoles, internal web services, Git repositories, and Model Context Protocol (MCP) servers.


More Information

Teleport Getting Started
Teleport Architecture
Reference Guides
FAQ

Table of Contents

  1. Introduction
  2. Why We Built Teleport
  3. Supporting and Contributing
  4. Installing and Running
  5. Docker
  6. Building Teleport
  7. License
  8. FAQ

Introduction

Teleport includes an identity-aware access proxy, a CA that issues short-lived certificates, a unified access control system, and a tunneling system to access resources behind the firewall.

Teleport is a single Go binary that integrates with multiple protocols and cloud services, including

You can set up Teleport as a Linux daemon or a Kubernetes deployment.

Teleport focuses on best practices for infrastructure security, including:

Teleport uses Go crypto. It is fully compatible with OpenSSH, sshd servers, and ssh clients, Kubernetes clusters and more.

Project Links Description
Teleport Website The official website of the project.
Documentation Admin guide, user manual and more.
Features Explore the complete list of Teleport capabilities.
Blog Our blog where we publish Teleport news and helpful articles.
Forum Ask us a setup question or post tutorials, feedback, or ideas.
Developer Tools Dozens of free browser-based tools for code processing, cryptography, data transformation, and more.
Teleport Academy How-to guides, best practices, and deep dives into topics like SSH, Kubernetes, MCP, and more.
Slack Need help with your setup? Ping us in our Slack channel.
Cloud & Self-Hosted Teleport Enterprise is a cloud-hosted option for teams that require easy and secure access to their computing environments.

Why We Built Teleport

While working together at Rackspace, the creators of Teleport noticed that most cloud users struggle with setting up and configuring infrastructure security. Many popular tools designed for this are complex to understand and expensive to maintain across modern, distributed computing infrastructure.

We decided to build a solution that's easy to use, understand, and scale. A real-time representation of all your servers in the same room as you, as if they were magically teleported. And thus, Teleport was born!

Today, Teleport is trusted by everyone from hobbyists to hyperscalers to simplify security across cloud CLIs and consoles, Kubernetes clusters, SSH servers, databases, internal web apps, and Model Context Protocol (MCP) used by AI agents.

Learn more about Teleport and our history

Supporting and Contributing

We aim to make Teleport easy to adopt and contribute to, starting with clear and comprehensive documentation.

If you have questions, are exploring ideas, or want to sanity-check something, please start with a GitHub Discussion. Discussions help us answer questions, explore use cases, and decide together whether something should become a bug report or feature request.

Installing and Running

To set up a single-instance Teleport cluster, follow our getting started guide. You can then register your servers, Kubernetes clusters, and other infrastructure with your Teleport cluster.

You can also get started with Teleport Enterprise Cloud, a managed Teleport deployment that makes it easier to enable secure access to your infrastructure.

Sign up for a free trial of Teleport Enterprise Cloud, and follow this guide to register your first server.

Docker

Deploy Teleport

If you wish to deploy Teleport inside a Docker container see the installation guide.

For Local Testing and Development

To run a full test suite locally, see the test dependencies list

Building Teleport

The teleport repository contains the Teleport daemon binary (written in Go) and a web UI written in TypeScript.

If your intention is to build and deploy for use in a production infrastructure a released tag should be used. The default branch, master, is the current development branch for an upcoming major version. Get the latest release tags listed at https://goteleport.com/download/ and then use that tag in the git clone. For example git clone https://github.com/gravitational/teleport.git -b v18.5.0 gets release v18.5.0.

Dockerized Build

It is often easiest to build with Docker, which ensures that all required tooling is available for the build. To execute a dockerized build, ensure that docker is installed and running, and execute:

make -C build.assets build-binaries

This command will build Linux binaries matching the host architecture. It is not possible to cross-compile to a different target architecture.

Local Build

Dependencies

The following dependencies are required to build Teleport from source. For maximum compatibility, install the versions of these dependencies using the versions listed in build.assets/versions.mk:

  1. Go
  2. Rust
  3. Node.js
  4. libfido2
  5. pkg-config

For an example of dev environment setup on macOS, see these instructions.

Perform a build

Important

  • The Go compiler is somewhat sensitive to the amount of memory: you will need at least 1GB of virtual memory to compile Teleport. A 512MB instance without swap will not work.
    • This will build the latest version of Teleport.

Get the source

git clone https://github.com/gravitational/teleport.git
cd teleport

To perform a build

make full

tsh dynamically links against libfido2 by default, to support development environments, as long as the library itself can be found:

$ brew install libfido2 pkg-config  # Replace with your package manager of choice

$ make build/tsh
> libfido2 found, setting FIDO2=dynamic
> (...)

Release binaries are linked statically against libfido2. You may switch the linking mode using the FIDO2 variable:

make build/tsh FIDO2=dynamic # dynamic linking
make build/tsh FIDO2=static  # static linking, for an easy setup use `make enter`
                             # or `build.assets/macos/build-fido2-macos.sh`.
make build/tsh FIDO2=off     # doesn't link libfido2 in any way

tsh builds with Touch ID support require access to an Apple Developer account. If you are a Teleport maintainer, ask the team for access.

Build output and run locally

If the build succeeds, the installer will place the binaries in the build directory.

Before starting, create default data directories:

sudo mkdir -p -m0700 /var/lib/teleport
sudo chown $USER /var/lib/teleport

Running Teleport in a hot reload mode

To speed up your development process, you can run Teleport using CompileDaemon. This will build and run the Teleport binary, and then rebuild and restart it whenever any Go source files change.

  1. Install CompileDaemon:

    go install github.com/githubnemo/CompileDaemon@latest
    

    Note that we use go install instead of the suggested go get, because we don't want CompileDaemon to become a dependency of the project.

  2. Build and run the Teleport binary:

    make teleport-hot-reload
    

    By default, this runs a teleport start command. If you want to customize the command, for example by providing a custom config file location, you can use the TELEPORT_ARGS parameter:

    make teleport-hot-reload TELEPORT_ARGS='start --config=/path/to/config.yaml'
    

Note that you still need to run make grpc if you modify any Protocol Buffers files to regenerate the generated Go sources; regenerating these sources should in turn cause the CompileDaemon to rebuild and restart Teleport.

Web UI

The Teleport Web UI resides in the web directory.

Rebuilding Web UI for development

To rebuild the Teleport UI package, run the following command:

make docker-ui

Then you can replace Teleport Web UI files with the files from the newly-generated /dist folder.

To enable speedy iterations on the Web UI, you can run a local web-dev server.

You can also tell Teleport to 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:

# 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. For instructions about how to update the Web UI, read the web README.

Managing dependencies

All dependencies are managed using Go modules. Here are the instructions for some common tasks:

Add a new dependency

Latest version:

go get github.com/new/dependency

and update the source to use this dependency.

To get a specific version, use go get github.com/new/dependency@version instead.

Set dependency to a specific version

go get github.com/new/dependency@version

Update dependency to the latest version

go get -u github.com/new/dependency

Update all dependencies

go get -u all

Debugging dependencies

Why is a specific package imported?

go mod why $pkgname

Why is a specific module imported?

go mod why -m $modname

Why is a specific version of a module imported?

go mod graph | grep $modname

License

Teleport is distributed in multiple forms with different licensing implications.

The Teleport API module (all code in this repository under /api) is available under the Apache 2.0 license.

The remainder of the source code in this repository is available under the GNU Affero General Public License. Users compiling Teleport from source must comply with the terms of this license.

Teleport Community Edition builds distributed on http://goteleport.com/download are available under a modified Apache 2.0 license.

FAQ

Is Teleport production-ready?

Yes, Teleport is production-ready and used to protect and facilitate access to the most precious and mission-critical applications at many of today's leading companies. You can learn more about the companies using Teleport in production on our website.

Is Teleport secure?

Yes, Teleport has completed several security audits from nationally and internationally recognized technology security companies. We publicize audit results, our security philosophy, and related information on our trust page.

What resources does Teleport support?

Teleport secures access to a broad set of infrastructure resources, including Linux servers, Windows desktops, Kubernetes clusters, databases, internal web applications, cloud provider APIs and consoles (such as AWS, Azure, and GCP), and Model Context Protocol (MCP) servers used by AI agents.

How is Teleport deployed?

Teleport can be deployed to fit most environments, either as a self-hosted cluster on Linux or Kubernetes or using Teleport Enterprise Cloud. In all cases, Teleport agents run close to your resources and connect through an Auth Service and Proxy Service that enforces identity, access control, and audit.

Is Teleport an identity provider (IdP)?

Teleport uses existing IdPs (Okta, Google Workspace, Microsoft Entra ID, or GitHub) to issue short-lived certificates and apply access policies. Teleport can also be configured to act as a SAML IdP to authenticate users into applications when needed.

Does Teleport require credential handling or secrets management?

Teleport eliminates long-lived passwords, SSH keys, database credentials, credential rotations, and vault processes by issuing short-lived, auto-expiring mTLS and SSH certificates bound to human or non-human identity.

Is Teleport a Privileged Access Management (PAM) solution?

Teleport provides modern PAM software capabilities like strong authentication, session recording, policy-based access, and JIT elevation without secrets, credential rotation, or vault dependencies. This enables controlled, audited access to servers, Kubernetes, databases, cloud consoles, and other privileged environments using short-lived certificates and role-based policies.

Is Teleport a Just-in-Time (JIT) access solution?

Teleport enables JIT access through time-bound Access Requests. Users request the roles or resources they temporarily need, policies decide whether approval is required, and privileges automatically expire. This approach maintains least privilege while keeping access workflows efficient and predictable.

Does Teleport secure access to Kubernetes?

Teleport can proxy and secure Kubernetes access with identity-based authentication, role-based access controls, and detailed auditing of kubectl activity.

Does Teleport support SPIFFE?

Teleport supports SPIFFE-compatible identities for workloads, allowing it to participate in SPIFFE ecosystems and federation. Teleport issues short-lived SVIDs and can integrate with ext

teleport (gravitational/teleport)

Searching Database…

这是什么?Teleport 是一个开源的基础设施访问平台,为服务器、Kubernetes、数据库、桌面和 Web 应用提供连接、身份认证、访问控制和审计——而且不需要长期有效的密钥或密码。
它是我安装的一个单独工具,还是需要运行的一整套平台?它是一个单独的 Go 二进制文件,集成了身份感知访问代理、签发短期证书的 CA、统一的访问控制和隧道功能。你可以把它作为 Linux 守护进程或 Kubernetes 部署来运行;用户通过 Web 界面和 tsh 命令行工具来使用。
它真的是开源的吗,许可证上有没有坑?它是分开的:核心部分采用 AGPL-3.0,/api 模块采用 Apache 2.0,而分发的 Community Edition 构建使用的是修改版 Apache 2.0——如果要编译源码用于商业用途,最好先确认一下。
作者为什么要做 Teleport?创作者在 Rackspace 工作时,看到云用户被那些难以理解、维护成本又高的基础设施安全工具折腾得够呛。他们想做一种好用又好扩展的安全访问方案——所有服务器都集中在一处一目了然,就像被瞬移到了你的房间里一样。
我的团队能观看和共享会话吗?可以。会话可以共享出来用于协作排查问题,而且 Teleport 会对 SSH、Kubernetes、数据库、RDP 和 Web 会话的活动进行录制和审计,谁做了什么都有完整的记录可查。
它也能管理 AI 代理的访问吗?可以——Teleport 支持 Model Context Protocol(MCP)服务器,所以同一套身份认证、访问控制和审计体系也能覆盖 AI 代理所使用的工具。
What are similar projects?zitadel, jumpserver, logto, casdoor, infisical, authentik, hydra, pangolin
Size
1.5 GB
Stars
21K
Age
11y
Commits · 90 Days