Read our Blog: https://goteleport.com/blog/
Read our Documentation: https://goteleport.com/docs/getting-started/
- Introduction
- Installing and Running
- Docker
- Building Teleport
- Why Did We Build Teleport?
- More Information
- Support and Contributing
- Is Teleport Secure and Production Ready?
- Who Built Teleport?
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:
- SSH nodes - SSH works in browsers too!
- Kubernetes clusters
- PostgreSQL, MongoDB, CockroachDB and MySQL databases
- Internal Web apps
- Windows Hosts
- Networked servers
Teleport is trivial to set up as a Linux daemon or in a Kubernetes pod. It's rapidly
replacing legacy sshd-based setups at organizations who need:
- Developer convenience of having instant secure access to everything they need across many environments and cloud providers.
- Audit log with session recording/replay for multiple protocols
- Easily manage trust between teams, organizations and data centers.
- Role-based access control (RBAC) and flexible access workflows (one-time access requests)
In addition to its hallmark features, Teleport is interesting for smaller teams because it facilitates easy adoption of the best infrastructure security practices like:
- No need to manage shared secrets such as SSH keys: Teleport uses certificate-based access with automatic certificate expiration time for all protocols.
- Two-factor authentication (2FA) for everything.
- Collaboratively troubleshoot issues through session sharing.
- Single sign-on (SSO) for everything via Github Auth, OpenID Connect, or SAML with endpoints like Okta or Active Directory.
- Infrastructure introspection: Use Teleport via the CLI or Web UI to view the status of every SSH node, database instance, Kubernetes cluster, or internal web app.
Teleport is built upon the high-quality Golang SSH
implementation. It is fully compatible with OpenSSH,
sshd servers, and ssh clients.
| Project Links | Description |
|---|---|
| Teleport Website | The official website of the project. |
| Documentation | Admin guide, user manual and more. |
| 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. |
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 Team, a managed Teleport deployment that makes it easier for small organizations to enable secure access to their infrastructure.
Sign up for a free trial of Teleport Team.
Follow our guide to registering your first server with Teleport Team
If you wish to deploy Teleport inside a Docker container:
# This command will pull the Teleport container image for version 13
docker pull public.ecr.aws/gravitational/teleport:13
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
The teleport repository contains the Teleport daemon binary (written in Go)
and a web UI written in Javascript (a git submodule located in the webassets/
directory).
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 v13.0.0 gets release v13.0.0.
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- If you wish to build the Rust-powered features like Desktop Access, see the
RustandCargoversion in build.assets/Makefile (search forRUST_VERSION) - For
tshversion >10.xwith FIDO support, you will needlibfidoandopenssl 1.1installed locally - To build the web UI,
yarn(< 2.0.0) is required.- If you prefer not to install/use yarn, but have docker available, you can run
make docker-uiinstead.
- If you prefer not to install/use yarn, but have docker available, you can run
For an example of Dev Environment setup on a Mac, see these instructions.
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, regardless of whether it is stable. If you want to build the latest stable release, run
git checkoutandgit submodule update --recursiveto the corresponding tag (for example,- run
git checkout v8.0.0) before performing a build.
Get the source
git clone https://github.com/gravitational/teleport.git
cd teleportTo perform a build
make fullTo build tsh with Apple TouchID support enabled:
Important
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=yesTo build tsh with libfido:
make build/tsh FIDO2=dynamic-
On a Mac, with
libfidoandopenssl 1.1installed viahomebrewexport PKG_CONFIG_PATH="$(brew --prefix openssl@1.1)/lib/pkgconfig" make build/tsh FIDO2=dynamic
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/teleportThe Teleport Web UI resides in the web directory.
To rebuild the Teleport UI package, run the following command:
make docker-uiThen 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 -dKeep 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.
All dependencies are managed using Go modules. Here are the instructions for some common tasks:
Latest version:
go get github.com/new/dependencyand update the source to use this dependency.
To get a specific version, use go get github.com/new/dependency@version instead.
go get github.com/new/dependency@versiongo get -u github.com/new/dependencygo get -u allWhy 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
Note: Devbox support is still experimental. It's very possible things make not work as intended.
Teleport can be built using devbox. To use devbox, follow the instructions to install devbox here and then run:
devbox shell
This will install Teleport's various build dependencies and drop you into a shell with these dependencies. From here, you can build Teleport normally.
A nix flake is located in build.assets/flake that allows for installation of Teleport's less
common build tooling. If this flake is updated, run:
devbox install
in order to make sure the changes in the flake are reflected in the local devbox shell.
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:
- Join Teleport Discussions to ask questions. Our engineers are available there to help you.
- If you want to contribute to Teleport or file a bug report/issue, you can create an issue here in Github.
- If you are interested in Teleport Enterprise or more responsive support during a POC, we can also create a dedicated Slack channel for you during your POC. You can reach out to us through our website to arrange for a POC.
Yes -- Teleport is production-ready and designed to protect and facilitate access to the most precious and mission critical applications.
Teleport has completed several security audits from nationally and internationally recognized technology security companies.
We publicize some of our audit results, security philosophy and related information on our trust page.
You can see the list of companies who use Teleport in production on the Teleport product page.
Teleport was created by Gravitational, Inc.. We have built Teleport by borrowing from our previous experiences at Rackspace. Learn more about Teleport and our history.