mirror of
https://github.com/rwinkhart/sshyp.git
synced 2026-08-28 04:46:34 -04:00
Update README.md
Former-commit-id: 38d003983687f031ef2dc50122db52429d0cd340 [formerly 71662a53f1]
Former-commit-id: cb658bef3fdf54ed6dfb546468368113a4660518
This commit is contained in:
@@ -1,13 +1,14 @@
|
||||

|
||||
|
||||
A very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux). Alternative to (and compatible with) pass/password-store.
|
||||
sshyp is a very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux).
|
||||
|
||||
Compatible with entries created by pass/password-store.
|
||||
sshyp is compatible with entries created by pass/password-store, as its original goal was to be like pass/password-store, but far more user-friendly to synchronize with a self-hosted server.
|
||||
|
||||
The only password-store compatible CLI password manager available for Haiku.
|
||||
sshyp is (as of writing) the only password-store compatible CLI password manager available for Haiku.
|
||||
|
||||
"sshyp" stands for "sshync passwords", or "ssh sync passwords".
|
||||
"sshync" is the custom syncing backend (based on sftp) used by "sshyp".
|
||||
sshyp makes use of a custom sftp wrapper, called sshync (ssh+sync), to reliably sync user entries with a local or remote server.
|
||||
|
||||
The name "sshyp" is a combination of its syncing library, "sshync", and "passwords".
|
||||
|
||||
# WARNING
|
||||
It is your responsibility to assess the security and stability of "sshyp" before using it and ensure it meets your needs.
|
||||
@@ -27,7 +28,7 @@ What sshyp can do:
|
||||
|
||||
What sshyp will likely do:
|
||||
|
||||
- (planned v1.1.0) 2FA/MFA management (was previously not on the roadmap, but could be beneficial in reducing phone usage)
|
||||
- (planned v1.1.0) 2FA/MFA management (beneficial for reducing phone usage)
|
||||
- (planned v1.2.0) everything it already does, but also in a GUI for Linux/Haiku
|
||||
|
||||
What sshyp definitely won't do:
|
||||
@@ -35,19 +36,11 @@ What sshyp definitely won't do:
|
||||
- Non-UNIX(-like) support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them)
|
||||
|
||||
# Installation
|
||||
Arch Linux (all ISAs)
|
||||
Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
|
||||
|
||||
sshyp releases are available in the Arch User Repository as 'sshyp'.
|
||||
Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
|
||||
|
||||
Install with your preferred AUR helper or use:
|
||||
|
||||
```
|
||||
git clone https://aur.archlinux.org/sshyp.git
|
||||
cd sshyp
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
|
||||
Requests for additional distribution/OS support can be filed as issues.
|
||||
|
||||
# Building
|
||||
Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
|
||||
@@ -60,13 +53,13 @@ cd sshyp
|
||||
./package.sh
|
||||
```
|
||||
|
||||
The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
|
||||
The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian/Ubuntu and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
|
||||
|
||||
Haiku packaging must be done from within Haiku.
|
||||
Haiku and Fedora packaging must be done on their own respective distributions.
|
||||
|
||||
The AUR version and the packages attatched to the release tags were already packaged using this script.
|
||||
|
||||
Currently, the script can create packages for Haiku, FreeBSD, Arch Linux (PKGBUILD), Debian Linux, Fedora Linux, Termux, and generic. Packaging for other systems coming soon.
|
||||
Currently, the script can create packages for Haiku, FreeBSD, Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
|
||||
|
||||
# Usage
|
||||
Upon initial installation (on both the server and client devices), be sure to run:
|
||||
@@ -75,8 +68,7 @@ Upon initial installation (on both the server and client devices), be sure to ru
|
||||
sshyp tweak
|
||||
```
|
||||
|
||||
This command will allow you to configure the settings necessary for sshyp to function.
|
||||
To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
|
||||
This command will allow you to configure the settings necessary for sshyp to function. To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
|
||||
|
||||
Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the gpg key to decrypt entries.
|
||||
|
||||
@@ -96,7 +88,7 @@ man sshyp
|
||||
Short-term Goals:
|
||||
|
||||
- 2FA/MFA management
|
||||
- create minimal GUI apps (Linux x86_64, Linux aarch64)
|
||||
- create minimal GUI apps (Linux x86_64, Linux aarch64, Haiku x86_64)
|
||||
- various optimizations/bug fixes
|
||||
|
||||
Long-term Goals:
|
||||
|
||||
Reference in New Issue
Block a user