Updated documentation for release v1.1.1

Former-commit-id: defed7054804d7bf36e93c302282039d335d6561 [formerly 558512ba52]
Former-commit-id: f6cf7d3e5633652439a46c51f9d5cfad007f2236
This commit is contained in:
2022-07-21 22:40:29 -04:00
parent 3e9a4c0403
commit 39316d04a2
3 changed files with 41 additions and 23 deletions
+27
View File
@@ -1,3 +1,30 @@
sshyp v1.1.1
the sheecrets update - patch one
this is a polish/bug fix release that makes tweaks to the entry format (without breaking compatibility)
compatibility-breaking changes:
- none; the entry format tweaks are backward compatible with sshyp v1.0.0+
^ the new format is slightly more efficient in terms of storage space
^ if you would like to upgrade to it, run this script (after updating to v1.1.1):
https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/conversion-scripts/sshyp-refresh-1.1.1%2B.py
user-facing features:
- entries (when editing or adding) are now run through the new optimized_edit() function to strip trailing new lines
and ensure the format of the entries is fully compatible with all of sshyp's functions
fixes:
- when adding a note to an entry, there is no longer a chance the first note line will be added as a url
if the entry is using an older format/pass format
- the gpg auto-generation file temporarily created by sshyp no longer includes extra spaces
^ seems to serve no functional purpose - fixed for the sake of polish
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
sshyp v1.1.0 sshyp v1.1.0
the sheecrets update the sheecrets update
+1 -1
View File
@@ -1,4 +1,4 @@
.TH sshyp 1 "14 July 2022" "v1.1.0" "sshyp man page" .TH sshyp 1 "21 July 2022" "v1.1.1" "sshyp man page"
.SH NAME .SH NAME
sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store. sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
.SH SYNOPSIS .SH SYNOPSIS
+13 -22
View File
@@ -1,36 +1,27 @@
sshyp v1.1.0 sshyp v1.1.1
the sheecrets update the sheecrets update - patch one
the main focus of this release was adding extension support (particularly for sshyp-mfa) this is a polish/bug fix release that makes tweaks to the entry format (without breaking compatibility)
and cleaning up the configuration experience
compatibility-breaking changes: compatibility-breaking changes:
- the entry directory has been moved from ~/.password-pasture to ~/.local/share/sshyp - none; the entry format tweaks are backward compatible with sshyp v1.0.0+
as a means of complying with the XDG base directory spec ^ the new format is slightly more efficient in terms of storage space
^ this requires the user to move their entry directory to the new location manually ^ if you would like to upgrade to it, run this script (after updating to v1.1.1):
^ if this is not done, sshyp will not be able to find entries made prior to v1.1.0 https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/conversion-scripts/sshyp-refresh-1.1.1%2B.py
- due to a new configuration option (preferred text editor), 'sshyp tweak' must be run after updating
user-facing features: user-facing features:
- extension support - entries (when editing or adding) are now run through the new optimized_edit() function to strip trailing new lines
^ some of sshyp's critical functions can now be imported into other programs to extend and ensure the format of the entries is fully compatible with all of sshyp's functions
upon sshyp's functionality
^ the first usecase of this is sshyp-mfa, which can be found at https://github.com/rwinkhart/sshyp-labs
- a new configuration experience
^ the 'sshyp tweak' menu has been made much more readable, and now the automatically generated
gpg key has its id automatically input, making the process easier for the user
- customizable text editor
^ the text editor used for editing notes can now be set to any editor preferred by the user
^ this means that nano was dropped as a dependency
fixes: fixes:
- to avoid exceptions on server devices, all arguments (apart from 'tweak') have been disabled on servers - when adding a note to an entry, there is no longer a chance the first note line will be added as a url
- fixed entry readout not printing blank lines between fields under certain conditions if the entry is using an older format/pass format
- various optimizations - the gpg auto-generation file temporarily created by sshyp no longer includes extra spaces
^ seems to serve no functional purpose - fixed for the sake of polish
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>