Update documentation

This commit is contained in:
2022-05-19 22:46:35 -04:00
parent 309a471e77
commit e21faa8bbb
3 changed files with 26 additions and 34 deletions
+10 -23
View File
@@ -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.*