GitHubMirror/sshyp
1
0
Fork 0
mirror of https://github.com/rwinkhart/sshyp.git synced 2026-08-29 21:36:31 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
RandyTheSilly
2022-01-12 00:56:33 -05:00
parent 9f229e7ae7
commit 67a7c2e382
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -1
View File
@@ -44,8 +44,23 @@ makepkg -si
Packaging for other distributions coming soon.
# Building
Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
A packaging script is included in the root directory of the repo in order to package sshyp for your distribution (currently only a generic package used for the AUR PKGBUILD is supported). To package sshyp from source, simply run:
```
git clone https://github.com/rwinkhart/sshyp.git
cd sshyp
./package.sh
```
The AUR version and the packages attatched to the release tags were already packaged using this script.
Packaging for other distributions coming soon.
# Usage
Upon initial installation, be sure to run:
Upon initial installation (on both the server and client devices), be sure to run:
```
sshyp tweak
@@ -54,6 +69,8 @@ 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.
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:
```