[wiki] Migrate wiki to main repo for long-term archival

2026-09-06 00:57:14 -04:00 · 2024-08-08 20:50:19 -04:00
parent d96de2b7b8
commit 15e54cb25b
13 changed files with 150 additions and 5 deletions
@@ -0,0 +1,11 @@
+## Installation (Alpine Linux)
+The Alpine Linux package is actively tested on the latest stable release of Alpine Linux.
+***
+1. Download the *.apk file from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+2. Run `doas apk add --allow-untrusted <path/to/*.apk`
+
+3. sshyp is now installed - run `sshyp init` to get started!
+***
+
+Creating a package from an APKBUILD? Just use `abuild -r` in the same directory as the APKBUILD.
@@ -0,0 +1,10 @@
+## Installation (Arch Linux)
+The Arch package is actively tested on up-to-date installations of Arch and Artix Linux.
+***
+The easiest method of installation is via the AUR. Search for "sshyp" using your favorite AUR helper or run:
+```
+git clone https://aur.archlinux.org/sshyp.git
+cd sshyp
+makepkg -si
+```
+sshyp is now installed - run `sshyp init` to get started!
@@ -0,0 +1,12 @@
+## Installation (Debian/Ubuntu)
+The Debian/Ubuntu package is actively tested on Debian 12 (standard) and Ubuntu 22.04 (WSL).
+
+_OpenSSH warning:_ Sync support requires OpenSSH >= 8.7, meaning **Debian 12 (Bookworm)** is the minimum supported version.
+***
+1. Download the *.deb file from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+   ^ do not download the version ending in *_termux.deb by mistake!
+
+2. Run `sudo dpkg -i <path/to/*.deb>; sudo apt install -f`
+
+3. sshyp is now installed - run `sshyp init` to get started!
@@ -0,0 +1,10 @@
+## Installation (Fedora)
+The Fedora package is actively tested on the latest version of Fedora Linux.
+
+This package may be install-able on other Red Hat-based distributions, but it is only tested with the latest version of Fedora.
+***
+1. Download the *.rpm file from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+2. Run `sudo dnf localinstall <path/to/*.rpm>`
+
+3. sshyp is now installed - run `sshyp init` to get started!
@@ -0,0 +1,10 @@
+## Installation (FreeBSD)
+The FreeBSD package is actively tested on the latest version of FreeBSD 14 and should be fully functional on at least FreeBSD 13+.
+***
+1. Download the *.pkg file from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+2. Run `sudo pkg add <path/to/*.pkg>`
+
+   ^ the install may fail if you are missing any dependencies - please install the dependencies reported by the package manager and try again
+
+3. sshyp is now installed - run `sshyp init` to get started!
@@ -0,0 +1,14 @@
+## Installation (Haiku)
+**Missing features:** For security and technical reasons, the Haiku version of sshyp cannot be used as a server (it only functions as a client). Additionally, the Haiku package does not support the extension management system, so extensions still must be installed as separate packages.
+
+Please note that sshyp for Haiku is targeting release R1 Beta 4 (64-bit). Previous releases have significant show-stopping bugs, while stability on the nightly releases cannot be guaranteed.
+***
+1. Download the *.hpkg file from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+2. Open the downloaded file and click "Install sshyp" in the top right of the window
+
+   **or**
+
+   Run `pkgman install <path/to/*.hpkg>`
+
+3. sshyp is now installed - run `sshyp init` to get started!
@@ -0,0 +1,16 @@
+## Installation (Termux)
+**Missing features:** For technical reasons, the Termux version of sshyp cannot be used as a server (it only functions as a client). Additionally, the Termux package does not support the extension management system, so extensions still must be installed as separate packages.
+
+The Termux package is minimally tested. Attempts to maintain compatibility are made and it should be fully functional on the latest versions of Termux+Termux:API (F-Droid versions), but newer features are more likely to be broken than on other platforms.
+***
+1. Install the Termux application from [F-Droid](https://f-droid.org/en/packages/com.termux/)
+
+2. Install the Termux API from [F-Droid](https://f-droid.org/en/packages/com.termux.api/) (for clipboard support)
+
+3. From within Termux, run `curl -L <github/link/to/latest/*_termux.deb> -o sshyp.deb`
+
+   ^ copy the required download link from the [latest tagged release of sshyp](https://github.com/rwinkhart/sshyp/releases)
+
+4. From within Termux, run `dpkg -i sshyp.deb; pkg install -f`
+
+5. sshyp is now installed - run `sshyp init` to get started!