Skip to content

Commit

Permalink
docs: Don't provide commands to use Homebrew (#44943)
Browse files Browse the repository at this point in the history
* docs: Don't provide commands to use Homebrew

Also clarify language around Touch ID support in versions installed from Homebrew

* Add note about building from source

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <[email protected]>

---------

Co-authored-by: Zac Bergquist <[email protected]>
  • Loading branch information
webvictim and zmb3 authored Aug 1, 2024
1 parent 3cef737 commit 2885f03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/pages/access-controls/guides/passwordless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ usernameless authentication for Teleport.
- A web browser with WebAuthn support. To see if your browser supports
WebAuthn, check the [WebAuthn
Compatibility](https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) page.
- A signed and notarized version of `tsh` is required for Touch ID. This precludes
versions installed from Homebrew. [Download the macOS tsh installer](../../installation.mdx#macos).
- A signed and notarized version of `tsh` is required for Touch ID. This means versions
installed from Homebrew or compiled from source will not work. [Download the macOS tsh installer](../../installation.mdx#macos).
- (!docs/pages/includes/tctl.mdx!)

A Teleport cluster capable of WebAuthn is automatically capable of passwordless.
Expand Down
17 changes: 6 additions & 11 deletions docs/pages/includes/install-tsh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,13 @@
</TabItem>

<TabItem label="Mac - Homebrew">
```code
$ brew install teleport
```

<Admonition type="note">
The Teleport package in Homebrew is not maintained by Teleport and we can't
guarantee its reliability or security. We recommend the use of our [own Teleport packages](https://goteleport.com/download?os=mac).
<Admonition type="danger">
Using Homebrew to install Teleport is not supported. The Teleport package in
Homebrew is not maintained by Teleport and we can't guarantee its reliability or
security.

If you choose to use Homebrew, you must verify that the versions of `tsh` and
`tctl` are compatible with the versions you run server-side. Homebrew usually
ships the latest release of Teleport, which may be incompatible with older
versions. See our [compatibility policy](../upgrading/overview.mdx) for details.
We recommend the use of our [own Teleport packages](https://goteleport.com/download?os=mac)
for any installations on macOS.
</Admonition>
</TabItem>

Expand Down

0 comments on commit 2885f03

Please sign in to comment.