Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update command description #18

Merged
merged 1 commit into from
Oct 12, 2024
Merged

doc: update command description #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,16 @@ $ netguard-server -c ./netguard.toml

### Run knock tool

On client site, Using `netguard-tool` to send knock packets:
On client site, Using `netguard-tool` to send TCP port knock packets.

The following command sends a knock packet to unlock TCP port 10022:

```shell
$ sudo ./netguard-tool auth --server 45.76.195.141 --protocol=tcp --unlock 10022 --key=./rsa_key
```

If want to unlock a UDP port, use `--protocol=udp`。

### Example

Two devices, one listening on port 10022 and then taken over by `netguard-server`:
Expand Down
Loading