Skip to content
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.

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

offer Linux package repo setup script #788

Merged
merged 3 commits into from
Jan 10, 2024
Merged
Changes from all commits
Commits
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
205 changes: 65 additions & 140 deletions docusaurus/docs/downloads.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Downloads
hide_table_of_contents: true
description: Download a Ziti Tunneller or the Ziti Command
description: Install a Ziti Tunneler or the Ziti Command
---

import OsTabs from '@theme/OsTabs';
Expand All @@ -28,11 +28,13 @@ import Details from '@theme/MDXComponents/Details';

<br/>

### Tunneller
### Ziti Desktop Edge

This app provides the Ziti tunneler background service (`ziti-edge-tunnel`) and a control panel GUI.

[Download Ziti Desktop Edge for Windows from GitHub](https://github.com/openziti/desktop-edge-win/releases/latest)

[Read about tunnelling in Windows](/reference/tunnelers/02-windows.md)
[Read about tunneling in Windows](/reference/tunnelers/02-windows.md)

<br/><br/>

Expand All @@ -46,11 +48,15 @@ import Details from '@theme/MDXComponents/Details';

<br/>

### Tunneller
### Ziti Desktop Edge

This app provides the Ziti tunneler background service (`ziti-edge-tunnel`) and a control panel GUI.

<br/>

[![Ziti Desktop Edge on the Mac App Store](/img/Mac_App_Store_Badge.svg)](https://apps.apple.com/app/id1460484572)

[Read about tunnelling in macOS](/reference/tunnelers/04-macos.md)
[Read about tunneling in macOS](/reference/tunnelers/04-macos.md)


<br/><br/>
Expand All @@ -62,182 +68,93 @@ import Details from '@theme/MDXComponents/Details';
</TabItem>

<!-- begin super-tab Linux -->
<TabItem value="Linux">
<TabItem value="Linux">

### Choose a Linux Package Manager or Manual Install
Install the `ziti` command or the `ziti-edge-tunnel` tunneler daemon as a package or a binary.

<br/>

<!-- begin Linux sub-tabs -->
<Tabs
defaultValue="LinuxDeb"
values={[
{ label: 'DEB for Debian family', value: 'LinuxDeb', },
{ label: 'RPM for Red Hat family', value: 'LinuxRpm', },
{ label: 'Manual Install', value: 'LinuxOther', },
{ label: 'Download Binary', value: 'LinuxOther', },
]}
>

<!-- begin sub-tab rpm -->
<TabItem value="LinuxRpm">

<br/>

#### Tunneller

[Install the `ziti-edge-tunnel` RPM](/reference/tunnelers/linux/index.md#installing-the-rpm)

<br/><br/>
<!-- begin sub-tab deb -->
<TabItem value="LinuxDeb">

#### Ziti Command
### Install the `ziti` Command from the `openziti` Package

```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 openziti;
ziti version;
)
```
Audit the script to ensure it is suitable to execute on your system as root.

<Details>
<summary>Pre-release repo for RedHat family distros</summary>
<br/>

```text
(set -euo pipefail;

sudo tee /etc/yum.repos.d/openziti-testing.repo >/dev/null <<\EOF;
[OpenZitiTesting]
name=OpenZiti Testing
baseurl=https://packages.openziti.org/zitipax-openziti-rpm-test/redhat/$basearch
enabled=1
gpgcheck=0
gpgkey=https://packages.openziti.org/zitipax-openziti-rpm-test/redhat/$basearch/repodata/repomd.xml.key
repo_gpgcheck=1
EOF

sudo dnf update;
sudo dnf install openziti;
ziti version;
)
curl -sS https://get.openziti.io/install.bash \
| sudo bash -s openziti
```

</Details>

<!-- end sub-tab rpm -->
</TabItem>
<br/>

<!-- begin sub-tab deb -->
<TabItem value="LinuxDeb">
### Install the `ziti-edge-tunnel` Daemon

<br/>

#### Tunneller

[Install the `ziti-edge-tunnel` DEB](/reference/tunnelers/linux/index.md#installing-the-deb)
Follow the Debian instructions [to install the `ziti-edge-tunnel` DEB](/reference/tunnelers/linux/index.md#installing-the-deb)

<br/><br/>
<br/>

#### Ziti Command
<!-- end sub-tab deb -->

```text
(set -euo pipefail;
</TabItem>

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;
<!-- begin sub-tab rpm -->
<TabItem value="LinuxRpm">

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
### Install the `ziti` Command from the `openziti` Package

sudo apt update;
sudo apt install openziti;
ziti version;
)
```
Audit the script to ensure it is suitable to execute on your system as root.

<Details>
<summary>Pre-release repo for Debian family distros</summary>
<br/>

```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-testing.list >/dev/null <<EOF;
deb [signed-by=/usr/share/keyrings/openziti.gpg] https://packages.openziti.org/zitipax-openziti-deb-test debian main
EOF

sudo apt update;
sudo apt install openziti;
ziti version;
)
curl -sS https://get.openziti.io/install.bash \
| sudo bash -s openziti
```

</Details>
<br/>

<!-- end sub-tab deb -->
### Install the `ziti-edge-tunnel` Daemon

</TabItem>
<br/>

<TabItem value="LinuxOther">
Follow the Red Hat instructions to [install the `ziti-edge-tunnel` RPM](/reference/tunnelers/linux/index.md#installing-the-rpm)

<br/>

#### Tunneller
<!-- end sub-tab rpm -->
</TabItem>

[Manually install `ziti-edge-tunnel`](/reference/tunnelers/linux/index.md#manual-installation)
<TabItem value="LinuxOther">

<br/><br/>
### Download the `ziti` Command

#### Ziti Command
[Download the Linux executable from GitHub](https://github.com/openziti/ziti/releases/latest)

[Download the Linux executable from GitHub](https://github.com/openziti/ziti/releases/latest) or install `jq` and `curl` and run this script.
<br/>

<Details>
<summary>Install script for Linux</summary>
### Download the `ziti-edge-tunnel` Daemon

```text
(set -euo pipefail;

cd $(mktemp -d);

ZITI_VERSION=$(
curl -sSf https://api.github.com/repos/openziti/ziti/releases/latest \
| jq -r '.tag_name'
);

case $(uname -m) in
x86_64) GOXARCH=amd64 ;;
aarch64|arm64) GOXARCH=arm64 ;;
armv7|armhf|arm) GOXARCH=arm ;;
*) echo "ERROR: unknown arch '$(uname -m)'" >&2
exit 1 ;;
esac;

curl -sSfL \
"https://github.com/openziti/ziti/releases/download/${ZITI_VERSION}/ziti-linux-${GOXARCH}-${ZITI_VERSION#v}.tar.gz" \
| tar -xz -f -;

sudo install -o root -g root ./ziti /usr/local/bin/;
ziti version;
)
```
Download [the latest binary from GitHub](https://github.com/openziti/ziti-tunnel-sdk-c/releases/latest/) and follow the [manual binary install instructions](/reference/tunnelers/linux/index.md#manual-installation)

</Details>
<br/>

<!-- end LinuxOther sub-tab -->

</TabItem>

<!-- end Linux sub-tabs -->
Expand All @@ -251,9 +168,9 @@ ziti version;

<br/>

### Tunneller
### Tunneler Daemon

[Run a tunneller with Docker](/reference/tunnelers/linux/container/readme.mdx)
[Run a tunneler with Docker](/reference/tunnelers/linux/container/readme.mdx)

<br/><br/>

Expand All @@ -268,7 +185,7 @@ docker pull openziti/ziti-cli \

<TabItem value="Kubernetes">

[Learn about tunnelling workloads in Kubernetes](/guides/kubernetes/workload-tunneling/index.md)
[Learn about tunneling workloads in Kubernetes](/guides/kubernetes/workload-tunneling/index.md)

[Learn about self-hosting Ziti in Kubernetes](/docs/category/hosting-openziti)

Expand All @@ -278,23 +195,31 @@ docker pull openziti/ziti-cli \

<br/>

### Tunneller
### Ziti Mobile Edge

This app provides a VPN that makes your authorized Ziti Services available on mobile.

<br/>

[![Ziti Mobile Edge on the App Store](/img/App_Store_Badge.svg)](https://apps.apple.com/app/id1460484353)

[Read about tunnelling in iOS](/reference/tunnelers/05-_iOS.md)
[Read about tunneling in iOS](/reference/tunnelers/05-_iOS.md)

</TabItem>

<TabItem value="Android">

<br/>

### Tunneller
### Ziti Mobile Edge

This app provides a VPN that makes your authorized Ziti Services available on mobile.

<br/>

[![Ziti Mobile Edge on the Google Play Store](/img/google-play-badge.svg)](https://play.google.com/store/apps/details?id=org.openziti.mobile)

[Read about tunnelling in Android](/reference/tunnelers/03-android.md)
[Read about tunneling in Android](/reference/tunnelers/03-android.md)

</TabItem>

Expand Down