pimd/README

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