diff --git a/README.md b/README.md index 8afaa7c..2b89e65 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Debian/Ubuntu Linux, Additionally, sshyp is distributed on the AUR. -Support for additional environments, such as MacOS and OpenBSD, is coming soon. +Extensions can be installed from the `sshyp tweak` menu on most supported platforms. -Extensions are available in the [sshyp-labs](https://github.com/rwinkhart/sshyp-labs) repository. +For Haiku and Termux, extensions must instead be installed through the [system package manager](https://github.com/rwinkhart/sshyp-labs/releases). # Building A packaging script is included in the root directory of the repo in order to package sshyp for your distribution. To package sshyp from source, simply run: @@ -66,36 +66,20 @@ The AUR version and the packages attached to the release tags were already packa Currently, the script can create packages for Haiku, FreeBSD, Alpine Linux (APKBUILD), Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and WSL. # Usage -Upon initial installation (on both the server and client devices), be sure to run: +Upon initial installation (on both the server and client devices), run `sshyp init` to configure the settings necessary for sshyp to function. -``` -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. +In order to configure optional settings or change already configured settings, run `sshyp tweak`. 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. -All available options can be found with: - -``` -sshyp help -``` - -Or alternatively, in the man page: - -``` -man sshyp -``` +All available options can be found with `sshyp help`, or alternatively, in the man page. # Roadmap Short-term Goals: -- MacOS support -- improved temporary directory security -- a minimal GUI app - being made as an [extension](https://github.com/rwinkhart/sshyp-labs) +- migrate from gpg to a better-suited utility focused on symmetric cipher encryption Long-term Goals: -- a fun surprise +- improve OS compatibility - seize the thrones, shear the humans diff --git a/extra/changelog-archive/2023 b/extra/changelog-archive/2023 index 8e57c0c..c8282e0 100644 --- a/extra/changelog-archive/2023 +++ b/extra/changelog-archive/2023 @@ -1,5 +1,5 @@ sshyp v1.5.0 -07/08/2023 +07/12/2023 the fortified flock update @@ -9,12 +9,14 @@ compatibility-breaking changes: - a completely new configuration system calls for a new configuration file ^ before using sshyp v1.5.0 for the first time, 'sshyp init' will need to be ran to create the - new configuration file + new configuration file - the old configuration files can be safely deleted ^ 'sshyp tweak' has been repurposed as the configuration menu for changing individual options, rather than re-doing setup entirely - after initialization, this is the one you want to use - the new extension manager is replacing the old method of installing extensions as system packages ^ any older extensions you have installed should be uninstalled to prevent conflicts ^ extensions are now installed and removed through the 'sshyp tweak' menu's extension manager + ^ this does not yet apply to Haiku and Termux, which will continue to install extensions using + the previous method - all clients and servers must be updated to this release for the folder renaming bug fix to work ^ failure to update all devices will result in errors and/or potential data loss - various packaging changes diff --git a/extra/manpage b/extra/manpage index 2bb45d8..39bc1ce 100644 --- a/extra/manpage +++ b/extra/manpage @@ -1,4 +1,4 @@ -.TH sshyp 1 "08 July 2023" "v1.5.0" "sshyp man page" +.TH sshyp 1 "12 July 2023" "v1.5.0" "sshyp man page" .SH NAME \fBsshyp\fR - Simple, self-hosted, synchronized password management for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store. .SH SYNOPSIS