extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-24 19:51:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #880 from openziti/doc-homebrew

Browse Source 
document homebrew
This commit is contained in:
Kenneth Bingham 2025-02-20 10:05:44 -05:00 committed by GitHub
commit 83469b4892
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 126 additions and 293 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/getting-started.mdx
View File

@ -7,6 +7,7 @@ sidebar_position: 10
import { AssetsProvider } from '@site/src/components/assets-context'; import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import DownloadCardStyles from '@site/src/css/download-card.module.css'; import DownloadCardStyles from '@site/src/css/download-card.module.css';
import InstallCards from '/../docs/guides/install/_install_cards.mdx';
## Your Secure Internet Sharing Perimeter ## 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 ## Installing the zrok Command
<AssetsProvider> <InstallCards />
<div className={DownloadCardStyles.downloadContainer}>
<DownloadCard
osName="Windows"
osLogo="/img/logo-windows.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/windows"
/>
<DownloadCard
osName="macOS"
osLogo="/img/logo-apple.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/macos"
/>
<DownloadCard
osName="Linux"
osLogo="/img/logo-linux.svg"
infoText="DEB, RPM packages"
guideLink="/docs/guides/install/linux"
/>
</div>
</AssetsProvider>
## Enabling Your zrok Environment ## Enabling Your zrok Environment

4
docs/guides/install/_homebrew.mdx Normal file
View File

@ -0,0 +1,4 @@
```text
brew install zrok
```

26
docs/guides/install/_install_cards.mdx Normal file
View File

@ -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';
<AssetsProvider>
<div className={DownloadCardStyles.downloadContainer}>
<DownloadCard
osName="Windows"
osLogo="/img/logo-windows.svg"
infoText="Download EXE"
guideLink="/docs/guides/install/windows"
/>
<DownloadCard
osName="macOS"
osLogo="/img/logo-apple.svg"
infoText="Homebrew or Download"
guideLink="/docs/guides/install/macos"
/>
<DownloadCard
osName="Linux"
osLogo="/img/logo-linux.svg"
infoText="RPM/DEB or Homebrew"
guideLink="/docs/guides/install/linux"
/>
</div>
</AssetsProvider>

28
docs/guides/install/index.mdx
View File

@ -2,30 +2,6 @@
title: Install title: Install
--- ---
import { AssetsProvider } from '@site/src/components/assets-context'; import InstallCards from './_install_cards.mdx';
import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css';
<AssetsProvider>
<div className={styles.downloadContainer}>
<DownloadCard
osName="Windows"
osLogo="/img/logo-windows.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/windows"
/>
<DownloadCard
osName="macOS"
osLogo="/img/logo-apple.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/macos"
/>
<DownloadCard
osName="Linux"
osLogo="/img/logo-linux.svg"
infoText="DEB, RPM packages"
guideLink="/docs/guides/install/linux"
/>
</div>
</AssetsProvider>
<InstallCards />

139
docs/guides/install/linux.mdx
View File

