Read our Blog: https://goteleport.com/blog/
Read our Documentation: https://goteleport.com/docs/getting-started/
Teleport is the easiest, most secure way to access all your infrastructure. Teleport is an identity-aware, multi-protocol access proxy which understands SSH, HTTPS, RDP, Kubernetes API, MySQL, MongoDB and PostgreSQL wire protocols.
On the server-side, Teleport is a single binary which enables convenient secure access to behind-NAT resources such as:
Teleport is trivial to set up as a Linux daemon or in a Kubernetes pod. It's rapidly
sshd-based setups at organizations who need:
In addition to its hallmark features, Teleport is interesting for smaller teams because it facilitates easy adoption of the best infrastructure security practices like:
Teleport is built upon the high-quality Golang SSH
implementation. It is fully compatible with OpenSSH,
sshd servers, and
|Teleport Website||The official website of the project.|
|Documentation||Admin guide, user manual and more.|
|Demo Video||3-minute video overview of Teleport.|
|Blog||Our blog where we publish Teleport news.|
|Forum||Ask us a setup question, post your tutorial, feedback, or idea on our forum.|
|Slack||Need help with your setup? Ping us in our Slack channel.|
|Cloud-hosted||We offer Enterprise with a Cloud-hosted option. For teams that require easy and secure access to their computing environments.|
| Follow the Installation Guide
Download the latest binary release,
unpack the .tar.gz and run
sudo ./install. This will copy Teleport binaries into
Then you can run Teleport as a single-node cluster:
sudo teleport start
In a production environment, Teleport must run as
root. For testing or non-production environments, run it as the
chown $USER /var/lib/teleport
| Follow the Docker-Compose Getting Started Guide
If you wish to deploy Teleport inside a Docker container:
# This command will pull the Teleport container image for version 8 docker pull public.ecr.aws/gravitational/teleport:8
View latest tags on Amazon ECR Public | gravitational/teleport
Follow the instructions in the docker/README file.
To run a full test suite locally, see the test dependencies list
teleport repository contains the Teleport daemon binary (written in Go)
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 https://github.com/gravitational/teleport.git -b v9.1.2 gets release v9.1.2.
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
Ensure you have installed correct versions of necessary dependencies:
Goversion from go.mod
Cargoversion in build.assets/Makefile (search for
10.xwith FIDO support, you will need
openssl 1.1installed locally
For an example of Dev Environment setup on a Mac, see these instructions.
- 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, regardless of whether it is stable. If you want to build the latest stable release, run
git submodule update --recursiveto the corresponding tag (for example,
git checkout v8.0.0) before performing a build.
Get the source
git clone https://github.com/gravitational/teleport.git cd teleport
To perform a build
tsh with Apple TouchID support enabled:
tshbinaries with Touch ID support are only functional using binaries signed with Teleport's Apple Developer ID and notarized by Apple. If you are a Teleport maintainer, ask the team for access.
make build/tsh TOUCHID=yes
make build/tsh FIDO2=dynamic
On a Mac, with
openssl 1.1 installed via
export PKG_CONFIG_PATH="$(brew --prefix [email protected])/lib/pkgconfig" make build/tsh FIDO2=dynamic
If the build succeeds, the installer will place the binaries in the
Before starting, create default data directories:
sudo mkdir -p -m0700 /var/lib/teleport sudo chown $USER /var/lib/teleport
The Teleport Web UI resides in the web directory.
To rebuild the Teleport UI package, run the following command:
Then you can replace Teleport Web UI files with the files from the newly-generated
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
For instructions about how to update the Web UI, read the
After you commit a change to the
repo, you need to update the Web UI
assets in the
webassets/ git submodule.
make update-webassets to update the
webassets repo and create a PR for
teleport to update its git submodule.
You will need to have the
gh utility installed on your system for the script
to work. For installation instructions, read the GitHub CLI installation documentation.
All dependencies are managed using Go modules. Here are the instructions for some common tasks:
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/[email protected] instead.
go get github.com/new/[email protected]
go get -u github.com/new/dependency
go get -u all
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
The Teleport creators used to work together at Rackspace. We noticed that most cloud computing users struggle with setting up and configuring infrastructure security because popular tools, while flexible, are complex to understand and expensive to maintain. Additionally, most organizations use multiple infrastructure form factors such as several cloud providers, multiple cloud accounts, servers in colocation, and even smart devices. Some of those devices run on untrusted networks, behind third-party firewalls. This only magnifies complexity and increases operational overhead.
We had a choice, either start a security consulting business or build a solution that's dead-easy to use and understand. A real-time representation of all of your servers in the same room as you, as if they were magically teleported. Thus, Teleport was born!
We offer a few different options for support. First of all, we try to provide clear and comprehensive documentation. The docs are also in Github, so feel free to create a PR or file an issue if you have ideas for improvements. If you still have questions after reviewing our docs, you can also:
Teleport is used by leading companies to enable engineers to quickly access any computing resource anywhere. Teleport has completed several security audits from the nationally recognized technology security companies. We make some of our audits public, view our latest audit reports. We are comfortable with the use of Teleport from a security perspective.
You can see the list of companies who use Teleport in production on the Teleport product page.
You can find the latest stable Teleport build on our Releases page.