diff options
| -rw-r--r-- | src/man/anyrtpproxy.8.txt | 59 | ||||
| -rw-r--r-- | src/man/anytun.8.txt | 2 |
2 files changed, 47 insertions, 14 deletions
diff --git a/src/man/anyrtpproxy.8.txt b/src/man/anyrtpproxy.8.txt index d2ba285..a867631 100644 --- a/src/man/anyrtpproxy.8.txt +++ b/src/man/anyrtpproxy.8.txt @@ -27,7 +27,11 @@ SYNOPSIS DESCRIPTION ----------- -*anyrtpproxy* is a rtpproxy which can be used in combination with anycast +*anyrtpproxy* is a rtpproxy which can be used in combination with anycast. It uses +the same control protocol than rtpproxy though it can be controled through the nathelper +plugin of openser. *anyrtpproxy* uses the same synchronisation protocol than *anytun* +to sync the session information among all anycast instances. + OPTIONS ------- @@ -61,41 +65,45 @@ write pid to this file -i|--interface <ip address> ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO +The local interface to listen on for RTP packets -s|--control <hostname|ip>[:<port>] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO +The local address and port to listen on for control messages from openser -p|--port-range <start> <end> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO +A pool of ports which should be used by *anyrtpproxy* to relay RTP packets. +The range may not overlap between the anycast instances -n|--nat ~~~~~~~~ -TODO +Allow to learn the remote address and port in order to handle clients behind nat. +This option should only be enabled if the source is authenticated (i.e. through +*anytun*) -o|--no-nat-once ~~~~~~~~~~~~~~~~ -TODO +Disable learning of remote address and port in case the first packet does not +come from the client which is specified by openser during configuration. Invoking +this parameter increases the security level of the system but in case of nat needs +a working nat transversal such as stun. -S|--sync-port <port> ~~~~~~~~~~~~~~~~~~~~~ local unicast(sync) port to bind to -This port is used -by anycast hosts to synchronize information about tunnel +This port is used by anycast hosts to synchronize information about tunnel endpoints. No payload data is transmitted via this port. -It is possible to obtain a list of active connections -by telnetting into this port. This port is read-only -and unprotected by default. It is advised to protect -this port using firewall rules and, eventually, IPsec. +It is possible to obtain a list of active connections by telnetting into +this port. This port is read-only and unprotected by default. It is advised +to protect this port using firewall rules and, eventually, IPsec. -M|--sync-hosts <hostname|ip>:<port>,[<hostname|ip>:<port>[...]] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -108,7 +116,32 @@ other anycast hosts that comprise the anycast tunnel endpoint. EXAMPLES -------- -TODO +Anycast Setup with 3 instances: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +On the host with unicast hostname unicast1.anycast.anytun.org and anycast +hostname anycast.anytun.org: +-------------------------------------------------------------------------------------- +# anyrtpproxy -i anycast.anytun.org -p 20000 25000 -S 2342 \ + -M unicast2.anycast.anytun.org:2342,unicast3.anycast.anytun.org:2342 +-------------------------------------------------------------------------------------- + +On the host with unicast hostname unicast2.anycast.anytun.org and anycast +hostname anycast.anytun.org: +-------------------------------------------------------------------------------------- +# anyrtpproxy -i anycast.anytun.org -p 25000 30000 -S 2342 \ + -M unicast1.anycast.anytun.org:2342,unicast3.anycast.anytun.org:2342 +-------------------------------------------------------------------------------------- + +On the host with unicast hostname unicast3.anycast.anytun.org and anycast +hostname anycast.anytun.org: +-------------------------------------------------------------------------------------- +# anyrtpproxy -i anycast.anytun.org -p 30000 35000 -S 2342 \ + -M unicast1.anycast.anytun.org:2342,unicast2.anycast.anytun.org:2342 +-------------------------------------------------------------------------------------- + + + BUGS ---- diff --git a/src/man/anytun.8.txt b/src/man/anytun.8.txt index 0e060fb..72162f2 100644 --- a/src/man/anytun.8.txt +++ b/src/man/anytun.8.txt @@ -282,7 +282,7 @@ anytun -r anycast.anytun.org -d anytun0 -t tun -n 192.0.2.2 192.0.2.1 -w 0 -c null Anycast tunnel endpoints: -^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^ On the host with unicast hostname unicast1.anycast.anytun.org and anycast hostname anycast.anytun.org: |