@ -8,6 +8,44 @@ import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css'; import styles from '@site/src/css/download-card.module.css';
import AnsibleRepoSetup from './_ansible_repo_setup.yaml' import AnsibleRepoSetup from './_ansible_repo_setup.yaml'
import ConcatenateYamlSnippets from '@site/src/components/cat-yaml.jsx' 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.
:::
<Details>
<summary>Ansible Playbook</summary>
<ConcatenateYamlSnippets
title="Set up package repository and install zrok">
{AnsibleRepoSetup}
{`
- name: Install zrok package
gather_facts: false
hosts: all
become: true
tasks:
- name: Install zrok
ansible.builtin.package:
name: zrok
state: present
`}
</ConcatenateYamlSnippets>
</Details>
## Homebrew
<Homebrew />
## Linux Binary ## Linux Binary
@ -95,103 +133,4 @@ sudo install -o root -g root ./zrok /usr/local/bin/;
zrok version; zrok version;
``` ```
</Details> </Details>
## 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.
:::
<Details>
<summary>Manually set up DEB repository</summary>
```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 <<EOF;
deb [signed-by=/usr/share/keyrings/openziti.gpg] https://packages.openziti.org/zitipax-openziti-deb-stable debian main
EOF
sudo apt update;
sudo apt install zrok;
zrok version;
)
```
</Details>
<Details>
<summary>Manually set up RPM repository</summary>
```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;
)
```
</Details>
<Details>
<summary>Script to set up DEB or RPM repository</summary>
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
```
</Details>
<Details>
<summary>Ansible Playbook</summary>
<ConcatenateYamlSnippets
title="Set up package repository and install zrok">
{AnsibleRepoSetup}
{`
- name: Install zrok package
gather_facts: false
hosts: all
become: true
tasks:
- name: Install zrok
ansible.builtin.package:
name: zrok
state: present
`}
</ConcatenateYamlSnippets>
</Details>

5
docs/guides/install/macos.mdx
View File

@ -6,6 +6,11 @@ sidebar_label: macOS
import { AssetsProvider } from '@site/src/components/assets-context'; import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css'; import styles from '@site/src/css/download-card.module.css';
import Homebrew from './_homebrew.mdx';
## Homebrew
<Homebrew />
## Darwin Binary ## Darwin Binary

24
website/versioned_docs/version-0.4/getting-started.mdx
View File

@ -7,6 +7,7 @@ sidebar_position: 10
import { AssetsProvider } from '@site/src/components/assets-context'; import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import DownloadCardStyles from '@site/src/css/download-card.module.css'; import DownloadCardStyles from '@site/src/css/download-card.module.css';
import InstallCards from '/../docs/guides/install/_install_cards.mdx';
## Your Secure Internet Sharing Perimeter ## 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 ## Installing the zrok Command
<AssetsProvider> <InstallCards />
<div className={DownloadCardStyles.downloadContainer}>
<DownloadCard
osName="Windows"
osLogo="/img/logo-windows.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/windows"
/>
<DownloadCard
osName="macOS"
osLogo="/img/logo-apple.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/macos"
/>
<DownloadCard
osName="Linux"
osLogo="/img/logo-linux.svg"
infoText="DEB, RPM packages"
guideLink="/docs/guides/install/linux"
/>
</div>
</AssetsProvider>
## Enabling Your zrok Environment ## Enabling Your zrok Environment

25
website/versioned_docs/version-0.4/guides/install/index.mdx
View File

@ -5,27 +5,6 @@ title: Install
import { AssetsProvider } from '@site/src/components/assets-context'; import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css'; import styles from '@site/src/css/download-card.module.css';
import InstallCards from '/../../docs/guides/install/_install_cards.mdx';
<AssetsProvider> <InstallCards />
<div className={styles.downloadContainer}>
<DownloadCard
osName="Windows"
osLogo="/img/logo-windows.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/windows"
/>
<DownloadCard
osName="macOS"
osLogo="/img/logo-apple.svg"
infoText="Binary executable"
guideLink="/docs/guides/install/macos"
/>
<DownloadCard
osName="Linux"
osLogo="/img/logo-linux.svg"
infoText="DEB, RPM packages"
guideLink="/docs/guides/install/linux"
/>
</div>
</AssetsProvider>

139
website/versioned_docs/version-0.4/guides/install/linux.mdx
View File

@ -8,6 +8,44 @@ import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css'; import styles from '@site/src/css/download-card.module.css';
import AnsibleRepoSetup from './_ansible_repo_setup.yaml' import AnsibleRepoSetup from './_ansible_repo_setup.yaml'
import ConcatenateYamlSnippets from '@site/src/components/cat-yaml.jsx' 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.
:::
<Details>
<summary>Ansible Playbook</summary>
<ConcatenateYamlSnippets
title="Set up package repository and install zrok">
{AnsibleRepoSetup}
{`
- name: Install zrok package
gather_facts: false
hosts: all
become: true
tasks:
- name: Install zrok
ansible.builtin.package:
name: zrok
state: present
`}
</ConcatenateYamlSnippets>
</Details>
## Homebrew
<Homebrew />
## Linux Binary ## Linux Binary
@ -95,103 +133,4 @@ sudo install -o root -g root ./zrok /usr/local/bin/;
zrok version; zrok version;
``` ```
</Details> </Details>
## 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.
:::
<Details>
<summary>Manually set up DEB repository</summary>
```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 <<EOF;
deb [signed-by=/usr/share/keyrings/openziti.gpg] https://packages.openziti.org/zitipax-openziti-deb-stable debian main
EOF
sudo apt update;
sudo apt install zrok;
zrok version;
)
```
</Details>
<Details>
<summary>Manually set up RPM repository</summary>
```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;
)
```
</Details>
<Details>
<summary>Script to set up DEB or RPM repository</summary>
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
```
</Details>
<Details>
<summary>Ansible Playbook</summary>
<ConcatenateYamlSnippets
title="Set up package repository and install zrok">
{AnsibleRepoSetup}
{`
- name: Install zrok package
gather_facts: false
hosts: all
become: true
tasks:
- name: Install zrok
ansible.builtin.package:
name: zrok
state: present
`}
</ConcatenateYamlSnippets>
</Details>

5
website/versioned_docs/version-0.4/guides/install/macos.mdx
View File

@ -6,6 +6,11 @@ sidebar_label: macOS
import { AssetsProvider } from '@site/src/components/assets-context'; import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import styles from '@site/src/css/download-card.module.css'; import styles from '@site/src/css/download-card.module.css';
import Homebrew from '/../../docs/guides/install/_homebrew.mdx';
## Homebrew
<Homebrew />
## Darwin Binary ## Darwin Binary