mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-12 02:15:01 +00:00
Implements part of RFD 246 Help new users understand what is involved in deploying a Teleport cluster by moving the self-hosting documentation into the Installation section. This way, we can include all information related to running Teleport processes in the same part of the docs. Docs related to Teleport features but not first-time deployments do not belong in the Installation section, so this change moves them into the Management section instead: - Configure Trusted Clusters - TLS Routing Migration - Guides in `zero-trust-access/deploy-a-cluster/reliability` Also edit the Installation landing page to make self-hosting guidance clearer. Merge the H2 sections re: self-hosting and cluster setup and provide a clearer experience for users, with a table of cluster components.
104 lines
3.3 KiB
Plaintext
104 lines
3.3 KiB
Plaintext
---
|
|
title: Installing Teleport on a Single Machine
|
|
sidebar_label: Single Machine
|
|
description: How to install Teleport and Teleport's client tools on your platform, including binaries and instructions for Docker.
|
|
videoBanner: fjk29wqXm1A
|
|
tags:
|
|
- reference
|
|
- platform-wide
|
|
---
|
|
|
|
The guides in this section explain how to install Teleport on a single machine.
|
|
|
|
Teleport installations include the following binaries:
|
|
|
|
|Binary|Purpose|
|
|
|---|---|
|
|
|`teleport`|Main Teleport binary that runs the Auth Service, Proxy Service, and Teleport Agent services.|
|
|
|`tctl`|Admin tool for managing Teleport resources.|
|
|
|`tsh`|Client tool for accessing Teleport-protected infrastructure.|
|
|
|`tbot`|CLI for running Teleport Machine & Workload Identity Bots.|
|
|
|`teleport-update`|Tool for operating Teleport Managed Updates.|
|
|
|`fdpass-teleport`|Utility for integrating Machine & Workload Identity with OpenSSH.|
|
|
|
|
Whether you are installing the Teleport control plane (the Auth Service and
|
|
Proxy Service) or as an agent that talks to the cluster, the Teleport binary is
|
|
the same. The difference is only in how you [configure
|
|
it](../../reference/deployment/config.mdx), which you will need to do after
|
|
installation.
|
|
|
|
## Choose your platform to install Teleport
|
|
|
|
<TileGrid
|
|
tiles={[
|
|
{
|
|
icon: <Icon name="linux" size="xl" />,
|
|
to: "./linux",
|
|
name: "Linux",
|
|
},
|
|
{
|
|
icon: <Icon name="docker" size="xl" />,
|
|
to: "./docker",
|
|
name: "Docker",
|
|
},
|
|
{
|
|
icon: <Icon name="ec2" size="xl" />,
|
|
to: "./amazon-ec2",
|
|
name: "Amazon EC2",
|
|
},
|
|
{
|
|
icon: <Icon name="apple" size="xl" />,
|
|
to: "./macos",
|
|
name: "macOS",
|
|
},
|
|
{
|
|
icon: <Icon name="windows" size="xl" />,
|
|
to: "./windows",
|
|
name: "Windows",
|
|
},
|
|
{
|
|
icon: <Icon name="laptop" size="xl" />,
|
|
to: "./source",
|
|
name: "From Source",
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Checksums
|
|
|
|
If you want to verify the integrity of a Teleport binary, SHA256 checksums are
|
|
available for all downloads on our
|
|
[downloads page](https://goteleport.com/download/).
|
|
|
|

|
|
|
|
If you download Teleport via an automated system, you can programmatically
|
|
obtain the checksum by adding `.sha256` to the download link. This is the method
|
|
shown in the installation examples.
|
|
|
|
```code
|
|
$ export version=v(=teleport.version=)
|
|
# 'darwin' 'linux' or 'windows'
|
|
$ export os=linux
|
|
# '386' 'arm' on linux or 'amd64' for all distros
|
|
$ export arch=amd64
|
|
$ curl https://cdn.teleport.dev/teleport-$version-$os-$arch-bin.tar.gz.sha256
|
|
# <checksum> <filename>
|
|
```
|
|
|
|
## Uninstalling Teleport
|
|
|
|
If you wish to uninstall Teleport at any time, see our documentation on [Uninstalling Teleport](../uninstall-teleport.mdx).
|
|
|
|
## Next steps
|
|
|
|
Now that you know how to install Teleport, you can enable access to all of your
|
|
infrastructure. Get started with enrolling resources in your Teleport cluster:
|
|
|
|
- [SSH servers](../../enroll-resources/server-access/server-access.mdx)
|
|
- [Kubernetes clusters](../../enroll-resources/kubernetes-access/introduction.mdx)
|
|
- [Databases](../../enroll-resources/database-access/database-access.mdx)
|
|
- [Applications](../../enroll-resources/application-access/application-access.mdx)
|
|
- [Remote desktops](../../enroll-resources/desktop-access/introduction.mdx)
|
|
- [Machine & Workload Identity](../../machine-workload-identity/introduction.mdx)
|