Import Debian changes 1.2.2-1
[quagga-debian.git] / debian / quagga-core.README.Debian
1 * SAFETY MEASURES:
2 ==================
3
4 The quagga package used to have a debconf option to abort during the upgrade
5 process to avoid inadvertently dropping routes and/or causing BGP flaps. This
6 has been removed as it was a violation of Debian Policy. Instead, please
7 consider setting this package "on hold" after installation by typing:
8
9     # apt-mark hold quagga
10
11 And verifying this using:
12
13     $ apt-mark showhold
14
15 Setting a package "on hold" means that it will not automatically be upgraded.
16 Instead apt-get only displays a warning saying that a new version would be
17 available forcing you to explicitly type "apt-get install quagga" to upgrade it.
18
19
20 * Daemon Selection and Control:
21 ===============================
22
23 Each routing daemon can be brought up or down independently. E.g.
24
25     # systemctl start bgpd
26
27 This will also automatically start the `zebra` service, which is a dependency
28 of all the quagga routing daemons. Restart an individual daemon in the usual
29 way:
30
31     # systemctl restart bgpd
32
33 And restart or stop all daemons by targeting the `zebra` dependency:
34
35     # systemctl restart zebra
36     # systemctl stop zebra
37
38 IMPORTANT NOTE: Before starting (and so, by extension, on restart), the `zebra`
39 service will flush all existing zebra/quagga routes from the kernel routing
40 table. To override this behaviour, copy /lib/systemd/system/zebra.service to
41 /etc/systemd/system/zebra.service, and remove the "flush" line.
42
43
44 * What is quagga?
45 =================
46
47 http://www.quagga.net/
48 > Quagga is a routing software suite, providing implementations of OSPFv2,
49 > OSPFv3, RIP v1 and v2, RIPv3 and BGPv4 for Unix platforms, particularly
50 > FreeBSD and Linux and also NetBSD, to mention a few. Quagga is a fork of GNU
51 > Zebra which was developed by Kunihiro Ishiguro. Development of GNU Zebra
52 > slowed dramatically to the point where eventually GNU Zebra was forked into
53 > Quagga.
54
55 > The Quagga tree is an attempt to provide a zebra tree with at least the
56 > bug-fixes, which have accumulated, applied, while tracking any significant
57 > changes made to the zebra.org tree. Ultimately, this tree hopes to revitalise
58 > development of this code base.
59
60 I packaged zebra-pj which was then renamed to quagga to get people used to it
61 and offer Debian users the choice which versions they like to use. I hope this
62 brings quagga some feedback and helps it evolving to a good successor of the
63 orphaned zebra.
64
65  -- Christian Hammers <ch@debian.org>, Jul/Aug 2003
66
67
68 * Why has SNMP support been disabled?
69 =====================================
70 Quagga used to link against the NetSNMP libraries to provide SNMP
71 support. Those libraries sadly link against the OpenSSL libraries
72 to provide crypto support for SNMPv3 among others.
73 OpenSSL now is not compatible with the GNU GENERAL PUBLIC LICENSE (GPL)
74 licence that Quagga is distributed under. For more explanation read:
75   http://www.gnome.org/~markmc/openssl-and-the-gpl.html
76   http://www.gnu.org/licenses/gpl-faq.html#GPLIncompatibleLibs
77 Updating the licence to explecitly allow linking against OpenSSL
78 would requite the affirmation of all people that ever contributed
79 a significant part to Zebra or Quagga and thus are the collective
80 "copyright holder". That's too much work.
81
82         *BUT*
83
84 It is allowed by the used licence mix that you fetch the sources and
85 build Quagga yourself with SNMP with
86         <remove the "grep ^smux" block at the end of debian/quagga.preinst>
87         # export WANT_SNMP=1
88         # apt-get -b source quagga
89 Just distributing it in binary form, linked against OpenSSL, is forbidden.
90
91
92 * Error message "privs_init: initial cap_set_proc failed":
93 ==========================================================
94
95 This error message means that "capability support" has to be built
96 into the kernel.
97
98
99 * Error message "netlink-listen: overrun: No buffer space available":
100 =====================================================================
101
102 If this message occurs the receive buffer should be increased by adding the
103 following to /etc/sysctl.conf and "--nl-bufsize" to /etc/quagga/debian.conf.
104 > net.core.rmem_default = 262144
105 > net.core.rmem_max = 262144
106 See message #4525 from 2005-05-09 in the quagga-users mailing list.
107
108
109 * vtysh immediately exists:
110 ===========================
111
112 Check /etc/pam.d/quagga, it probably denies access to your user. The passwords
113 configured in /etc/quagga/*.conf are only for telnet access.
114
115
116 * /etc/quagga/Quagga.conf has no effect:
117 ========================================
118
119 Quagga in Debian ignores the integrated configuration file by default (upstream
120 recommends against using it at all). If you want to use it anyway, please copy
121 the relevant .service files from /lib/systemd/system/ into /etc/systemd/system/
122 and patch out "-f *.conf".