doc/anyrtpproxy.8.txt

   1 anyrtpproxy(8)
   2 ==============
   3
   4 NAME
   5 ----
   6 anyrtpproxy - anycast rtpproxy
   7
   8 SYNOPSIS
   9 --------
  10
  11 ....
  12 anyrtpproxy
  13   [ -h|--help ]
  14   [ -D|--nodaemonize ]
  15   [ -C|--chroot ]
  16   [ -u|--username <username> ]
  17   [ -H|--chroot-dir <directory> ]
  18   [ -P|--write-pid <filename> ]
  19   [ -i|--interface <ip-address> ]
  20   [ -s|--control <hostname|ip>[:<port>] ]
  21   [ -p|--port-range <start> <end> ]
  22   [ -n|--nat ]
  23   [ -o|--no-nat-once ]
  24   [ -S|--sync-port port> ]
  25   [ -M|--sync-hosts <hostname|ip>:<port>[,<hostname|ip>:<port>[...]] ]
  26 ....
  27
  28
  29 DESCRIPTION
  30 -----------
  31
  32 *anyrtpproxy* is a rtpproxy which can be used in combination with anycast. It uses
  33 the same control protocol than rtpproxy though it can be controled through the nathelper
  34 plugin of openser. *anyrtpproxy* uses the same synchronisation protocol than *Anytun*
  35 to sync the session information among all anycast instances.
  36
  37
  38 OPTIONS
  39 -------
  40
  41 *-D, --nodaemonize*::
  42    This option instructs *anyrtpproxy* to run in the foreground
  43    instead of becoming a daemon.
  44
  45 *-C, --chroot*::
  46    chroot and drop privileges
  47
  48 *-u, --username <username>*::
  49    if chroot change to this user
  50
  51 *-H, --chroot-dir <directory>*::
  52    chroot to this directory
  53
  54 *-P, --write-pid <filename>*::
  55    write pid to this file
  56
  57 *-i, --interface <ip address>*::
  58   The local interface to listen on for RTP packets
  59
  60 *-s, --control <hostname|ip>[:<port>]*::
  61    The local address and port to listen on for control messages from openser
  62
  63 *-p, --port-range <start> <end>*::
  64    A pool of ports which should be used by *anyrtpproxy* to relay RTP packets.
  65    The range may not overlap between the anycast instances
  66
  67 *-n, --nat*::
  68    Allow to learn the remote address and port in order to handle clients behind nat.
  69    This option should only be enabled if the source is authenticated (i.e. through
  70    *anytun*)
  71
  72 *-o, --no-nat-once*::
  73    Disable learning of remote address and port in case the first packet does not
  74    come from the client which is specified by openser during configuration. Invoking
  75    this parameter increases the security level of the system but in case of nat needs
  76    a working nat transversal such as stun.
  77
  78 *-S, --sync-port <port>*::
  79    local unicast(sync) port to bind to +
  80    This port is used by anycast hosts to synchronize information about tunnel
  81    endpoints. No payload data is transmitted via this port. +
  82    It is possible to obtain a list of active connections by telnetting into
  83    this port. This port is read-only and unprotected by default. It is advised
  84    to protect this port using firewall rules and, eventually, IPsec.
  85
  86 *-M, --sync-hosts <hostname|ip>:<port>,[<hostname|ip>:<port>[...]]*::
  87    remote hosts to sync with +
  88    Here, one has to specify all unicast IP addresses of all
  89    other anycast hosts that comprise the anycast tunnel endpoint.
  90
  91 EXAMPLES
  92 --------
  93
  94 Anycast Setup with 3 instances:
  95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  96
  97 On the host with unicast hostname unicast1.anycast.anytun.org and anycast
  98 hostname anycast.anytun.org:
  99 --------------------------------------------------------------------------------------
 100 # anyrtpproxy -i anycast.anytun.org -p 20000 25000 -S 2342 \
 101               -M unicast2.anycast.anytun.org:2342,unicast3.anycast.anytun.org:2342
 102 --------------------------------------------------------------------------------------
 103
 104 On the host with unicast hostname unicast2.anycast.anytun.org and anycast
 105 hostname anycast.anytun.org:
 106 --------------------------------------------------------------------------------------
 107 # anyrtpproxy -i anycast.anytun.org -p 25000 30000 -S 2342 \
 108               -M unicast1.anycast.anytun.org:2342,unicast3.anycast.anytun.org:2342
 109 --------------------------------------------------------------------------------------
 110
 111 On the host with unicast hostname unicast3.anycast.anytun.org and anycast
 112 hostname anycast.anytun.org:
 113 --------------------------------------------------------------------------------------
 114 # anyrtpproxy -i anycast.anytun.org -p 30000 35000 -S 2342 \
 115               -M unicast1.anycast.anytun.org:2342,unicast2.anycast.anytun.org:2342
 116 --------------------------------------------------------------------------------------
 117
 118
 119 BUGS
 120 ----
 121 Most likely there are some bugs in *anyrtpproxy*. If you find a bug, please let
 122 the developers know at satp@anytun.org. Of course, patches are preferred.
 123
 124 SEE ALSO
 125 --------
 126 anytun(8)
 127
 128 AUTHORS
 129 -------
 130
 131 Othmar Gsenger <otti@anytun.org>
 132 Erwin Nindl <nine@anytun.org>
 133 Christian Pointner <equinox@anytun.org>
 134
 135
 136 RESOURCES
 137 ---------
 138
 139 Main web site: http://www.anytun.org/
 140
 141
 142 COPYING
 143 -------
 144
 145 Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian
 146 Pointner. This  program is  free software: you can redistribute it
 147 and/or modify it under the terms of the GNU General Public License
 148 as published by the Free Software Foundation, either version 3 of
 149 the License, or any later version.
 150