Desktop Access Configuration Reference
teleport.yaml fields related to Desktop Access:
# 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. windows_desktop_service: enabled: yes # This is the address that windows_desktop_service will listen on. listen_addr: "localhost:3028" # (optional) This is the address that windows_desktop_service will advertise # to the rest of Teleport for incoming connections. Only proxy_service should # connect to windows_desktop_service, users connect to the proxy's web UI # instead. public_addr: "desktop-access.example.com:3028" ldap: # Address of the LDAP server for secure LDAP connections. # Usually, this address will use port 636, like: ldap.example.com:636. # For best results, this address should point to a highly-available # endpoint (a load balancer, VIP, or round-robin DNS) rather than # a single domain controller. addr: '$LDAP_SERVER_ADDRESS' # Active Directory domain name you are connecting to. domain: '$LDAP_DOMAIN_NAME' # LDAP username for authentication. This username must include the domain # NetBIOS name. The use of single quotes here is intentional in order to # avoid the need to escape the backslash (\) character. # # For example, if your domain is "example.com", the NetBIOS name for it is # likely "EXAMPLE". When connecting as the "svc-teleport" user, you should # use the format: "EXAMPLE\svc-teleport". username: '$LDAP_USERNAME' # You can skip LDAPS certificate verification by setting # this to true. It is recommended that this be set to false # and the certificate added your system's trusted repository, # or provided as a PEM encoded certificate using ldap_ca_cert variable. # You can provide a filepath with der_ca_file, but this behavior is deprecated. insecure_skip_verify: false # PEM encoded LDAP CA certificate. ldap_ca_cert: | -----BEGIN CERTIFICATE----- *certificate data* -----END CERTIFICATE----- # DER encoded LDAP CA certificate. # deprecated: prefer ldap_ca_cert instead der_ca_file: /path/to/cert # (optional) hosts is a list of hostnames to register as WindowsDesktop # objects in Teleport. hosts: - win1.example.com - win2.example.com - ... # (optional) settings for enabling automatic desktop discovery via LDAP discovery: # The wildcard '*' character tells Teleport to discover all the hosts in # the Active Directory Domain. To refine the search, specify a custom DN. # To disable automatic discovery, leave this field blank. base_dn: '*' # (optional) LDAP filters for further customizing the LDAP search. # See https://ldap.com/ldap-filters for details on LDAP filter syntax. filters: - '(location=Oakland)' - '(!(primaryGroupID=516))' # exclude domain controllers # (optional) LDAP attributes to convert into Teleport labels. # The key of the label will be "ldap/" + the value of the attribute. label_attributes: - location # Rules for applying labels to Windows hosts based on regular expressions # matched against the host name. If multiple rules match, the desktop will # get the union of all matching labels. host_labels: - match: '^.*\.dev\.example\.com$' labels: environment: dev - match: '^.*\.prod\.example\.com$' labels: environment: prod # Labels to attach to the Windows Desktop Service. This is used internally, so # any custom labels added won't affect the Windows hosts. labels: teleport.internal/resource-id: "resource-id"
The Windows Desktop Service can be deployed in two modes.
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
teleport.yaml, and ensure that
teleport.auth_servers 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.
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
windows_desktop_service.listen_addr is unset, and point
teleport.auth_servers at a Teleport Proxy.