Merge pull request #218 from telepresenceio/thallgren/brew-install

Add brew install instruction for 2.20 docs.
telepresenceio · Oct 8, 2024 · 82314ae · 82314ae
2 parents 9534423 + db699cc
commit 82314ae
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 13 deletions.
diff --git a/versioned_docs/version-2.20/install/client.md b/versioned_docs/version-2.20/install/client.md
@@ -14,22 +14,31 @@ Install the Telepresence client on your workstation by running the commands belo
 <Platform.TabGroup>
 <Platform.MacOSTab>
 
+## Install with brew:
 ```shell
-# Intel Macs
+brew install telepresenceio/telepresence/telepresence-oss
+```
+
+## OR download the binary for your platform
 
-# 1. Download the latest binary (~105 MB):
+### Intel Macs
+
+```shell
+# 1. Download the binary.
 sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-amd64 -o /usr/local/bin/telepresence
 
 # 2. Make the binary executable:
 sudo chmod a+x /usr/local/bin/telepresence
+```
 
-# Apple silicon Macs
+### Apple silicon Macs
 
+```shell
 # 1. Ensure that no old binary exists. This is very important because Silicon macs track the executable's signature
-#    and just updating it in place will not work.
-sudo rm -f /usr/local/bin/telepresence
+# and just updating it in place will not work.
+sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-amd64 -o /usr/local/bin/telepresence
 
-# 2. Download the latest binary (~101 MB):
+# 2. Download the binary.
 sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-arm64 -o /usr/local/bin/telepresence
 
 # 3. Make the binary executable:

diff --git a/versioned_docs/version-2.20/install/upgrade.md b/versioned_docs/version-2.20/install/upgrade.md
@@ -16,27 +16,36 @@ if your current version is less than 2.8.0).
 <Platform.TabGroup>
 <Platform.MacOSTab>
 
+## Upgrade with brew:
 ```shell
-# Intel Macs
+brew upgrade telepresenceio/telepresence/telepresence-oss
+```
+
+## OR upgrade by downloading the binary for your platform
 
-# 1. Download the latest binary (~105 MB):
+### Intel Macs
+
+```shell
+# 1. Download the binary.
 sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-amd64 -o /usr/local/bin/telepresence
 
 # 2. Make the binary executable:
 sudo chmod a+x /usr/local/bin/telepresence
+```
 
-# Apple silicon Macs
+### Apple silicon Macs
 
-# 1. Remove the old binary. This is very important on Silicon macs, because they keep track of the binary signature
-sudo rm /usr/local/bin/telepresence
+```shell
+# 1. Ensure that no old binary exists. This is very important because Silicon macs track the executable's signature
+# and just updating it in place will not work.
+sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-amd64 -o /usr/local/bin/telepresence
 
-# 2. Download the latest binary (~101 MB):
+# 2. Download the binary.
 sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/$dlVersion$/telepresence-darwin-arm64 -o /usr/local/bin/telepresence
 
 # 3. Make the binary executable:
 sudo chmod a+x /usr/local/bin/telepresence
 ```
-
 </Platform.MacOSTab>
 <Platform.GNULinuxTab>