Add product and guide type labels to docs pages (#56097)

* Add `product` and `type` tags to docs pages

We are rolling out standard `product` and `type` frontmatter fields for
each docs page, letting us use this metadata to perform operations on
pages that fall under a certain type or product. For example, we could
generate product-specific landing pages using the `product` field.

This change acts in tandem with gravitational/docs-website#249, which
lints the frontmatter of each docs page to enforce the `product` and
`type` fields.

Note that some guides have "Reference" in the title but are really more
like conceptual guides, providing information about how aspects of
Teleport work instead of a comprehensive reference of possible inputs.

Note that this change marks category index pages as having type `other`.
It might make sense to add a type for `index`, but this is something we
can modify when we need to perform operations on category index pages.

* Respond to roraback feedback

Instead of the `product:` and `type:` frontmatter fields, use a more
extensible approach, a single `labels` frontmatter field with a list of
string values.

* Respond to roraback feedback

Remove `other` items from the `labels` field.

Also add labels to new pages.
This commit is contained in:
Paul Gottschling
2025-07-15 20:00:50 +00:00
committed by GitHub
parent 7541d6d7d0
commit deda8410b3
577 changed files with 1691 additions and 20 deletions
@@ -2,6 +2,8 @@
title: Access Controls
description: How to provide role-based access control (RBAC) for servers, databases, Kubernetes clusters, and other resources in your infrastructure
layout: tocless-doc
labels:
- zero-trust
---
Teleport's role-based access control (RBAC) enables you to set fine-grained
@@ -1,6 +1,9 @@
---
title: Getting Started With Access Controls
description: Get started using Access Controls.
labels:
- get-started
- zero-trust
---
In Teleport, any local, SSO, or robot user can be assigned one or several roles.
@@ -2,6 +2,9 @@
title: Dual Authorization
description: Dual Authorization for SSH and Kubernetes.
videoBanner: b_iqJm_o15I
labels:
- how-to
- identity-governance
---
You can set up Teleport to require the approval of multiple team members to perform some critical actions.
@@ -2,6 +2,8 @@
title: Cluster Access and RBAC
description: How to configure access to specific resources in your infrastructure or your Teleport cluster as a whole.
layout: tocless-doc
labels:
- zero-trust
---
Teleport gives you fine-grained control over who can access resources in your
@@ -1,6 +1,9 @@
---
title: Hardware Key Support
description: Hardware Key Support
labels:
- how-to
- zero-trust
---
This guide explains how to configure Teleport authentication using
@@ -1,6 +1,9 @@
---
title: Headless WebAuthn
description: Headless WebAuthn
labels:
- how-to
- zero-trust
---
Headless WebAuthn provides a secure way to authenticate with WebAuthn from a
@@ -1,6 +1,9 @@
---
title: Impersonating Teleport Users
description: How to issue short-lived certs on behalf of Teleport users using impersonation.
labels:
- how-to
- zero-trust
---
Sometimes users need to create short-lived certificates for non-interactive
@@ -1,6 +1,9 @@
---
title: "IP Pinning "
description: How to enable IP pinning for Teleport users
labels:
- conceptual
- zero-trust
---
<Admonition type="warning">
@@ -6,6 +6,9 @@ keywords:
- Kubernetes
- session moderation
- audit
labels:
- conceptual
- zero-trust
---
Teleport allows multiple users to join the same SSH or `kubectl exec` session.
@@ -1,6 +1,9 @@
---
title: MFA for Administrative Actions
description: Require MFA checks to perform administrative actions.
labels:
- how-to
- zero-trust
---
Teleport can be configured to require additional multi-factor authentication
@@ -2,6 +2,9 @@
title: "Passwordless"
description: Learn how to use passwordless authentication with Teleport.
videoBanner: GA37qqB6Lmk
labels:
- how-to
- zero-trust
---
Passwordless takes advantage of WebAuthn to provide passwordless and
@@ -2,6 +2,9 @@
title: Per-session MFA
description: Require MFA checks to initiate sessions.
videoBanner: j8Ze7HhjFGw
labels:
- conceptual
- zero-trust
---
Teleport supports requiring additional multi-factor authentication checks
@@ -1,6 +1,9 @@
---
title: Teleport Role Templates
description: This guide explains templating in Teleport roles. Templates allow you to enable access to resources depending on the traits of a local or single sign-on user.
labels:
- conceptual
- zero-trust
---
As organizations grow, infrastructure teams have to figure out how to define
@@ -2,6 +2,9 @@
title: Harden your Cluster Against IdP Compromises
description: Implement cluster-wide hardening measures.
videoBanner: vQgKkD4ZRDU
labels:
- how-to
- zero-trust
---
This guide aims to help you fortify your identity infrastructure and mitigate the risks associated with IdP weaknesses.
@@ -1,6 +1,8 @@
---
title: Configure Teleport as an identity provider
description: How to set up Teleport's identity provider functionality
labels:
- identity-governance
---
Users can authenticate to both internal and external applications
@@ -2,6 +2,9 @@
title: SAML IdP Attribute Mapping
description: How to map user attributes to custom SAML response
h1: SAML Attribute Mapping
labels:
- conceptual
- identity-governance
---
Attribute mapping configures Teleport SAML Identity Provider to assert custom user attributes in SAML response.
@@ -2,6 +2,9 @@
title: Access GCP Web Console and API with federated authentication
description: Manage Google Cloud Platform (GCP) web console access with Teleport SAML IdP.
h1: GCP Workforce Identity Federation with Teleport SAML IdP
labels:
- how-to
- identity-governance
---
GCP Workforce Identity Federation enables provisioning access to GCP web console and APIs
@@ -1,6 +1,9 @@
---
title: Use Teleport's SAML Provider to authenticate with Grafana
description: Configure Grafana to use identities provided by Teleport.
labels:
- how-to
- identity-governance
---
Grafana is an open source observability platform. Their enterprise version supports
@@ -2,6 +2,9 @@
title: Using Teleport as a SAML identity provider
description: How to configure and use Teleport as a SAML identity provider.
h1: Teleport as a SAML identity provider
labels:
- how-to
- identity-governance
---
This guide details an example on how to use Teleport as a SAML identity provider
@@ -1,6 +1,9 @@
---
title: Access Azure Portal and CLI
description: Access Azure Portal and CLI by authenticating with Teleport SAML IdP
labels:
- how-to
- identity-governance
---
This guide explains how to integrate the Teleport SAML IdP with [Microsoft Entra External ID](https://learn.microsoft.com/en-us/entra/external-id/)
@@ -1,6 +1,9 @@
---
title: Set Up Login Rules
description: Set up Login Rules to transform user traits
labels:
- how-to
- zero-trust
---
This guide will walk you through the process of writing, testing, and adding the
@@ -2,6 +2,9 @@
title: Login Rules
description: Transform User Traits with Login Rules
layout: tocless-doc
labels:
- how-to
- zero-trust
---
When users log in to your Teleport cluster with a configured SSO provider,
+2
View File
@@ -1,6 +1,8 @@
---
title: Teleport Admin Guides
description: Provides step-by-step instructions for completing administrative tasks in Teleport.
labels:
- platform-wide
---
<DocCardList />
@@ -1,6 +1,9 @@
---
title: How to Build an Access Request Plugin
description: Manage Access Requests using custom workflows with the Teleport API
labels:
- how-to
- zero-trust
---
With Teleport [Access Requests](../../identity-governance/access-requests/access-requests.mdx), you can
+2
View File
@@ -2,6 +2,8 @@
title: Using the Teleport API
description: Guides to writing a client application for the Teleport gRPC API, which makes it possible to programmatically manage dynamic resources.
layout: tocless-doc
labels:
- zero-trust
---
The Teleport Auth Service provides a gRPC API for remotely interacting with your
@@ -1,6 +1,9 @@
---
title: Automatically Register Resources with Teleport
description: Learn how to use the Teleport API to start agents automatically when you add resources to your infrastructure.
labels:
- how-to
- zero-trust
---
You can use Teleport's API to automatically register resources in your
@@ -1,6 +1,9 @@
---
title: API Getting Started Guide
description: Get started working with the Teleport API programmatically using Go.
labels:
- get-started
- mwi
---
In this getting started guide we will use the Teleport API Go client to connect
+3
View File
@@ -1,6 +1,9 @@
---
title: Generate Teleport Roles from an External RBAC System
description: Use Teleport's API to automatically generate Teleport roles based on third-party RBAC policies
labels:
- how-to
- zero-trust
---
You can use the Teleport gRPC API to generate roles automatically based on an
@@ -2,6 +2,9 @@
title: AWS KMS
description: Configure Teleport to store CA private keys in the AWS Key Management Service
h1: Store Teleport Private Keys in AWS KMS
labels:
- how-to
- platform-wide
---
This guide will show you how to set up your Teleport cluster to use the AWS Key
@@ -1,6 +1,8 @@
---
title: Self-Hosting Teleport
description: "Guides to running a self-hosted Teleport cluster in production."
labels:
- platform-wide
---
These guides show you how to run a self-hosted Teleport Enterprise cluster in
@@ -1,6 +1,9 @@
---
title: "AWS Multi-Region Proxy Deployment"
description: "Deploying a high-availability multi-region Teleport cluster using Proxy Peering and Route 53."
labels:
- conceptual
- platform-wide
---
This deployment architecture features two important design decisions:
@@ -3,6 +3,9 @@ title: Teleport High Availability mode on AWS
description: How to configure Teleport in High Availability mode for AWS deployments.
h1: Running Teleport Enterprise in High Availability mode on AWS
tocDepth: 3
labels:
- how-to
- platform-wide
---
This guide is designed to accompany our [reference Terraform code](https://github.com/gravitational/teleport/tree/branch/v(=teleport.major_version=)/examples/aws/terraform/ha-autoscale-cluster#terraform-based-provisioning-example-amazon-single-ami)
@@ -2,6 +2,9 @@
title: Teleport Single-Instance Deployment on AWS
description: How to quickly configure Teleport on a single instance for testing in AWS.
tocDepth: 3
labels:
- how-to
- platform-wide
---
This guide is designed to accompany our [reference starter-cluster Terraform code](https://github.com/gravitational/teleport/tree/branch/v(=teleport.major_version=)/examples/aws/terraform/starter-cluster#teleport-terraform-aws-ami-simple-example)
@@ -2,6 +2,8 @@
title: Reference Deployment Guides
description: Teleport Installation and Configuration Reference Deployment Guides.
layout: tocless-doc
labels:
- platform-wide
---
These guides show you how to set up a full self-hosted Teleport deployment on
@@ -1,6 +1,9 @@
---
title: Running Teleport on GCP
description: How to install and configure Teleport on GCP
labels:
- conceptual
- platform-wide
---
We've created this guide to give customers an overview of how to deploy a
@@ -2,6 +2,9 @@
title: Google Cloud KMS
description: Configure Teleport to store CA private keys in the Google Cloud Key Management Service
h1: Store Teleport Private Keys in Google Cloud KMS
labels:
- how-to
- platform-wide
---
This guide will show you how to set up your Teleport Cluster to use the Google
@@ -1,6 +1,9 @@
---
title: Running an HA Teleport cluster using AWS, EKS, and Helm
description: Install and configure an HA Teleport cluster using an AWS EKS cluster
labels:
- how-to
- platform-wide
---
In this guide, we'll use Teleport Helm charts to set up a high-availability Teleport cluster that runs on AWS EKS.
@@ -1,6 +1,9 @@
---
title: Running an HA Teleport cluster using Microsoft Azure, AKS, and Helm
description: Install and configure an HA Teleport cluster using a Microsoft Azure AKS cluster.
labels:
- how-to
- platform-wide
---
In this guide, we'll go through how to set up a High Availability Teleport
@@ -1,6 +1,9 @@
---
title: Running Teleport with a Custom Configuration using Helm
description: Install and configure a Teleport cluster with a custom configuration using Helm
labels:
- how-to
- platform-wide
---
In this guide, we'll explain how to set up a Teleport cluster in Kubernetes
@@ -1,6 +1,9 @@
---
title: Get started with Teleport on DigitalOcean Kubernetes
description: How to get started with Teleport on DigitalOcean Kubernetes
labels:
- how-to
- platform-wide
---
This guide will show you how to get started with Teleport on DigitalOcean
@@ -1,6 +1,9 @@
---
title: Managing Disaster Recovery in an Amazon EKS Teleport Cluster
description: Provides guidance for planning a strategy for restoring a self-hosted Teleport cluster on EKS after a regional outage.
labels:
- how-to
- platform-wide
---
In case of an outage in your cloud provider region, you need to ensure that you
@@ -1,6 +1,9 @@
---
title: Running an HA Teleport cluster using GCP, GKE, and Helm
description: Install and configure an HA Teleport cluster using a Google Cloud GKE cluster.
labels:
- how-to
- platform-wide
---
In this guide, we'll go through how to set up a High Availability Teleport cluster with multiple replicas in Kubernetes
@@ -2,6 +2,8 @@
title: Guides for running Teleport using Helm
description: How to install and configure Teleport in Kubernetes using Helm
layout: tocless-doc
labels:
- platform-wide
---
The `teleport-cluster` Helm chart enables you deploy and manage a self-hosted,
@@ -1,6 +1,9 @@
---
title: Running Teleport on IBM Cloud
description: How to install and configure Teleport on IBM cloud
labels:
- how-to
- platform-wide
---
This guide describes how to set up Teleport on IBM Cloud.
@@ -1,6 +1,9 @@
---
title: Deploy Teleport on Kubernetes
description: This guide shows you how to deploy Teleport on a Kubernetes cluster using Helm.
labels:
- how-to
- platform-wide
---
Teleport can provide secure, unified access to your Kubernetes clusters. This
@@ -1,6 +1,9 @@
---
title: Kubernetes 1.25 and PSP removal
description: How to prepare for the PodSecurityPolicy removal happening in Kubernetes 1.25
labels:
- conceptual
- platform-wide
---
PodSecurityPolicies (PSPs) were deprecated in Kubernetes 1.22 and are removed
@@ -2,6 +2,9 @@
title: "Deploying a High Availability Teleport Cluster"
description: "Deploying a High Availability Teleport Cluster"
tocDepth: 3
labels:
- conceptual
- platform-wide
---
When deploying Teleport in production, you should design your deployment to
@@ -2,6 +2,9 @@
title: HSM Support
description: How to configure Hardware Security Modules to manage your Teleport CA private keys
h1: Teleport HSM Support
labels:
- how-to
- platform-wide
---
This guide will show you how to set up the Teleport Auth Service to use a
@@ -1,6 +1,9 @@
---
title: Enterprise License File
description: How to manage your Teleport Enterprise license file.
labels:
- conceptual
- platform-wide
---
Self-hosted Teleport Enterprise subscriptions require a valid license. In this
@@ -1,6 +1,9 @@
---
title: "Multi-region Blueprint"
description: "Blueprint describing how to deploy a multi-region Teleport Enterprise cluster using CockroachDB."
labels:
- conceptual
- platform-wide
---
This page describes how to deploy a Teleport cluster in multiple regions to
@@ -1,6 +1,9 @@
---
title: Separate Internal and External Proxy Service Traffic
description: Explains how to set up the Teleport Proxy Service to isolate traffic from the public internet from internal client traffic.
labels:
- how-to
- platform-wide
---
In a typical Teleport cluster, including clusters deployed on Teleport Cloud,
@@ -2,6 +2,8 @@
title: Cluster Administration Guides
description: Teleport Cluster Administration Guides.
layout: tocless-doc
labels:
- platform-wide
---
The guides in this section show you the fundamentals of setting up and running a
@@ -1,6 +1,9 @@
---
title: Run Teleport as a Daemon
description: Configure Teleport to run as a daemon using systemd
labels:
- how-to
- platform-wide
---
On Linux systems in non-containerized environments, we recommend running the `teleport` binary as a daemon using systemd.
Using a daemon helps to ensure that the `teleport` process can remain running and available regardless of a controlling terminal session or parent process, and opens up additional
@@ -1,6 +1,9 @@
---
title: Add Labels to Resources
description: How to assign static and command-based dynamic labels to Teleport resources.
labels:
- how-to
- zero-trust
---
Teleport allows you to add arbitrary key-value pairs to applications, servers,
@@ -1,6 +1,9 @@
---
title: Running Teleport with Self-Signed Certificates
description: This guide shows you how to run Teleport using self-signed certificates, which is helpful for testing or demo environments.
labels:
- conceptual
- platform-wide
---
This guide explains how to evaluate Teleport in a
@@ -1,6 +1,9 @@
---
title: Troubleshooting
description: Troubleshooting and Collecting Metrics of Teleport Processes
labels:
- how-to
- platform-wide
---
In this guide, we will explain how to address issues or unexpected behavior in your
@@ -1,6 +1,9 @@
---
title: Commands to look up cluster addresses
description: Suggests command-line tools and scripts to look up cluster addresses.
labels:
- how-to
- platform-wide
---
If you aren't sure of what values to use for cluster settings such as the `tunnel_addr`
@@ -32,4 +35,4 @@ by replacing `teleport.example.com` with your Teleport cluster domain:
```code
$ curl https://$PROXY/webapi/ping | jq .proxy.ssh.public_addr
```
```
@@ -1,6 +1,9 @@
---
title: Configure Trusted Clusters
description: Explains how you can configure a trust relationship and manage access between two Teleport clusters.
labels:
- how-to
- zero-trust
---
<Admonition type="note">
@@ -1,6 +1,9 @@
---
title: Uninstall Teleport
description: How to remove Teleport from your system
labels:
- how-to
- platform-wide
---
This guide explains how to uninstall Teleport completely including binaries, configurations and data.
@@ -1,6 +1,9 @@
---
title: Local Users
description: Learn how to manage local users in Teleport. Local users are stored on the Auth Service instead of a third-party identity provider.
labels:
- conceptual
- zero-trust
---
In Teleport, **local users** are users managed directly via Teleport, rather
@@ -1,6 +1,9 @@
---
title: Monitoring your Cluster
description: Monitoring your Teleport deployment
labels:
- how-to
- platform-wide
---
Teleport provides health checking mechanisms in order to verify that it is healthy and ready to serve traffic.
@@ -1,6 +1,9 @@
---
title: Logger Configuration
description: Explains how to configure the logger on a Teleport instance.
labels:
- conceptual
- platform-wide
---
In the configuration file of a Teleport instance, you can configure the logger's behavior by defining the output
@@ -2,6 +2,9 @@
title: Key Metrics for Self-Hosted Clusters
description: Describes important metrics to monitor if you are self-hosting Teleport.
tocDepth: 3
labels:
- conceptual
- platform-wide
---
This guide explains the metrics you should use to get started monitoring your
@@ -1,6 +1,9 @@
---
title: Health Monitoring
description: Monitoring health and readiness.
labels:
- conceptual
- platform-wide
---
Teleport provides health checking mechanisms in order to verify that it
@@ -1,6 +1,9 @@
---
title: Profiling
description: Collecting pprof profiles.
labels:
- conceptual
- platform-wide
---
Teleport leverages Go's diagnostic capabilities to collect and export
@@ -1,6 +1,9 @@
---
title: Distributed Tracing
description: How to enable tracing within Teleport.
labels:
- conceptual
- platform-wide
---
Teleport leverages [OpenTelemetry](https://opentelemetry.io/) to generate traces
@@ -1,6 +1,9 @@
---
title: External Audit Storage
description: Store audit logs and session recordings on your own infrastructure with Teleport Enterprise Cloud.
labels:
- how-to
- zero-trust
---
External Audit Storage is a feature of Teleport in which the Auth Service stores
@@ -1,6 +1,9 @@
---
title: AWS IAM Identity Center
description: Provides an overview of the Teleport AWS IAM Identity Center integration.
labels:
- conceptual
- identity-governance
---
Teleport's integration with [AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/)
@@ -1,6 +1,9 @@
---
title: Getting Started with AWS IAM Identity Center integration
description: Explains how to set up and use Teleport AWS IAM Identity Center integration.
labels:
- how-to
- identity-governance
---
Teleport's integration with [AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/)
@@ -2,6 +2,9 @@
title: Migrating AWS IAM Identity Center from Okta to Teleport
description: Explains how to migrate an Identity Center instance from Okta control to Teleport control.
tocDepth: 3
labels:
- how-to
- identity-governance
---
In an existing Okta-managed AWS IAM Identity Center instance, you can introduce Teleport in one
@@ -2,6 +2,9 @@
title: AWS RDS Enrollment Wizard
description: Enroll AWS RDS databases with your Teleport cluster using an enrollment wizard.
tocDepth: 3
labels:
- how-to
- zero-trust
---
The AWS RDS enrollment wizard is available in your Teleport cluster Web UI as
@@ -1,6 +1,9 @@
---
title: AWS OIDC Integration
description: How to connect your AWS account with Teleport and provide access to AWS resources.
labels:
- how-to
- zero-trust
---
This guide explains how to set up the Teleport AWS OIDC integration.
@@ -2,6 +2,9 @@
title: Datadog Integration
description: How to export Teleport metrics and logs to Datadog
h1: Export Teleport metrics and logs to Datadog
labels:
- conceptual
- zero-trust
---
Datadog has an [officially maintained integration](https://docs.datadoghq.com/integrations/teleport/) for Teleport.
@@ -2,6 +2,9 @@
title: EC2 Tags as Teleport Node Labels
description: How to set up Teleport Node labels based on EC2 tags
h1: Sync EC2 Tags and Teleport Node Labels
labels:
- how-to
- zero-trust
---
When running on an AWS EC2 instance, Teleport will automatically detect and import EC2 tags as
@@ -2,6 +2,9 @@
title: GCP Tags and Labels as Teleport Agent Labels
description: How to set up Teleport Agent labels based on GCP tags and labels
h1: Sync GCP Tags/Labels and Teleport Agent labels
labels:
- conceptual
- zero-trust
---
When running on an Google Compute Engine instance, Teleport will automatically detect and import GCP
@@ -1,6 +1,9 @@
---
title: Proxy Git Commands with Teleport for GitHub
description: How to use Teleport's short-lived SSH certificates with the GitHub Certificate Authority.
labels:
- how-to
- zero-trust
---
Teleport can proxy Git commands and use short-lived SSH certificates to
@@ -2,6 +2,8 @@
title: Integrations
description: Miscellaneous guides for integrating Teleport with third-party tools.
layout: tocless-doc
labels:
- platform-wide
---
You can integrate Teleport with third-party tools in order to complete various
@@ -2,6 +2,9 @@
title: Oracle Cloud Tags as Teleport Agent Labels
description: How to set up Teleport Agent labels based on Oracle Cloud tags
h1: Sync Oracle Cloud tags and Teleport Agent labels
labels:
- conceptual
- zero-trust
---
When running on an Oracle Cloud (OCI) Compute instance, Teleport will
@@ -28,4 +31,4 @@ fakehost.example.com 127.0.0.1:3022 oracle/testing=yes,oracle/definedTagNamespac
<Admonition type="note">
For services that manage multiple resources (such as the Database Service), each resource will receive the
same tags from Oracle.
</Admonition>
</Admonition>
@@ -2,6 +2,8 @@
title: Cluster Management
description: "Guides for performing day-two operations on your Teleport cluster."
layout: tocless-doc
labels:
- platform-wide
---
In this section, you can find guides on managing a Teleport cluster after
@@ -1,6 +1,9 @@
---
title: Backup and Restore
description: How to back up and restore your Teleport cluster state.
labels:
- conceptual
- platform-wide
---
Operators must have a plan in place to back up self-hosted Teleport clusters.
@@ -2,6 +2,9 @@
title: Certificate Authority Rotation
description: Describes how to rotate Teleport's certificate authorities.
tocDepth: 3
labels:
- how-to
- platform-wide
---
Components of a Teleport cluster authenticate to one another using either X.509
@@ -1,6 +1,9 @@
---
title: Database CA Migrations
description: How to complete Teleport Database CA migrations.
labels:
- conceptual
- zero-trust
---
In Teleport, self-hosted databases must be configured with certificates to
@@ -2,6 +2,8 @@
title: Operations
description: Teleport Operations - Scaling and High-Availability.
layout: tocless-doc
labels:
- platform-wide
---
The guides in this section show you how to carry out common administration tasks
@@ -1,6 +1,9 @@
---
title: Proxy Peering Migration
description: How to upgrade an existing Teleport cluster to Proxy Peering mode.
labels:
- how-to
- platform-wide
---
Proxy Peering enables Teleport Agents to be reachable without connecting to
@@ -1,6 +1,9 @@
---
title: Scaling
description: How to configure Teleport for large-scale deployments
labels:
- conceptual
- platform-wide
---
This section explains the recommended configuration settings for large-scale
@@ -1,6 +1,9 @@
---
title: TLS Routing Migration
description: How to upgrade an existing Teleport cluster to single-port TLS routing mode
labels:
- how-to
- platform-wide
---
In TLS routing mode, all Teleport client connections are wrapped in TLS and
@@ -1,6 +1,9 @@
---
title: Securing Sessions with Client Timeout Enforcement
description: How to implement idle client timeouts.
labels:
- conceptual
- zero-trust
---
The `client_idle_timeout` in Teleport is a configurable setting that helps improve security by terminating inactive sessions after a specified period. It can be applied globally or per role,
@@ -1,6 +1,9 @@
---
title: Run Teleport with the PROXY Protocol
description: How to securely configure PROXY protocol usage with Teleport.
labels:
- how-to
- platform-wide
---
This guide shows you how to configure the Teleport Auth Service and Proxy
@@ -1,6 +1,9 @@
---
title: Reducing the Blast Radius of Attacks
description: How to configure Teleport to minimize the scope of security breaches
labels:
- conceptual
- platform-wide
---
Teleport encourages users to practice defense in depth so that every component of their infrastructure is safe against attacks, even if an attacker is partially successful. You can configure Teleport to add layers of protection to your cluster when users authenticate or request elevated privileges. In this guide, we will show you how to:
@@ -1,6 +1,9 @@
---
title: Restrict Access for Privileged Accounts
description: Explains the risks of root-level access to Teleport-protected resources.
labels:
- conceptual
- zero-trust
---
As an administrator, you need to make informed decisions about when and how to grant
@@ -1,6 +1,8 @@
---
title: Revoking Access
description: Learn how to revoke access before Teleport certificates expire
labels:
- platform-wide
---
Teleport's approach to using short-lived certificates for all infrastructure
@@ -1,6 +1,8 @@
---
title: Secure Practices for Teleport Clusters
description: Highlights recommended practices and ways to harden security for your Teleport cluster.
labels:
- zero-trust
---
To help ensure that Teleport can protect your infrastructure in a production environment, you should
@@ -1,6 +1,9 @@
---
title: "SELinux Module for Teleport SSH Service"
description: "How to configure SELinux to enforce Teleport SSH Service."
labels:
- conceptual
- zero-trust
---
<Admonition type="note">
@@ -1,6 +1,9 @@
---
title: Migrate Between Teleport Plans
description: Explains how to migrate between Teleport Enterprise (Self-Hosted), Teleport Enterprise (Cloud), and Teleport Community Edition.
labels:
- how-to
- platform-wide
---
This guide explains how to migrate from Teleport Community Edition, Teleport
+3
View File
@@ -1,6 +1,9 @@
---
title: Teleport Changelog
description: The Changelog provides a comprehensive description of the changes introduced by each Teleport release.
labels:
- reference
- platform-wide
---
{/*lint disable absolute-docs-links*/}
@@ -1,6 +1,8 @@
---
title: Teleport User Guides
description: Provides instructions to help users connect to infrastructure resources with Teleport.
labels:
- platform-wide
---
<DocCardList />
@@ -1,6 +1,9 @@
---
title: Database Access GUI Clients
description: How to configure graphical database clients for Teleport database access.
labels:
- how-to
- zero-trust
---
This guide describes how to configure popular graphical database clients to
@@ -1,6 +1,9 @@
---
title: Introduction to Teleport Clients
description: The basics of connecting to resources with Teleport
labels:
- conceptual
- platform-wide
---
This guide covers the basics of authenticating to Teleport and
@@ -1,6 +1,9 @@
---
title: Notifications
description: Provides a detailed breakdown of Teleport's notification system.
labels:
- conceptual
- platform-wide
---
Teleport's notification system allows users to be notified of various events, updates, and warnings in real time.
@@ -1,6 +1,9 @@
---
title: Using PuTTY and WinSCP with Teleport
description: This reference shows you how to use PuTTY to connect to SSH nodes and WinSCP to transfer files through Teleport
labels:
- conceptual
- platform-wide
---
This guide will show you how to use the Teleport client tool `tsh` to add saved sessions for use

Some files were not shown because too many files have changed in this diff Show More