docs: document motd configuration (#49526)

* docs: document motd configuration * docs: remove extra char * docs: correct spelling * docs: update verabiage for motd Co-authored-by: Paul Gottschling <[email protected]> * docs: update motd content * docs: update prose for motd --------- Co-authored-by: Paul Gottschling <[email protected]>
gravitational · Dec 2, 2024 · 5fd5e2a · 5fd5e2a
1 parent 7efa1a3
commit 5fd5e2a
Showing 1 changed file with 42 additions and 0 deletions.
diff --git a/docs/pages/reference/access-controls/authentication.mdx b/docs/pages/reference/access-controls/authentication.mdx
@@ -267,3 +267,45 @@ See [GitHub OAuth 2.0](../../admin-guides/access-controls/sso/github-sso.mdx) fo
 
 </TabItem>
 </Tabs>
+
+## Require displaying a message of the day
+
+Teleport can display a custom message of the day (MOTD) for users prior to authenticating
+in the Teleport Web UI and CLI. 
+
+### Self-Hosted
+
+Add the following to your Teleport configuration file, which is stored in
+`/etc/teleport.yaml` by default.
+
+  ```yaml
+  auth_service:
+  message_of_the_day: "\n Welcome to the Example Teleport Cluster\n  All activity is monitored and should follow organization policies\n"
+  ```
+
+Restart the Teleport Auth Service instances to apply this change.
+
+### Teleport Enterprise Cloud/Dynamic
+
+Edit your `cluster_auth_preference` resource:
+
+```code
+$ tctl edit cap
+```
+
+Ensure that the resource includes the `message_of_the_day` field:
+
+```yaml
+kind: cluster_auth_preference
+metadata:
+  name: cluster-auth-preference
+spec:
+  message_of_the_day: "\n Welcome to the Example Teleport Cluster\nAll activity is monitored and should follow organization policies\n"
+  type: local
+  second_factor: "on"
+  webauthn:
+    rp_id: example.teleport.sh
+version: v2
+```
+
+Save and close the file in your editor to apply changes.