Skip to content

[v13] Add Teleport Connect to Headless docs #30476

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

Merged
Joerger merged 2 commits into from
Aug 16, 2023
Merged

[v13] Add Teleport Connect to Headless docs #30476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
400cb12
Add Teleport Connect docs for headless login.
Joerger Aug 10, 2023
7066da6
Address comments.
Joerger Aug 13, 2023
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
Binary file added docs/img/headless/approval.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/headless/confirmation.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/pages/access-controls/guides/headless.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ For example:
- Machines for Headless WebAuthn activities have [Linux](../../installation.mdx#linux), [macOS](../../installation.mdx#macos) or [Windows](../../installation.mdx#windows-tsh-client-only) `tsh` binary v12.2+ installed.
- Machines used to approve Headless WebAuthn requests have a Web browser with [WebAuthn support](
https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) or `tsh` binary v12.2+ installed.
- Optional: Teleport Connect v13.3.1+ for [seamless headless approval](#optional-teleport-connect).

## Step 1/3. Configuration

Expand Down Expand Up @@ -178,6 +179,26 @@ alice@server01 $
your local terminal.
</Notice>

## Optional: Teleport Connect

Teleport Connect v13.3.1+ can also be used to approve headless logins.
Teleport Connect will automatically detect the headless login attempt
Copy link
Copy Markdown
Contributor

@ptgott ptgott Aug 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment doesn't apply to this PR, since it's a backport, but we should go in later and make sure that the product name is consistent across the docs. There's a mix of "headless login" and "Headless WebAuthn".

Copy link
Copy Markdown
Contributor Author

@Joerger Joerger Aug 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my backport did not include your suggestions by mistake, fixed in #30594

and allow you to approve or cancel the request.

<Figure width="700">
![Headless Confirmation](../../../img/headless/confirmation.png)
</Figure>

You will be prompted to tap your MFA key to complete the approval process.

<Figure width="700">
![Headless WebAuthn Approval](../../../img/headless/approval.png)
</Figure>

<Notice type="note">
This also requires a v13.3.1+ Teleport Auth server.
</Notice>

## Troubleshooting

### "WARN: Failed to lock system memory for headless login: ..."
Expand Down
1 change: 1 addition & 0 deletions docs/pages/connect-your-client/teleport-connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ Below is the list of the supported config properties.
| `keymap.openClusters` | `Command+E` on macOS<br/>`Ctrl+E` on Windows/Linux | Shortcut to open the cluster selector. |
| `keymap.openProfiles` | `Command+I` on macOS<br/>`Ctrl+I` on Windows/Linux | Shortcut to open the profile selector. |
| `keymap.openSearchBar` | `Command+K` on macOS<br/>`Ctrl+K` on Windows/Linux | Shortcut to open the search bar. |
| `headless.skipConfirm` | false | Skips the confirmation prompt for headless login approval and instead prompts for WebAuthn immediately. |

<Admonition
type="note"
Expand Down