Skip to content

Commit 4103cb5

Browse files
authored
docs: provide guidance on setting environment variables for NLA (#59938)
We often get support requests for help on setting environment variables, particularly in regards to enabling NLA for Windows desktop access. Provide some high level guidance for both Kuberenetes and systemd. Closes #59731
1 parent 0dd97ba commit 4103cb5

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

docs/pages/enroll-resources/desktop-access/active-directory.mdx

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ To configure Teleport to protect access to Windows desktops:
641641
windows_desktop_service:
642642
enabled: true
643643
ldap:
644-
locate_server:
644+
locate_server:
645645
enabled: true
646646
site: "my-site" # optional
647647
domain: example.com
@@ -865,10 +865,33 @@ windows_desktop_service:
865865
```
866866

867867
To enable NLA, set the `TELEPORT_ENABLE_RDP_NLA` environment variable to `yes`
868-
on any hosts running the Teleport's `windows_desktop_service`. Note that NLA is
869-
only supported when connecting to hosts that are part of an Active Directory
870-
domain. Teleport will not perform NLA when connecting to hosts as a local
871-
Windows user.
868+
on any hosts running the Teleport's `windows_desktop_service`. The process for
869+
setting an environment variable varies depending on the environment in which you
870+
are running Teleport.
871+
872+
If you're running Teleport in Kubernetes, you'll need to
873+
[edit the Pod configuration](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/).
874+
875+
If you're running Teleport as a systemd service, then you'll want to create a
876+
systemd override using `systemctl edit teleport`:
877+
878+
```
879+
$ sudo systemctl edit teleport
880+
```
881+
882+
This will open a text editor where you can insert an override for the environment:
883+
884+
```
885+
### Editing /etc/systemd/system/teleport.service.d/override.conf
886+
### Anything between here and the comment below will become the contents of the drop-in file
887+
888+
[Service]
889+
Environment="TELEPORT_ENABLE_RDP_NLA=yes"
890+
```
891+
892+
Note that NLA is only supported when connecting to hosts that are part of an
893+
Active Directory domain. Teleport will not perform NLA when connecting to hosts
894+
as a local Windows user.
872895

873896
NLA is not supported when Teleport runs in FIPS mode.
874897

0 commit comments

Comments
 (0)