Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v16] docs: motd and self-hosted db ca updates #49706

Merged
merged 1 commit into from
Dec 3, 2024
Merged

[v16] docs: motd and self-hosted db ca updates #49706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pages/includes/database-access/self-hosted-introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ system](../../enroll-resources/database-access/rbac.mdx).

The Teleport Database Service proxies traffic from database clients to
self-hosted databases in your infrastructure. Teleport maintains a certificate
authority for database clients. You configure your database to trust the
authority (CA) for database clients. You configure your database to trust the
Teleport database client CA, and the Teleport Database Service presents
certificates signed by this CA when proxying user traffic. With this setup,
there is no need to store long-lived credentials for self-hosted databases.

Meanwhile, the Teleport Database Service verifies self-hosted databases by
checking their TLS certificates against either the Teleport database CA or a
custom CA chosen by the user.
custom CA used with the database.

In this guide, you will:

Expand Down
46 changes: 46 additions & 0 deletions docs/pages/reference/access-controls/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,49 @@

</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: |
Welcome to the Example Teleport Cluster
All activity is monitored and should follow organization policies
```

Restart the Teleport Auth Service instances to apply this change.

### Teleport Enterprise Cloud/Dynamic

Check failure on line 290 in docs/pages/reference/access-controls/authentication.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.edition-names] "Teleport Enterprise Cloud" is no longer a recognized Teleport edition. Use "Teleport Enterprise" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., "Teleport Enterprise (self-hosted)" or "Teleport Enterprise (cloud-hosted)".

Raw Output:
{"message": "[messaging.edition-names] \"Teleport Enterprise Cloud\" is no longer a recognized Teleport edition. Use \"Teleport Enterprise\" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., \"Teleport Enterprise (self-hosted)\" or \"Teleport Enterprise (cloud-hosted)\".", "location": {"path": "docs/pages/reference/access-controls/authentication.mdx", "range": {"start": {"line": 290, "column": 5}}}, "severity": "ERROR"}

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: |
Welcome to the Example Teleport Cluster
All activity is monitored and should follow organization policies
type: local
second_factor: "on"
webauthn:
rp_id: example.teleport.sh
version: v2
```

Save and close the file in your editor to apply changes.
Loading