Skip to content

Commit

Permalink
Update man and README according natdiscovery changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Mészáros Mihály committed Sep 29, 2017
1 parent 4b22e6f commit fee5442
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 4 deletions.
15 changes: 13 additions & 2 deletions README.turnutils
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ $ ./scripts/secure_relay.sh

5. turnutils_natdiscovery: a utility that provides NAT behavior discovery
according RFC5780. This utility discovers the actual NAT Mapping and Filtering
behavior. Be aweare that at least two different listening IP addresses should
be configured to be able to work properly!
behavior, etc. Be aware that on TURN server side two different listening IP
addresses should be configured to be able to work properly!

6. turnutils_oauth: a utility that provides OAuth access_token
generation(AEAD encryption), validation and decryption. This utility inputs
Expand Down Expand Up @@ -272,19 +272,30 @@ Flags:

-f NAT filtering behavior discovery

-t NAT mapping lifetime behavior discovery
Requires a timer (-T)

-c NAT collision behavior discovery

-H NAT hairpinning behavior discovery

-P Add 1500 byte Padding to the behavior discovery
Applicable with all except NAT mapping Lifetime discovery

Options with required values:

-p STUN server port (Default: 3478)

-L Local address to use (optional)

-l Local port to use (use with -L)

-A Secondary Local address (optional)
Required for collision discovery

-T Mapping lifetime timer (sec)
Used by mapping lifetime behavior discovery

Usage:

$ turnutils_natdiscovery -m -f stun.example.com
Expand Down
24 changes: 22 additions & 2 deletions man/man1/turnutils.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ $ ./scripts/secure_relay.sh
5.
\fIturnutils_natdiscovery\fP: a utility that provides NAT behavior discovery
according RFC5780. This utility discovers the actual NAT Mapping and Filtering
behavior. Be aweare that at least two different listening IP addresses should
be configured to be able to work properly!
behavior, etc. Be aware that on TURN server side two different listening IP
addresses should be configured to be able to work properly!
.TP
.B
6.
Expand Down Expand Up @@ -418,12 +418,22 @@ NAT mapping behavior discovery
NAT filtering behavior discovery
.TP
.B
\fB\-t\fP
NAT mapping lifetime behavior discovery
Requires a timer (\fB\-T\fP)
.TP
.B
\fB\-c\fP
NAT collision behavior discovery
.TP
.B
\fB\-H\fP
NAT hairpinning behavior discovery
.TP
.B
\fB\-P\fP
Add 1500 byte Padding to the behavior discovery
Applicable with all except NAT mapping Lifetime discovery
.PP
Options with required values:
.TP
Expand All @@ -436,9 +446,18 @@ STUN server port (Default: 3478)
Local address to use (optional)
.TP
.B
\fB\-l\fP
Local port to use (use with \fB\-L\fP)
.TP
.B
\fB\-A\fP
Secondary Local address (optional)
Required for collision discovery
.TP
.B
\fB\-T\fP
Mapping lifetime timer (sec)
Used by mapping lifetime behavior discovery
.PP
Usage:
.PP
Expand Down Expand Up @@ -650,5 +669,6 @@ Mutsutoshi Yoshimoto <[email protected]>
Federico Pinna <[email protected]>
.PP
Bradley T. Hughes <[email protected]>
.RE
.PP
Mihaly Meszaros <[email protected]>

0 comments on commit fee5442

Please sign in to comment.