pimd/README

   1 #
   2 # $QuaggaId: $Format:%an, %ai, %h$ $
   3 #
   4
   5 INTRODUCTION
   6
   7         qpimd aims to implement a PIM (Protocol Independent Multicast)
   8         daemon for the Quagga Routing Suite.
   9
  10         Initially qpimd targets only PIM SSM (Source-Specific
  11         Multicast) mode as defined in section 4.8.2 (PIM-SSM-Only
  12         Routers) of RFC 4601.
  13
  14         In order to deliver end-to-end multicast routing control
  15         plane, qpimd includes the router-side of IGMPv3 (RFC 3376).
  16
  17 LICENSE
  18
  19         qpimd - pimd for quagga
  20         Copyright (C) 2008 Everton da Silva Marques
  21
  22         qpimd is free software; you can redistribute it and/or modify
  23         it under the terms of the GNU General Public License as
  24         published by the Free Software Foundation; either version 2,
  25         or (at your option) any later version.
  26
  27         qpimd is distributed in the hope that it will be useful, but
  28         WITHOUT ANY WARRANTY; without even the implied warranty of
  29         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30         GNU General Public License for more details.
  31
  32         You should have received a copy of the GNU General Public
  33         License along with qpimd; see the file COPYING.  If not, write
  34         to the Free Software Foundation, Inc., 59 Temple Place - Suite
  35         330, Boston, MA 02111-1307, USA.
  36
  37 HOME SITE
  38
  39         qpimd lives at:
  40
  41         https://github.com/udhos/qpimd
  42
  43 PLATFORMS
  44
  45         qpimd has been tested with Debian Lenny under Linux 2.6.
  46
  47 REQUIREMENTS
  48
  49         qpimd requires Quagga (0.99.11 or higher from http://www.quagga.net)
  50
  51         The GNU Build System (Autotools) is required to build from
  52         source code repository.
  53
  54         gawk is also needed to build with Autotools. Any other awk
  55         usually won't work.
  56
  57 BUILDING FROM QUAGGA GIT REPOSITORY
  58
  59         1) Get the latest quagga source tree
  60
  61         # git clone git://code.quagga.net/quagga.git quagga
  62
  63         2) Apply qpimd patch into quagga source tree
  64
  65         # patch -p1 -d quagga < pimd-0.153-quagga-git20090623.patch
  66
  67         3) Compile and install quagga
  68
  69         # cd quagga
  70         # ./bootstrap.sh
  71         # ./configure --prefix=/usr/local/quagga --enable-pimd
  72         # make
  73         # make install
  74
  75 BUILDING FROM QUAGGA TARBALL
  76
  77         1) Get the latest quagga tarball
  78
  79         # wget http://www.quagga.net/download/quagga-0.99.13.tar.gz
  80
  81         2) Unpack the quagga tarball
  82
  83         # tar xzf quagga-0.99.13.tar.gz
  84
  85         3) Apply qpimd patch into quagga source tree
  86
  87         # patch -p1 -d quagga-0.99.13 < pimd-0.153-quagga-0.99.13.patch
  88
  89         4) Compile and install quagga
  90
  91         # cd quagga-0.99.13
  92         # ./configure --prefix=/usr/local/quagga --enable-pimd
  93         # make
  94         # make install
  95
  96 USAGE
  97
  98         1) Configure and start the zebra daemon
  99
 100         # cp /usr/local/quagga/etc/zebra.conf.sample /usr/local/quagga/etc/zebra.conf
 101         # vi /usr/local/quagga/etc/zebra.conf
 102         # /usr/local/quagga/sbin/zebra
 103
 104         2) Configure and start the pimd daemon
 105
 106         # cp /usr/local/quagga/etc/pimd.conf.sample /usr/local/quagga/etc/pimd.conf
 107         # vi /usr/local/quagga/etc/pimd.conf
 108         # /usr/local/quagga/sbin/pimd
 109
 110         3) Access pimd vty interface at port TCP 2611
 111
 112         # telnet localhost 2611
 113
 114 CONFIGURATION COMMANDS
 115
 116         See available commands in the file pimd/COMMANDS.
 117
 118 KNOWN CAVEATS
 119
 120         See list of known caveats in the file pimd/CAVEATS.
 121
 122 SUPPORT
 123
 124         Please post comments, questions, patches, bug reports at the
 125         support site:
 126
 127         https://github.com/udhos/qpimd
 128
 129 RELATED WORK
 130
 131         igmprt: An IGMPv3-router implementation
 132         - http://www.loria.fr/~lahmadi/igmpv3-router.html
 133
 134         USC pimd: PIMv2-SM daemon
 135         - http://netweb.usc.edu/pim/pimd (URL broken in 2008-12-23)
 136         - http://packages.debian.org/source/sid/pimd (from Debian)
 137
 138         troglobit pimd: This is the original USC pimd from
 139         http://netweb.usc.edu/pim/. In January 16, 2010 it was revived
 140         with the intention to collect patches floating around in
 141         Debian, Gentoo, Lintrack and other distribution repositories
 142         and to provide a central point of collaboration.
 143         - http://github.com/troglobit/pimd
 144
 145         zpimd: zpimd is not dependent of zebra or any other routing daemon
 146         - ftp://robur.slu.se/pub/Routing/Zebra
 147         - http://sunsite2.icm.edu.pl/pub/unix/routing/zpimd
 148
 149         mrd6: an IPv6 Multicast Router for Linux systems
 150         - http://fivebits.net/proj/mrd6/
 151
 152         MBGP: Implementation of RFC 2858 for Quagga
 153         - git://git.coplanar.net/~balajig/quagga
 154         - http://www.gossamer-threads.com/lists/quagga/dev/18000
 155
 156 REFERENCES
 157
 158         IANA Protocol Independent Multicast (PIM) Parameters
 159         http://www.iana.org/assignments/pim-parameters/pim-parameters.txt
 160
 161         Address Family Numbers
 162         http://www.iana.org/assignments/address-family-numbers
 163
 164                               -- END --