Skip to content

Edit Homebrew installation instructions #24278

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
ptgott merged 2 commits into from
Apr 19, 2023
Merged

Edit Homebrew installation instructions #24278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0ec71f
Edit Homebrew installation instructions
ptgott Apr 7, 2023
b676052
Get the Installer tab to render correctly
ptgott Apr 18, 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
70 changes: 34 additions & 36 deletions docs/pages/installation.mdx
View file
Open in desktop
Comment thread
alexfornuto marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,8 @@ chart.

## macOS

<Tabs dropdownView dropdownCaption="Teleport Edition">
<TabItem label="Open Source" scope="oss">
<Tabs>
<TabItem label="Installer">

<Tabs dropdownCaption="Teleport Edition">
<TabItem label="Installer" options="Open Source" scope="oss">
You can download one of the following .pkg installers for macOS:

|Link|Binaries|
Expand All @@ -130,50 +127,51 @@ chart.
# /usr/local/bin/teleport
```

</TabItem>
</TabItem>
<TabItem label="Homebrew" options="Open Source">

<TabItem label="Homebrew">
<Notice type="danger">
<Notice type="danger">

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 [official
Teleport packages](https://goteleport.com/download). Binaries provided by Homebrew
are not signed by Teleport, so features that require signed and notarized binaries
(TouchID, Device Trust) are not available in Homebrew builds.
The Teleport package in Homebrew is not maintained by Teleport and we can't
guarantee its reliability or security.

<ScopedBlock scope={["enterprise", "cloud"]}>
</Notice>

The Homebrew version of Teleport lacks the ability to maintain SAML/OIDC authentication
connectors through the `tctl` binary. We recommend installing the official Teleport Enterprise edition of `tctl`.
### Warnings

</ScopedBlock>
We recommend the use of our [official
Teleport packages](https://goteleport.com/download). Binaries provided by Homebrew
are not signed by Teleport, so features that require signed and notarized binaries
(TouchID, Device Trust) are not available in Homebrew builds.

</Notice>
The `tctl` release available on Homebrew is the open source edition, and
cannot manage configuration resources unique to Teleport Enterprise and
Teleport Enterprise Cloud (e.g., OIDC and SAML connectors). For Teleport
Enterprise and Enterprise Cloud, we recommend installing the official Teleport
Enterprise edition of `tctl`.

To install Teleport with Homebrew, run the following command:
### Installing open source Teleport with Homebrew

```code
$ brew install teleport
```
To install Teleport with Homebrew, run the following command:

If you choose to use Homebrew, you must verify that the versions of `tsh`
and `tctl` you run on your local machine are compatible with the versions
you run on your infrastructure. Homebrew usually ships the latest release of
Teleport, which may be incompatible with older versions. See our
[compatibility policy](management/operations/upgrading.mdx) for details.
```code
$ brew install teleport
```

To verify versions, log in to your cluster and compare the output of `tctl status`
against `tsh version` and `tctl version`.
If you choose to use Homebrew, you must verify that the versions of `tsh`
and `tctl` you run on your local machine are compatible with the versions
you run on your infrastructure. Homebrew usually ships the latest release of
Teleport, which may be incompatible with older versions. See our
[compatibility policy](management/operations/upgrading.mdx) for details.

</TabItem>
</Tabs>
</TabItem>
To verify versions, log in to your cluster and compare the output of `tctl status`
against `tsh version` and `tctl version`.

<TabItem label="Enterprise" scope="enterprise">
(!docs/pages/includes/enterprise/install-macos.mdx!)
</TabItem>
<TabItem label="Cloud" scope="cloud">
(!docs/pages/includes/enterprise/install-macos.mdx!)
<TabItem label="Installer " options="Enterprise,Cloud" scope={["enterprise", "cloud"]}>

(!docs/pages/includes/enterprise/install-macos.mdx!)

</TabItem>
</Tabs>

Expand Down