doc/developer/building-frr-for-ubuntu1404.rst

   1 Ubuntu 14.04LTS
   2 ===============================================
   3
   4 -  MPLS is not supported on ``Ubuntu 14.04`` with default kernel. MPLS
   5    requires Linux Kernel 4.5 or higher (LDP can be built, but may have
   6    limited use without MPLS) For an updated Ubuntu Kernel, see
   7    http://kernel.ubuntu.com/~kernel-ppa/mainline/
   8
   9 Install required packages
  10 -------------------------
  11
  12 Add packages:
  13
  14 ::
  15
  16     apt-get install \
  17        git autoconf automake libtool make gawk libreadline-dev texinfo dejagnu \
  18        pkg-config libpam0g-dev libjson-c-dev bison flex python-pytest \
  19        libc-ares-dev python3-dev python3-sphinx install-info
  20
  21 .. include:: building-libyang.rst
  22
  23 Get FRR, compile it and install it (from Git)
  24 ---------------------------------------------
  25
  26 **This assumes you want to build and install FRR from source and not
  27 using any packages**
  28
  29 Add frr groups and user
  30 ^^^^^^^^^^^^^^^^^^^^^^^
  31
  32 ::
  33
  34     sudo groupadd -r -g 92 frr
  35     sudo groupadd -r -g 85 frrvty
  36     sudo adduser --system --ingroup frr --home /var/run/frr/ \
  37        --gecos "FRR suite" --shell /sbin/nologin frr
  38     sudo usermod -a -G frrvty frr
  39
  40 Download Source, configure and compile it
  41 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  42
  43 (You may prefer different options on configure statement. These are just
  44 an example.)
  45
  46 ::
  47
  48     git clone https://github.com/frrouting/frr.git frr
  49     cd frr
  50     ./bootstrap.sh
  51     ./configure \
  52         --prefix=/usr \
  53         --enable-exampledir=/usr/share/doc/frr/examples/ \
  54         --localstatedir=/var/run/frr \
  55         --sbindir=/usr/lib/frr \
  56         --sysconfdir=/etc/frr \
  57         --enable-multipath=64 \
  58         --enable-user=frr \
  59         --enable-group=frr \
  60         --enable-vty-group=frrvty \
  61         --enable-configfile-mask=0640 \
  62         --enable-logfile-mask=0640 \
  63         --enable-fpm \
  64         --with-pkg-git-version \
  65         --with-pkg-extra-version=-MyOwnFRRVersion
  66     make
  67     make check
  68     sudo make install
  69
  70 Create empty FRR configuration files
  71 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  72
  73 ::
  74
  75     sudo install -m 755 -o frr -g frr -d /var/log/frr
  76     sudo install -m 775 -o frr -g frrvty -d /etc/frr
  77     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/zebra.conf
  78     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/bgpd.conf
  79     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ospfd.conf
  80     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ospf6d.conf
  81     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/isisd.conf
  82     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ripd.conf
  83     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ripngd.conf
  84     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/pimd.conf
  85     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ldpd.conf
  86     sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf
  87     sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf
  88
  89 Enable IP & IPv6 forwarding
  90 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  91
  92 Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the
  93 other settings)
  94
  95 ::
  96
  97     # Uncomment the next line to enable packet forwarding for IPv4
  98     net.ipv4.ip_forward=1
  99
 100     # Uncomment the next line to enable packet forwarding for IPv6
 101     #  Enabling this option disables Stateless Address Autoconfiguration
 102     #  based on Router Advertisements for this host
 103     net.ipv6.conf.all.forwarding=1
 104
 105 **Reboot** or use ``sysctl -p`` to apply the same config to the running
 106 system
 107
 108 Install the init.d service
 109 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 110
 111 ::
 112
 113     sudo install -m 755 tools/frr /etc/init.d/frr
 114     sudo install -m 644 tools/etc/frr/daemons /etc/frr/daemons
 115     sudo install -m 644 -o frr -g frr tools/etc/frr/vtysh.conf /etc/frr/vtysh.conf
 116
 117 Enable daemons
 118 ^^^^^^^^^^^^^^
 119
 120 | Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for
 121   those daemons you want to start by systemd.
 122 | For example.
 123
 124 ::
 125
 126     zebra=yes
 127     bgpd=yes
 128     ospfd=yes
 129     ospf6d=yes
 130     ripd=yes
 131     ripngd=yes
 132     isisd=yes
 133
 134 Start the init.d service
 135 ^^^^^^^^^^^^^^^^^^^^^^^^
 136
 137 -  /etc/init.d/frr start
 138 -  use ``/etc/init.d/frr status`` to check its status.