Return to igmpproxy.conf.5.in CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / igmpproxy / doc

Annotation of embedaddon/igmpproxy/doc/igmpproxy.conf.5.in, revision 1.1.1.1

1.1       misho       1: .\" .br - line break (nothing else on the line)
                      2: .\" .B  - bold
                      3: .\" .I  - green or kursive (on HTML)
                      4: .\" .TP - paragraph ? (header line, followed by indented lines)
                      5: .\"
                      6: .TH igmpproxy.conf 5 "" "@PACKAGE_STRING@"
                      7: .SH NAME
                      8: igmpproxy.conf \- Configuration file for
                      9: .BR igmpproxy (8)
                     10: multicast daemon
                     11: 
                     12: .SH DESCRIPTION
                     13: .B igmpproxy.conf
                     14: contains the configuration for the 
                     15: .B igmpproxy
                     16: multicast daemon. It defines which network interfaces should be
                     17: used by the routing daemon. Each interface must be give one of the following roles:
                     18: .B upstream
                     19: ,
                     20: .B downstream
                     21: or
                     22: .B disabled
                     23: .
                     24: 
                     25: The
                     26: .B upstream
                     27: network interface is the outgoing interface which is responsible for communicating
                     28: to availible multicast data sources. There can only be one upstream interface.
                     29: 
                     30: .B Downstream
                     31: network interfaces are the distribution interfaces to the destination networks, 
                     32: where multicast clients can join groups and receive multicast data. One or more
                     33: downstream interfaces must be configured.
                     34: 
                     35: On
                     36: .B disabled
                     37: network interfaces all IGMP or multicast traffic is ignored altogether. If multiple
                     38: IP addresses is used on one single interface (ae. eth0:1 ...), all interface
                     39: aliases not in use should be configured as disabled.
                     40: 
                     41: Any line in the configuration file starting with
                     42: .B #
                     43: is treated as a comment. Keywords and parameters can be distributed over many lines.
                     44: The configuration file has two main keywords:
                     45: 
                     46: .B quickleave
                     47: .RS 
                     48: Enables quickleave mode. In this mode the daemon will send a Leave IGMP message
                     49: upstream as soon as it recieves a Leave message for any downstream interface.
                     50: The daemon will then ask for Membership reports on the downstream interfaces, 
                     51: and if a report is recieved the group is joined again upstream. Normally this
                     52: is not noticed at all by clients on the downstream networks. If it's vital
                     53: that the daemon should act exactly as a real multicast client on the upstream
                     54: interface, this function should not be used. Disabling this function increases
                     55: the risk of bandwidth saturation.
                     56: .RE
                     57: 
                     58: 
                     59: .B phyint 
                     60: .I interface
                     61: .I role 
                     62: [ ratelimit 
                     63: .I limit
                     64: ] [ threshold 
                     65: .I ttl
                     66: ] [ altnet 
                     67: .I networkaddr ... 
                     68: ]
                     69: .RS
                     70: Defines the state and settings of a network interface.
                     71: .RE
                     72: 
                     73: .SH PHYINT OPTIONS
                     74: 
                     75: .B interface
                     76: .RS
                     77: The name of the interface the settings are for. This option is required for
                     78: phyint settings.
                     79: .RE
                     80: 
                     81: .B role
                     82: .RS
                     83: The role of the interface. This should be either
                     84: .B upstream
                     85: (only one interface),
                     86: .B downstream
                     87: (one or more interfaces) or
                     88: .B disabled
                     89: . This option is required.
                     90: .RE
                     91: 
                     92: .B ratelimit
                     93: .I limit
                     94: .RS
                     95: Defines a ratelimit for the network interface. If ratelimit is set to 0 (default),
                     96: no ratelimit will be applied. This setting is optional.
                     97: .RE
                     98: 
                     99: .B threshold
                    100: .I ttl
                    101: .RS
                    102: Defines the TTL threshold for the network interface. Packets with a lower TTL than the 
                    103: threshols value will be ignored. This setting is optional, and by default the threshold is 1.
                    104: .RE
                    105: 
                    106: .B altnet
                    107: .I networkaddr
                    108: ...
                    109: .RS
                    110: Defines alternate sources for multicasting and IGMP data. The network address must be on the 
                    111: following format 'a.b.c.d/n'. By default the router will accept data from sources on the same
                    112: network as configured on an interface. If the multicast source lies on a remote network, one
                    113: must define from where traffic should be accepted. 
                    114: 
                    115: This is especially useful for the upstream interface, since the source for multicast
                    116: traffic is often from a remote location. Any number of altnet parameters can be specified.
                    117: .RE
                    118: 
                    119: 
                    120: .SH EXAMPLE
                    121: ## Enable quickleave
                    122: quickleave
                    123: .br
                    124: ## Define settings for eth0 (upstream)
                    125: .br
                    126: phyint eth0 upstream 
                    127:        altnet 10.0.0.0/8
                    128:        
                    129: ## Disable alternate IP on eth0 (eth0:0)
                    130: .br
                    131: phyint eth0:0 disabled
                    132: 
                    133: ## Define settings for eth1 (downstream)
                    134: .br
                    135: phyint eth1 downstream ratelimit 0 threshold 1
                    136: 
                    137: ## Define settings for eth2 (also downstream)
                    138: .br
                    139: phyint eth2 downstream
                    140: 
                    141: 
                    142: .SH SEE ALSO
                    143: .BR igmpproxy (8)
                    144: 
                    145: .SH AUTHOR
                    146: Originally written by Johnny Egeland <johnny@rlo.org>