mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-01 13:39:37 +08:00
Paul Gottschling
5ba910b38f
* Provide more context in the docs intro page Closes #22469 The current docs landing page does not include enough context for new readers. After the general description of Teleport, the rest of the landing page is series of links, with little guidance for what a new user should do first (or what an intermediate user should do after completing the initial setup steps). This change takes a more narrative approach to the landing page, briefly describing the content of each top-level docs section and putting it in context with the rest of the docs. This also helps users find the right top-level docs section for their needs, since otherwise the only way to do this is to visit each section. This change is also more opinionated about which guide new users should begin with. It recommends the guide to getting started with Teleport Cloud, since this doesn't require setting up a Teleport cluster and helps a user register a resource quickly. The landing page links to the introduction page of each top-level docs section. If a section does not have an introduction page, this change adds one. * Respond to zmb3 feedback Reorder list items * Linter fixes * Respond to alexfornuto PR feedback
45 lines
1.9 KiB
Plaintext
45 lines
1.9 KiB
Plaintext
---
|
|
title: Reference
|
|
description: Comprehensive guides to configuring and running Teleport
|
|
---
|
|
|
|
Teleport's reference guides provide comprehensive resources for configuring and
|
|
running Teleport.
|
|
|
|
- [Configuration](./config.mdx): All configuration options for the `teleport`
|
|
binary.
|
|
- [CLI](./cli.mdx): Commands, flags, and arguments for Teleport's CLI tools.
|
|
- [Predicate Language](./predicate-language.mdx): The syntax for Teleport's
|
|
predicate language, which is used to define RBAC policies and search for
|
|
resources.
|
|
- [Audit Events](./audit.mdx): A reference of Teleport's audit events.
|
|
- [Helm Reference](./helm-reference.mdx): References for Teleport's Helm charts.
|
|
- [Networking](./networking.mdx): Ports that Teleport services listen on, plus
|
|
other information about how Teleport services communicate.
|
|
- [Authentication](./authentication.mdx): Teleport's authentication connectors.
|
|
- [Signals](./signals.mdx): The signals you can use to control a Teleport
|
|
binary.
|
|
- [Backends](./backends.mdx): Configuration options and required setup steps for
|
|
Teleport's Auth Service storage backends.
|
|
- [Terraform Provider](./terraform-provider.mdx): Configuration options and
|
|
resources for the Teleport Terraform provider.
|
|
- [Metrics](./metrics.mdx): All metrics available in Teleport.
|
|
- [Resources](./resources.mdx): Configuration resources you can apply in
|
|
Teleport.
|
|
|
|
<Admonition type="tip">
|
|
|
|
This section contains references that apply to all Teleport services. For
|
|
references that are relevant to a single Teleport service or use case, consult
|
|
the appropriate section of the documentation:
|
|
|
|
- [Teleport Application Service](../application-access/reference.mdx)
|
|
- [Teleport Database Service](../database-access/reference.mdx)
|
|
- [Teleport Desktop Service](../desktop-access/reference.mdx)
|
|
- [Machine ID](../machine-id/reference.mdx)
|
|
- [RBAC](../access-controls/reference.mdx)
|
|
- [Login Rules](../access-controls/login-rules/reference.mdx)
|
|
|
|
</Admonition>
|
|
|