steven/hyp
1
1
Fork 0
Code Issues 6 Pull Requests Packages Projects 1 Releases 1 Wiki Activity

Better usage in hyp and hypd readme's
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Steven Polley
2024-04-20 18:31:14 -06:00
parent 2af574fd18
commit 6b1bfb3a01
3 changed files with 49 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
hypd/README.md
View File

@ -1,9 +1,19 @@
# hypd | Hide Your Ports Daemon
hypd is the pork knocking daemon which listens for incoming authentic knock sequences.
hypd is the pork knocking daemon which listens for incoming authentic knock sequences. When it sees an authentic knock sequence, it then performs an action.
### Usage
You can use -h to get help for hypd and all its commands. When figuring out how to do something, -h is your friend.
```bash
# Get general hypd help
./hypd -h
# Get help specific to the hypd generate command
./hypd generate -h
```
Running hypd requires generating secrets which are then shared with hyp clients. hypd is used to generate these secrets, and it's recommended you create a directory just for hyp secrets.
```bash
@ -30,4 +40,6 @@ Once you have set your config file, you can finally run hypd.
```bash
# As root or sudo, specify the configuration file
sudo ./hypd server hypd.conf
```
```
If you encounter any errors while trying to run, address those. If not, then you're now listening for incoming authentic knock sequences. Make sure you distribute the secret to the client.