summaryrefslogtreecommitdiffstats
path: root/doc/developer/building-frr-for-freebsd10.rst
blob: 707f1e703364888b2cac4cad76f88ae98f3bcd6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
FreeBSD 10
==========================================

FreeBSD 10 restrictions:
------------------------

-  MPLS is not supported on ``FreeBSD``. MPLS requires a Linux Kernel
   (4.5 or higher). LDP can be built, but may have limited use without
   MPLS

Install required packages
-------------------------

Add packages: (Allow the install of the package management tool if this
is first package install and asked)

::

    pkg install git autoconf automake libtool gmake json-c pkgconf \
        bison flex py36-pytest c-ares python3.6 py36-sphinx libunwind \
        protobuf-c

.. include:: building-libunwind-note.rst

Make sure there is no /usr/bin/flex preinstalled (and use the newly
installed in /usr/local/bin): (FreeBSD frequently provides a older flex
as part of the base OS which takes preference in path)

.. include:: building-libyang.rst

::

    rm -f /usr/bin/flex

Get FRR, compile it and install it (from Git)
---------------------------------------------

**This assumes you want to build and install FRR from source and not
using any packages**

Add frr group and user
^^^^^^^^^^^^^^^^^^^^^^

::

    pw groupadd frr -g 101
    pw groupadd frrvty -g 102
    pw adduser frr -g 101 -u 101 -G 102 -c "FRR suite" \
        -d /usr/local/etc/frr -s /usr/sbin/nologin

(You may prefer different options on configure statement. These are just
an example)

::

    git clone https://github.com/frrouting/frr.git frr
    cd frr
    ./bootstrap.sh
    export MAKE=gmake
    export LDFLAGS="-L/usr/local/lib"
    export CPPFLAGS="-I/usr/local/include"
    ./configure \
        --sysconfdir=/usr/local/etc/frr \
        --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
        --localstatedir=/var/run/frr \
        --prefix=/usr/local \
        --enable-multipath=64 \
        --enable-user=frr \
        --enable-group=frr \
        --enable-vty-group=frrvty \
        --enable-configfile-mask=0640 \
        --enable-logfile-mask=0640 \
        --enable-fpm \
        --with-pkg-git-version \
        --with-pkg-extra-version=-MyOwnFRRVersion
    gmake
    gmake check
    sudo gmake install

Create empty FRR configuration files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

   sudo mkdir /usr/local/etc/frr

For integrated config file:

.. code-block:: shell

   sudo touch /usr/local/etc/frr/frr.conf

For individual config files:

.. note:: Integrated config is preferred to individual config.

.. code-block:: shell

   sudo touch /usr/local/etc/frr/babeld.conf
   sudo touch /usr/local/etc/frr/bfdd.conf
   sudo touch /usr/local/etc/frr/bgpd.conf
   sudo touch /usr/local/etc/frr/eigrpd.conf
   sudo touch /usr/local/etc/frr/isisd.conf
   sudo touch /usr/local/etc/frr/ldpd.conf
   sudo touch /usr/local/etc/frr/nhrpd.conf
   sudo touch /usr/local/etc/frr/ospf6d.conf
   sudo touch /usr/local/etc/frr/ospfd.conf
   sudo touch /usr/local/etc/frr/pbrd.conf
   sudo touch /usr/local/etc/frr/pimd.conf
   sudo touch /usr/local/etc/frr/ripd.conf
   sudo touch /usr/local/etc/frr/ripngd.conf
   sudo touch /usr/local/etc/frr/staticd.conf
   sudo touch /usr/local/etc/frr/zebra.conf
   sudo chown -R frr:frr /usr/local/etc/frr/
   sudo touch /usr/local/etc/frr/vtysh.conf
   sudo chown frr:frrvty /usr/local/etc/frr/vtysh.conf
   sudo chmod 640 /usr/local/etc/frr/*.conf

Enable IP & IPv6 forwarding
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Add the following lines to the end of ``/etc/sysctl.conf``:

::

   # Routing: We need to forward packets
   net.inet.ip.forwarding=1
   net.inet6.ip6.forwarding=1

**Reboot** or use ``sysctl`` to apply the same config to the running system.