From e21faa8bbbf2152ab27ec486b16d457da3cba15c Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Thu, 19 May 2022 22:46:35 -0400 Subject: [PATCH] Update documentation --- README.md | 33 ++++++++++----------------------- extra/manpage | 4 ++-- share/doc/sshyp/changelog | 23 ++++++++++++++--------- 3 files changed, 26 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 405df2c..f9693a1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ -LEGEND: - -*=feature implemented in git/source, not yet available as an officially packaged release (will be available soon!) -**=feature will be implemented before next tagged/officially packaged release # sshyp -A very simple self-hosted, synchronized password manager. Alternative to GNU pass. +A very simple self-hosted, synchronized password manager for UNIX systems (currently Haiku/Linux). Alternative to (and compatible with) pass/password-store. -Compatible with entries created by pass/password-store.* +Compatible with entries created by pass/password-store. -The only password-store compatible CLI password manager available for Haiku.* +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". @@ -25,13 +21,13 @@ What sshyp can do: - securely manage a collection of encrypted passwords and notes via CLI - generate new, secure passwords to the user's choice in length and complexity - securely sync said passwords and notes seamlessly between devices -- everything above with entries created by pass/password-store!* -- everything above on Haiku*, Linux, and Termux (an Android terminal emulator)! +- everything above with entries created by pass/password-store! +- everything above on Haiku, Linux, and Termux (an Android terminal emulator)! What sshyp will likely do: -- (planned v1.2) everything it already does, but also in a GUI for Linux/Haiku - (planned v1.1) 2FA/MFA management (was previously not on the roadmap, but could be beneficial in reducing phone usage) +- (planned v1.2) everything it already does, but also in a GUI for Linux/Haiku What sshyp definitely won't do: @@ -50,7 +46,7 @@ cd sshyp makepkg -si ``` -Pre-built packages exist for Haiku**, Arch Linux, Debian Linux, and Termux. These can be downloaded from the releases page. +Pre-built packages exist for Haiku, Arch Linux, Debian Linux, and Termux. These can be downloaded from the releases page. # Building Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation. @@ -67,7 +63,7 @@ The packaging script has been tested on Arch Linux with dpkg as a dependency for 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**, Arch Linux (PKGBUILD), Debian Linux, Termux, and generic. Packaging for other systems coming soon. +Currently, the script can create packages for Haiku*, Arch Linux (PKGBUILD), Debian Linux, Termux, and generic. Packaging for other systems coming soon. # Usage Upon initial installation (on both the server and client devices), be sure to run: @@ -77,7 +73,7 @@ sshyp tweak ``` This command will allow you to configure the settings necessary for sshyp to function. -As of right now, sshyp is rapidly changing, and as such, it is a good idea to run "sshyp tweak" after each update. +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,19 +92,10 @@ man sshyp # Roadmap Short-term Goals: -- create new file list w/color and w/o file extensions* -- overhaul argument system* -- fix lots of bugs! -- make lots of optimizations! - -Medium-term Goals: - - 2FA/MFA management - create minimal GUI apps (Linux x86_64, Linux aarch64) +- various optimizations/bug fixes Long-term Goals: - seize the thrones, shear the humans - -# Known Issues -Currently, the entry list displays each entry with the file extension ".gpg" visible (which you do not type when reading, modifying, or creating an entry). This will be corrected when the new entry list is added.* diff --git a/extra/manpage b/extra/manpage index d7c00b3..9a9ed2c 100644 --- a/extra/manpage +++ b/extra/manpage @@ -1,6 +1,6 @@ -.TH sshyp 1 "19 April 2022" "v1.0" "sshyp man page" +.TH sshyp 1 "19 May 2022" "v1.0" "sshyp man page" .SH NAME -sshyp \- A very simple self-hosted, synchronized password manager. Alternative to GNU pass. +sshyp \- A very simple self-hosted, synchronized password manager for UNIX systems. Alternative to (and compatible with) pass/password-store. .SH SYNOPSIS sshyp [OPTION] [[FLAG]] [/] .SH DESCRIPTION diff --git a/share/doc/sshyp/changelog b/share/doc/sshyp/changelog index 03f316a..bdf8af9 100644 --- a/share/doc/sshyp/changelog +++ b/share/doc/sshyp/changelog @@ -2,14 +2,16 @@ sshyp v1.0 The Polished Trotters Update -This release focuses on overhauling the visual experience and speeding up user interactions with "sshyp". -This release is being crowned "v1.0", as it is considered to be feature-complete. -Future releases will focus on optimizations, bug fixes, and compatibility. +This release brings 'sshyp' in line with the original goals of the project. +As such, it is being crowned "v1.0", and is considered a stable base for future expansions. Features: +- sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS +- the entry format has been changed to support entries created in pass/password-store + ^ this change requires existing entry libraries to be converted - see the sshyp v1.0 release page on GitHub for a conversion script - majorly overhauled visual experience for sshyp - ^ this includes a new entry list and **thematic text art + ^ this includes a new entry list, a new entry readout, coloured output, and more! - entries can now optionally be passed as arguments, directly ^ as opposed to the user being prompted for an entry name after running a command @@ -18,11 +20,15 @@ Changes: - corrected outdated liscensing and copyright information - 'if __name__=="__main__":' convention is now used - help screens have been overhauled -** improved password generator to guarantee more secure results +- improved password generator to guarantee more secure results - fixed errors when trying to sync with a multi-word entry on the server -- (openssh >= 9.0) sshync now uses 'scp' (via the sftp protocal), rather than 'sftp' - ^ may cause compatibility issues on non-rolling distros that do not yet have openssh >= 9.0 in the official repos - ^ in these cases, use sshyp fr4.7 until openssh >= 9.0 is available to you +- sshync now uses 'scp' (via the sftp protocal), rather than 'sftp' +- rename function now properly allows for renaming folders +- renaming an entry/folder will now properly delete the old entry/folder from the server +- entry previews at the time of entry creation/editing no longer require entering the gpg password more times than necessary +- the clipboard now automatically clears after 30 seconds +- sshyp server no longer needs to create copies of its libraries in ~/ +- ...and lots of minor (under the hood) changes! <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> @@ -34,4 +40,3 @@ Legend: ** = feature/change not yet finished/implemented - = feature/change implemented and pushed upstream ^ = note regarding the above feature/change -&& = visual separater for patch notes for different planned major version releases