mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-02 14:59:53 +08:00
Paul GottschlingandAlex Fornuto
da0e53ecdb
* Reorganize the config reference Closes #11253 This change breaks up the config reference by moving each Teleport service's configuration settings into a separate YAML snippet, and organizing each YAML snippet into a `TabItem` within a `Tabs` with `dropdownView` enabled. When Teleport Enterprise Cloud doesn't support a service, this change adds a `Notice` with a message about Teleport Enterprise Cloud in the relevant `TabItem`. I thought this approach would be cleaner than alternatives: - **Including an H2 for each service:** With this approach, the configuration reference would be even longer than it is now. With the approach I'm proposing, readers would navigate to "Reference configurations", then choose a service from a dropdown menu: much less scrolling for slightly more clicking. - **Including another set of `TabItem`s for Teleport editions:** I thought about adding a `Tabs` with a dropdown option for each Teleport edition and a horizontal `TabItem` for each service, but this would require horizontal scrolling and doesn't scale very well. - **Including horizontal tabs for each Teleport edition**, with an inner dropdown menu for each Teleport service: There is currently no way to do this without multiple `Tabs` components, which gets messy quickly. **Note** that this change does not attempt to copy-edit comments/example values within the configuration snippets. The scope of this change is limited only to reorganization. * Respond to PR feedback * Update docs/pages/includes/config-reference/instance-wide.yaml Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Respond to PR feedback Use headings instead of `TabItem`s to split up sections of the config reference. --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
41 lines
1.5 KiB
Plaintext
41 lines
1.5 KiB
Plaintext
---
|
|
title: Desktop Access Configuration Reference
|
|
description: Configuration reference for Teleport Desktop Access.
|
|
---
|
|
|
|
# Windows Desktop Service configuration
|
|
|
|
`teleport.yaml` fields related to Desktop Access:
|
|
|
|
```yaml
|
|
# Main service responsible for Desktop Access.
|
|
#
|
|
# You can have multiple Desktop Access services in your cluster (but not in the
|
|
# same teleport.yaml), connected to the same or different Active Directory
|
|
# domains.
|
|
(!docs/pages/includes/config-reference/desktop-config.yaml!)
|
|
```
|
|
|
|
## Deployment
|
|
|
|
The Windows Desktop Service can be deployed in two modes.
|
|
|
|
### Direct mode
|
|
|
|
In *direct* mode, Windows Desktop Services registers directly with the Teleport
|
|
Auth Server, and listens for desktop connections from the Teleport Proxy. To
|
|
enable direct mode, set `windows_desktop_service.listen_addr` in
|
|
`teleport.yaml`, and ensure that `teleport.auth_server` points directly at the
|
|
Auth Server. Direct mode requires network connectivity from the Teleport Proxy
|
|
to Windows Desktop Service, and from Windows Desktop Service to the Auth Server.
|
|
|
|
### IoT mode (reverse tunnel)
|
|
|
|
In *IoT mode*, Windows Desktop Service only needs to be able to make an outbound
|
|
connection to a Teleport Proxy. The Windows Desktop Service establishes a
|
|
reverse tunnel to the proxy, and both registration with the Auth Server and
|
|
desktop sessions are performed over this tunnel. To enable this mode, ensure
|
|
that `windows_desktop_service.listen_addr` is *unset*, and point
|
|
`teleport.proxy_server` at a Teleport Proxy.
|
|
|