From b39f4478278b77f9db3087c0b79c8eb378eb3fb3 Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Thu, 20 Feb 2025 08:59:24 -0500 Subject: [PATCH 1/2] document homebrew --- docs/guides/install/_homebrew.mdx | 4 + docs/guides/install/linux.mdx | 139 +++++------------- docs/guides/install/macos.mdx | 5 + .../version-0.4/guides/install/linux.mdx | 139 +++++------------- .../version-0.4/guides/install/macos.mdx | 5 + 5 files changed, 92 insertions(+), 200 deletions(-) create mode 100644 docs/guides/install/_homebrew.mdx diff --git a/docs/guides/install/_homebrew.mdx b/docs/guides/install/_homebrew.mdx new file mode 100644 index 00000000..db72444e --- /dev/null +++ b/docs/guides/install/_homebrew.mdx @@ -0,0 +1,4 @@ + +```text +brew install zrok +``` diff --git a/docs/guides/install/linux.mdx b/docs/guides/install/linux.mdx index b66131f2..aa666c1b 100644 --- a/docs/guides/install/linux.mdx +++ b/docs/guides/install/linux.mdx @@ -8,6 +8,44 @@ import DownloadCard from '@site/src/components/download-card'; import styles from '@site/src/css/download-card.module.css'; import AnsibleRepoSetup from './_ansible_repo_setup.yaml' import ConcatenateYamlSnippets from '@site/src/components/cat-yaml.jsx' +import Homebrew from './_homebrew.mdx'; + +## Install `zrok` from the Repository + +This will configure the system to receive DEB or RPM package updates. + +```text +curl -sSf https://get.openziti.io/install.bash | sudo bash -s zrok +``` + +:::info +Check out [zrok frontdoor](/guides/frontdoor.mdx?os=Linux) for running `zrok` as an always-on service. +::: + +
+Ansible Playbook + + +{AnsibleRepoSetup} +{` +- name: Install zrok package + gather_facts: false + hosts: all + become: true + tasks: + - name: Install zrok + ansible.builtin.package: + name: zrok + state: present +`} + + +
+ +## Homebrew + + ## Linux Binary @@ -95,103 +133,4 @@ sudo install -o root -g root ./zrok /usr/local/bin/; zrok version; ``` - -## Install `zrok` from the Repository - -We recommend that you install `zrok` from the Linux package repository with the manual steps or the setup script. DEB and RPM packages are available for amd64, arm64, and armv7 architectures. - -:::info - -Check out [zrok frontdoor](/guides/frontdoor.mdx?os=Linux) for running `zrok` as an always-on service. - -::: - -
-Manually set up DEB repository - -```text -(set -euo pipefail; - -curl -sSLf https://get.openziti.io/tun/package-repos.gpg \ -| sudo gpg --dearmor --output /usr/share/keyrings/openziti.gpg; -sudo chmod a+r /usr/share/keyrings/openziti.gpg; - -sudo tee /etc/apt/sources.list.d/openziti-release.list >/dev/null < - -
-Manually set up RPM repository - -```text -(set -euo pipefail; - -sudo tee /etc/yum.repos.d/openziti-release.repo >/dev/null <<\EOF; -[OpenZitiRelease] -name=OpenZiti Release -baseurl=https://packages.openziti.org/zitipax-openziti-rpm-stable/redhat/$basearch -enabled=1 -gpgcheck=0 -gpgkey=https://packages.openziti.org/zitipax-openziti-rpm-stable/redhat/$basearch/repodata/repomd.xml.key -repo_gpgcheck=1 -EOF - -sudo dnf update; -sudo dnf install zrok; -zrok version; -) -``` - -
- -
-Script to set up DEB or RPM repository - -1. Download the zrok install script. - - ```text - curl -sSLfo ./zrok-install.bash https://get.openziti.io/install.bash - ``` - -1. Inspect the script to ensure it is suitable to run as root on your system. - - ```text - less ./zrok-install.bash - ``` - -1. Run the script as root to add the package repo and install the `zrok` package. - - ```text - sudo bash ./zrok-install.bash zrok - ``` - -
- -
-Ansible Playbook - - -{AnsibleRepoSetup} -{` -- name: Install zrok package - gather_facts: false - hosts: all - become: true - tasks: - - name: Install zrok - ansible.builtin.package: - name: zrok - state: present -`} - - -
+
\ No newline at end of file diff --git a/docs/guides/install/macos.mdx b/docs/guides/install/macos.mdx index c7983404..ed3d756c 100644 --- a/docs/guides/install/macos.mdx +++ b/docs/guides/install/macos.mdx @@ -6,6 +6,11 @@ sidebar_label: macOS import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import styles from '@site/src/css/download-card.module.css'; +import Homebrew from './_homebrew.mdx'; + +## Homebrew + + ## Darwin Binary diff --git a/website/versioned_docs/version-0.4/guides/install/linux.mdx b/website/versioned_docs/version-0.4/guides/install/linux.mdx index b66131f2..11e2666e 100644 --- a/website/versioned_docs/version-0.4/guides/install/linux.mdx +++ b/website/versioned_docs/version-0.4/guides/install/linux.mdx @@ -8,6 +8,44 @@ import DownloadCard from '@site/src/components/download-card'; import styles from '@site/src/css/download-card.module.css'; import AnsibleRepoSetup from './_ansible_repo_setup.yaml' import ConcatenateYamlSnippets from '@site/src/components/cat-yaml.jsx' +import Homebrew from '/../../docs/guides/install/_homebrew.mdx'; + +## Install `zrok` from the Repository + +This will configure the system to receive DEB or RPM package updates. + +```text +curl -sSf https://get.openziti.io/install.bash | sudo bash -s zrok +``` + +:::info +Check out [zrok frontdoor](/guides/frontdoor.mdx?os=Linux) for running `zrok` as an always-on service. +::: + +
+Ansible Playbook + + +{AnsibleRepoSetup} +{` +- name: Install zrok package + gather_facts: false + hosts: all + become: true + tasks: + - name: Install zrok + ansible.builtin.package: + name: zrok + state: present +`} + + +
+ +## Homebrew + + ## Linux Binary @@ -95,103 +133,4 @@ sudo install -o root -g root ./zrok /usr/local/bin/; zrok version; ``` - -## Install `zrok` from the Repository - -We recommend that you install `zrok` from the Linux package repository with the manual steps or the setup script. DEB and RPM packages are available for amd64, arm64, and armv7 architectures. - -:::info - -Check out [zrok frontdoor](/guides/frontdoor.mdx?os=Linux) for running `zrok` as an always-on service. - -::: - -
-Manually set up DEB repository - -```text -(set -euo pipefail; - -curl -sSLf https://get.openziti.io/tun/package-repos.gpg \ -| sudo gpg --dearmor --output /usr/share/keyrings/openziti.gpg; -sudo chmod a+r /usr/share/keyrings/openziti.gpg; - -sudo tee /etc/apt/sources.list.d/openziti-release.list >/dev/null < - -
-Manually set up RPM repository - -```text -(set -euo pipefail; - -sudo tee /etc/yum.repos.d/openziti-release.repo >/dev/null <<\EOF; -[OpenZitiRelease] -name=OpenZiti Release -baseurl=https://packages.openziti.org/zitipax-openziti-rpm-stable/redhat/$basearch -enabled=1 -gpgcheck=0 -gpgkey=https://packages.openziti.org/zitipax-openziti-rpm-stable/redhat/$basearch/repodata/repomd.xml.key -repo_gpgcheck=1 -EOF - -sudo dnf update; -sudo dnf install zrok; -zrok version; -) -``` - -
- -
-Script to set up DEB or RPM repository - -1. Download the zrok install script. - - ```text - curl -sSLfo ./zrok-install.bash https://get.openziti.io/install.bash - ``` - -1. Inspect the script to ensure it is suitable to run as root on your system. - - ```text - less ./zrok-install.bash - ``` - -1. Run the script as root to add the package repo and install the `zrok` package. - - ```text - sudo bash ./zrok-install.bash zrok - ``` - -
- -
-Ansible Playbook - - -{AnsibleRepoSetup} -{` -- name: Install zrok package - gather_facts: false - hosts: all - become: true - tasks: - - name: Install zrok - ansible.builtin.package: - name: zrok - state: present -`} - - -
+
\ No newline at end of file diff --git a/website/versioned_docs/version-0.4/guides/install/macos.mdx b/website/versioned_docs/version-0.4/guides/install/macos.mdx index c7983404..49fadfc5 100644 --- a/website/versioned_docs/version-0.4/guides/install/macos.mdx +++ b/website/versioned_docs/version-0.4/guides/install/macos.mdx @@ -6,6 +6,11 @@ sidebar_label: macOS import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import styles from '@site/src/css/download-card.module.css'; +import Homebrew from '/../../docs/guides/install/_homebrew.mdx'; + +## Homebrew + + ## Darwin Binary From 30d00df01bba6e832ac464b6e2dfc191af833a7e Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Thu, 20 Feb 2025 09:12:50 -0500 Subject: [PATCH 2/2] refine install card text hints --- docs/getting-started.mdx | 24 ++-------------- docs/guides/install/_install_cards.mdx | 26 +++++++++++++++++ docs/guides/install/index.mdx | 28 ++----------------- .../version-0.4/getting-started.mdx | 24 ++-------------- .../version-0.4/guides/install/index.mdx | 25 ++--------------- 5 files changed, 34 insertions(+), 93 deletions(-) create mode 100644 docs/guides/install/_install_cards.mdx diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 6632c532..de4f9f18 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -7,6 +7,7 @@ sidebar_position: 10 import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import DownloadCardStyles from '@site/src/css/download-card.module.css'; +import InstallCards from '/../docs/guides/install/_install_cards.mdx'; ## Your Secure Internet Sharing Perimeter @@ -102,28 +103,7 @@ If [sharing privately](./concepts/sharing-private.mdx), only users with the shar ## Installing the zrok Command - -
- - - -
-
+ ## Enabling Your zrok Environment diff --git a/docs/guides/install/_install_cards.mdx b/docs/guides/install/_install_cards.mdx new file mode 100644 index 00000000..922616c8 --- /dev/null +++ b/docs/guides/install/_install_cards.mdx @@ -0,0 +1,26 @@ +import { AssetsProvider } from '@site/src/components/assets-context'; +import DownloadCard from '@site/src/components/download-card'; +import DownloadCardStyles from '@site/src/css/download-card.module.css'; + + +
+ + + +
+
diff --git a/docs/guides/install/index.mdx b/docs/guides/install/index.mdx index e70acbd9..b0571982 100644 --- a/docs/guides/install/index.mdx +++ b/docs/guides/install/index.mdx @@ -2,30 +2,6 @@ title: Install --- -import { AssetsProvider } from '@site/src/components/assets-context'; -import DownloadCard from '@site/src/components/download-card'; -import styles from '@site/src/css/download-card.module.css'; - - -
- - - -
-
+import InstallCards from './_install_cards.mdx'; + \ No newline at end of file diff --git a/website/versioned_docs/version-0.4/getting-started.mdx b/website/versioned_docs/version-0.4/getting-started.mdx index 6632c532..de4f9f18 100644 --- a/website/versioned_docs/version-0.4/getting-started.mdx +++ b/website/versioned_docs/version-0.4/getting-started.mdx @@ -7,6 +7,7 @@ sidebar_position: 10 import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import DownloadCardStyles from '@site/src/css/download-card.module.css'; +import InstallCards from '/../docs/guides/install/_install_cards.mdx'; ## Your Secure Internet Sharing Perimeter @@ -102,28 +103,7 @@ If [sharing privately](./concepts/sharing-private.mdx), only users with the shar ## Installing the zrok Command - -
- - - -
-
+ ## Enabling Your zrok Environment diff --git a/website/versioned_docs/version-0.4/guides/install/index.mdx b/website/versioned_docs/version-0.4/guides/install/index.mdx index e70acbd9..f8756b6d 100644 --- a/website/versioned_docs/version-0.4/guides/install/index.mdx +++ b/website/versioned_docs/version-0.4/guides/install/index.mdx @@ -5,27 +5,6 @@ title: Install import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import styles from '@site/src/css/download-card.module.css'; +import InstallCards from '/../../docs/guides/install/_install_cards.mdx'; - -
- - - -
-
- +