mirror of
https://github.com/rwinkhart/sshyp.git
synced 2026-08-31 22:36:31 -04:00
[wiki] Migrate wiki to main repo for long-term archival
This commit is contained in:
@@ -18,12 +18,10 @@ It is your responsibility to assess the security and stability of sshyp and to e
|
||||
I am not responsible for any data loss or breaches of your information resulting from the use of sshyp.
|
||||
sshyp has not been extensively tested by the public; safety and security are priorities, but they cannot be guaranteed.
|
||||
|
||||
Always check the [known bugs](https://github.com/rwinkhart/sshyp/wiki/Known-Bugs) list before updating or installing sshyp.
|
||||
|
||||
# Installation
|
||||
**Important:** *Shell completions (both Bash and ZSH) may require additional configuration on some distributions - please see [this page](https://github.com/rwinkhart/sshyp/wiki/Completions) of the wiki for support.*
|
||||
**Important:** *Shell completions (both Bash and ZSH) may require additional configuration on some distributions - please see [this page](https://github.com/rwinkhart/sshyp/blob/main/wiki/completions.md) of the wiki for support.*
|
||||
|
||||
Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
|
||||
Please see the [installation guide](https://github.com/rwinkhart/sshyp/blob/main/wiki/install.md) in the sshyp wiki for directions specific to your distribution/OS.
|
||||
|
||||
Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Debian/Ubuntu Linux, Fedora Linux, Termux, and WSL. These can be downloaded from the releases page.
|
||||
|
||||
@@ -61,7 +59,7 @@ All available options can be found with `sshyp help`, or alternatively, in the m
|
||||
|
||||
# Roadmap (successor)
|
||||
|
||||
[MUTN] has been developed as a direct successor to sshyp. It is not yet at release v1.0.0, therefore breaking changes will be made.
|
||||
[MUTN](https://github.com/rwinkhart/MUTN) has been developed as a direct successor to sshyp. It is not yet at release v1.0.0, therefore breaking changes will be made.
|
||||
|
||||
If you're interested in migrating to MUTN early, please see the [migration guide](https://github.com/rwinkhart/libmutton/blob/main/wiki/migration.md).
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
## Known Bugs
|
||||
No bugs are currently documented within sshyp, but this is due to a lack of current testing (bugs most certainly exist).
|
||||
|
||||
Development and testing efforts have been re-focused on [MUTN](https://github.com/rwinkhart/MUTN) and [libmutton](https://github.com/rwinkhart/libmutton).
|
||||
@@ -0,0 +1,13 @@
|
||||
## Clipboard Troubleshooting
|
||||
### Clipboard managers can break sshyp
|
||||
***
|
||||
The intended way for sshyp to interact with the system clipboard is for it to clear it 30 seconds after copying a field. **Unfortunately, this does not work by default on all systems due to the prevalence of clipboard managers.**
|
||||
|
||||
Clipboard managers save a history of what has been copied to the clipboard, which is already a big enough issue on its own for people who copy sensitive information to their clipboard. Some **clipboard managers simply will not allow the clipboard to be empty** and will replace its contents with the last copied item if you attempt to clear it. One such naughty clipboard manager is **KDE Klipper**, which comes **packaged into KDE Plasma** and is typically **enabled by default** on most distributions. Due to this behavior, **KDE Klipper breaks sshyp's clipboard clearing functionality** and should not be left enabled.
|
||||
|
||||
It is likely other popular clipboard managers exhibit this behavior. I noticed it with KDE Klipper, which is what prompted me to create this wiki page. **Clipboard managers should not be enabled by default in any environment** or distribution due to their **potential security implications**.
|
||||
### Termux cannot clear the clipboard from the background
|
||||
|
||||
***
|
||||
|
||||
If using the Termux (Android) version of sshyp, the clipboard may not successfully be cleared after the 30 second timeout period if Termux is not actively in the foreground when the sleep timer expires. This is an unfortunate side-effect of running on Android and cannot be easily fixed. Due to Termux being at the bottom of the platform support priority list, I will not be investing time into working around this.
|
||||
@@ -0,0 +1,26 @@
|
||||
## Shell Completions Troubleshooting
|
||||
ZSH completions not working? Make sure your ~/.zshrc contains the following:
|
||||
```
|
||||
autoload -Uz compinit && compinit
|
||||
```
|
||||
...and then restart your shell.
|
||||
***
|
||||
Bash completions not working? Install your distribution's 'bash-completion' package or source the completion script manually.
|
||||
|
||||
For most environments, this would mean adding the following to your ~/.bashrc:
|
||||
```
|
||||
source /usr/share/bash-completion/completions/sshyp
|
||||
```
|
||||
Note that this directory is different on FreeBSD and Haiku.
|
||||
|
||||
FreeBSD:
|
||||
```
|
||||
source /usr/local/share/bash-completion/completions/sshyp
|
||||
```
|
||||
Haiku:
|
||||
```
|
||||
source /system/data/bash-completion/completions/sshyp
|
||||
```
|
||||
...and then restart your shell.
|
||||
|
||||
*Please note that Bash completions are slightly more limited than ZSH completions, and as such, new entries will not be auto-completed until the completions script is re-sourced.*
|
||||
@@ -0,0 +1,15 @@
|
||||
**Note:** [Shell completions may require additional configuration to work](https://github.com/rwinkhart/sshyp/blob/main/wiki/completions.md).
|
||||
|
||||
[Haiku](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/haiku.md)
|
||||
|
||||
[FreeBSD](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/freebsd.md)
|
||||
|
||||
[Alpine Linux](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/alpine.md)
|
||||
|
||||
[Arch Linux](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/arch.md)
|
||||
|
||||
[Debian/Ubuntu Linux (or WSL)](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/debian.md)
|
||||
|
||||
[Fedora Linux](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/fedora.md)
|
||||
|
||||
[Termux (Android)](https://github.com/rwinkhart/sshyp/blob/main/wiki/installationGuides/termux.md)
|
||||
@@ -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!
|
||||
@@ -0,0 +1,6 @@
|
||||
## Usage
|
||||
**Note:** [Shell completions may require additional configuration to work](https://github.com/rwinkhart/sshyp/blob/main/wiki/completions.md).
|
||||
|
||||
Read the man page with `man sshyp`, or [preview it on GitHub](https://github.com/rwinkhart/sshyp/blob/main/extra/manpage).
|
||||
|
||||
Please note that the version of the man page on GitHub may not be accurate to the version of sshyp you have installed, as the git version is kept up to date with the source, rather than the latest tagged release.
|
||||
Reference in New Issue
Block a user