source: networking/netutils/networkmanager.xml@ 192cd85

elogind
Last change on this file since 192cd85 was 192cd85, checked in by DJ Lucas <dj@…>, 5 years ago

Remove NetworkManager dependency on ConsoleKit.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21135 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 19.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY NetworkManager-download-http
8 "&gnome-download-http;/NetworkManager/1.14/NetworkManager-&NetworkManager-version;.tar.xz">
9 <!ENTITY NetworkManager-download-ftp
10 "&gnome-download-ftp;/NetworkManager/1.14/NetworkManager-&NetworkManager-version;.tar.xz">
11 <!ENTITY NetworkManager-md5sum "54ce62f0aa18ef6c5e754eaac47494ac">
12 <!ENTITY NetworkManager-size "4.2 MB">
13 <!ENTITY NetworkManager-buildsize "721 MB (with tests)">
14 <!ENTITY NetworkManager-time "0.5 SBU (with tests)">
15]>
16
17<sect1 id="NetworkManager" xreflabel="NetworkManager-&NetworkManager-version;">
18 <?dbhtml filename="networkmanager.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>NetworkManager-&NetworkManager-version;</title>
26
27 <indexterm zone="NetworkManager">
28 <primary sortas="a-NetworkManager">NetworkManager</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to NetworkManager</title>
33
34 <para>
35 <application>NetworkManager</application> is a set of co-operative
36 tools that make networking simple and straightforward. Whether you use WiFi,
37 wired, 3G, or Bluetooth, NetworkManager allows you to quickly move from
38 one network to another: Once a network has been configured and joined
39 once, it can be detected and re-joined automatically the next time it's
40 available.
41 </para>
42
43 &lfs83_checked;
44
45 <note revision="systemd">
46 <para>
47 Make sure that you disable the <command>systemd-networkd</command>
48 service or configure it not to manage the interfaces you want to manage
49 with <application>NetworkManager</application>.
50 </para>
51 </note>
52
53 <bridgehead renderas="sect3">Package Information</bridgehead>
54 <itemizedlist spacing="compact">
55 <listitem>
56 <para>
57 Download (HTTP): <ulink url="&NetworkManager-download-http;"/>
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download (FTP): <ulink url="&NetworkManager-download-ftp;"/>
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download MD5 sum: &NetworkManager-md5sum;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Download size: &NetworkManager-size;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Estimated disk space required: &NetworkManager-buildsize;
78 </para>
79 </listitem>
80 <listitem>
81 <para>
82 Estimated build time: &NetworkManager-time;
83 </para>
84 </listitem>
85 </itemizedlist>
86
87 <bridgehead renderas="sect3">NetworkManager Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Required</bridgehead>
90 <para role="required">
91 <xref linkend="dbus-glib"/> and
92 <xref linkend="libndp"/>
93 </para>
94
95 <bridgehead renderas="sect4">Recommended</bridgehead>
96 <para role="recommended">
97 <xref linkend="curl"/>,
98 <xref linkend="dhcpcd"/> or
99 <xref linkend="dhcp"/> (client only),
100 <xref linkend="gobject-introspection"/>,
101 <xref linkend="iptables"/>,
102 <xref linkend="newt"/> (for <command>nmtui</command>),
103 <xref linkend="nss"/>,
104 <xref linkend="polkit"/>,
105 <xref linkend="pygobject3"/>,
106 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
107 <phrase revision="systemd"><xref linkend="systemd"/>,</phrase>
108 <xref linkend="upower"/>,
109 <xref linkend="vala"/>, and
110 <xref linkend="wpa_supplicant"/> (built with D-Bus support),
111 </para>
112
113 <bridgehead renderas="sect4">Optional</bridgehead>
114 <para role="optional">
115 <xref linkend="bluez"/>,
116 <xref linkend="dbus-python"/> (for the test suite),
117 <xref linkend="gnutls"/> (used if <xref linkend="nss"/> is not found),
118 <xref linkend="gtk-doc"/>,
119 <xref linkend="jansson"/>,
120 <xref linkend="libpsl"/>,
121 <xref linkend="qt5"/> (for examples),
122 <xref linkend="ModemManager"/>,
123 <xref linkend="valgrind"/>,
124 <ulink url="http://www.thekelleys.org.uk/dnsmasq/doc.html">dnsmasq</ulink>,
125 <ulink url="https://github.com/Distrotech/libaudit">libaudit</ulink>,
126 <ulink url="https://github.com/jpirko/libteam">libteam</ulink>,
127 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink>, and
128 <ulink url="https://dianne.skoll.ca/projects/rp-pppoe/">RP-PPPoE</ulink>
129 </para>
130
131 <para condition="html" role="usernotes">User Notes:
132 <ulink url="&blfs-wiki;/NetworkManager"/>
133 </para>
134 </sect2>
135
136 <sect2 role="installation">
137 <title>Installation of NetworkManager</title>
138
139 <para>If <xref linkend="qt5"/> is installed and the Qt based
140 examples are desired, fix the configure script:</para>
141
142<screen><userinput>sed -e '/Qt[CDN]/s/Qt/Qt5/g' \
143 -e 's/-qt4/-qt5/' \
144 -e 's/moc_location/host_bins/' \
145 -i examples/C/qt/meson.build</userinput></screen>
146
147 <para>
148 Fix a missing meson.build file for initrd hooks (not used in BLFS):
149 </para>
150
151<screen><userinput>sed '/initrd/d' -i src/meson.build</userinput></screen>
152
153 <para>
154 Fix the python scripts so that they use <application>Python
155 3</application>:
156 </para>
157
158<screen><userinput>grep -rl '^#!.*python$' | xargs sed -i '1s/python/&amp;3/'</userinput></screen>
159
160 <para>
161 Install <application>NetworkManager</application> by running the
162 following commands:
163 </para>
164
165<screen revision="sysv"><userinput>mkdir build &amp;&amp;
166cd build &amp;&amp;
167
168CXXFLAGS+="-O2 -fPIC" \
169meson --prefix /usr \
170 --sysconfdir /etc \
171 --localstatedir /var \
172 -Djson_validation=false \
173 -Dlibaudit=no \
174 -Dlibnm_glib=true \
175 -Dlibpsl=false \
176 -Dnmtui=true \
177 -Dovs=false \
178 -Dppp=false \
179 -Dselinux=false \
180 -Dudev_dir=/lib/udev \
181 -Dsession_tracking=elogind \
182 -Dmodem_manager=false \
183 -Dsystemdsystemunitdir=no \
184 -Dsystemd_journal=false \
185 -Dqt=false \
186 .. &amp;&amp;
187ninja</userinput></screen>
188
189<screen revision="systemd"><userinput>mkdir build &amp;&amp;
190cd build &amp;&amp;
191
192CXXFLAGS+="-O2 -fPIC" \
193meson --prefix /usr \
194 --sysconfdir /etc \
195 --localstatedir /var \
196 -Djson_validation=false \
197 -Dlibaudit=no \
198 -Dlibnm_glib=true \
199 -Dlibpsl=false \
200 -Dnmtui=true \
201 -Dovs=false \
202 -Dppp=false \
203 -Dselinux=false \
204 -Dqt=false \
205 -Dudev_dir=/lib/udev \
206 -Dsession_tracking=systemd \
207 -Dmodem_manager=false \
208 -Dsystemdsystemunitdir=/lib/systemd/system \
209 .. &amp;&amp;
210ninja</userinput></screen>
211
212 <para>
213 An already active <phrase revision="sysv">graphical</phrase> session
214 with bus address is necessary to run the tests. To test the results,
215 issue: <command>ninja test</command>.
216 </para>
217
218 <para>
219 Now, as the <systemitem class="username">root</systemitem> user:
220 </para>
221
222<screen role="root"><userinput>ninja install &amp;&amp;
223mv -v /usr/share/doc/NetworkManager{,-&NetworkManager-version;}</userinput></screen>
224
225 </sect2>
226
227 <sect2 role="commands">
228 <title>Command Explanations</title>
229
230 <para>
231 <envar>CXXFLAGS="-O2 -fPIC"</envar>: These compiler options are
232 necessary to build the Qt5 based examples.
233 </para>
234
235 <para>
236 <option>-Ddocs=true</option>: Use this switch to enable building
237 man pages and documentation if <xref linkend="gtk-doc"/> is installed.
238 </para>
239
240 <para>
241 <parameter>-Dnmtui=true</parameter>: This parameter enables building
242 <command>nmtui</command>.
243 </para>
244
245 <para revision="sysv">
246 <parameter>-Dsystemdsystemunitdir=no</parameter> and
247 <parameter>-Dsystemd_journal=false</parameter>: systemd is not
248 used for sysv init systems.
249 </para>
250
251 <para>
252 <parameter>-Djson_validation=false</parameter>,
253 <parameter>-Dlibpsl=false</parameter>, and
254 <parameter>-Dovs=false</parameter>: These switches disable building with the
255 respective libraries. Remove if you have the needed libraries installed.
256 </para>
257
258 <para>
259 <parameter>-Dmodem_manager=false</parameter>: This switch is requried if
260 <application>ModemManager</application> is not installed. Omit if you
261 have built <application>ModemManager</application>.
262 </para>
263
264 <para revision="sysv">
265 <parameter>-Dsession_tracking=elogind</parameter>: This switch
266 is used to set <command>elogind</command> as the default
267 program for session tracking.
268 </para>
269
270 <para revision="systemd">
271 <parameter>-Dsession_tracking=systemd</parameter>: This switch
272 is used to set <command>systemd-logind</command> as the default
273 program for session tracking.
274 </para>
275
276 <para revision="systemd">
277 <parameter>-Dsystemdsystemunitdir=/lib/systemd/system</parameter>:
278 This switch is used to set the correct installation directory for
279 systemd units.
280 </para>
281
282 <para>
283 <parameter>-Dppp=false</parameter>: This parameter disables
284 <application>PPP</application> support in
285 <application>NetworkManager</application>.
286 </para>
287
288 <para>
289 <parameter>-Dlibaudit=no</parameter> and
290 <parameter>-Dselinux=false</parameter>: libaudit and SELinux are not used
291 in BLFS.
292 </para>
293
294 <para>
295 <parameter>-Dqt=false</parameter>: disables the
296 <application>QT</application> examples. Omit if you have
297 <application>QT</application> available and wish to install the examples.
298 </para>
299
300 </sect2>
301
302 <sect2 role="configuration">
303 <title>Configuring NetworkManager</title>
304
305 <sect3 id="NetworkManager-config">
306 <title>Config Files</title>
307 <para>
308 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
309 </para>
310
311 <indexterm zone="NetworkManager NetworkManager-config">
312 <primary
313 sortas="e-etc-NetworkManager-NetworkManager.conf">
314 /etc/NetworkManager/NetworkManager.conf</primary>
315 </indexterm>
316
317 </sect3>
318
319 <sect3><title>Configuration Information</title>
320
321 <para>
322 For <application>NetworkManager</application> to work, at least
323 a minimal configuration file must be present. Such file is not
324 installed with <command>make install</command>. Issue the following
325 command as the <systemitem class="username">root</systemitem> user to
326 create minimal <filename>NetworkManager.conf</filename> file:
327 </para>
328
329<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
330<literal>[main]
331plugins=keyfile</literal>
332EOF</userinput></screen>
333
334 <para>
335 This file should not be modified directly by users of the system.
336 Instead, system specific changes should be made using configuration
337 files in the
338 <filename class="directory">/etc/NetworkManager/conf.d</filename>
339 direcotry.
340 </para>
341
342 <para>
343 To allow polkit to manage authorizations, add the following
344 configuration file:
345 </para>
346
347<screen role="root"><userinput>cat &gt; /etc/NetworkManager/conf.d/polkit.conf &lt;&lt; "EOF"
348<literal>[main]
349auth-polkit=true</literal>
350EOF</userinput></screen>
351
352 <para>
353 To use something other than the built-in dhcp client (recommended if
354 using only <command>nmcli</command>), use the following configuration
355 (valid values are dhclient, dhcpcd, and internal):
356 </para>
357
358<screen role="nodump"><userinput>cat &gt; /etc/NetworkManager/conf.d/dhcp.conf &lt;&lt; "EOF"
359<literal>[main]
360dhcp=</literal><replaceable>dhclient</replaceable>
361EOF</userinput></screen>
362
363 <para>
364 To prevent <application>NetworkManager</application> from updating the
365 <filename>/etc/resolv.conf</filename> file, add the following
366 configuration file:
367 </para>
368
369<screen role="nodump"><userinput>cat &gt; /etc/NetworkManager/conf.d/no-dns-update.conf &lt;&lt; "EOF"
370<literal>[main]
371dns=none</literal>
372EOF</userinput></screen>
373
374 <para>
375 For additional configuation options, see
376 <command>man 5 NetworkManager.conf</command>.
377 </para>
378
379 <para>
380 To allow regular users permission to configure network connections,
381 you should add them to the
382 <systemitem class="groupname">netdev</systemitem>
383 group, and create a <application>polkit</application> rule that grants
384 access. Run the following commands as the
385 <systemitem class="username">root</systemitem> user:
386 </para>
387
388<screen role="root"><userinput>groupadd -fg 86 netdev &amp;&amp;
389/usr/sbin/usermod -a -G netdev <replaceable>&lt;username&gt;</replaceable>
390
391cat &gt; /usr/share/polkit-1/rules.d/org.freedesktop.NetworkManager.rules &lt;&lt; "EOF"
392<literal>polkit.addRule(function(action, subject) {
393 if (action.id.indexOf("org.freedesktop.NetworkManager.") == 0 &amp;&amp; subject.isInGroup("netdev")) {
394 return polkit.Result.YES;
395 }
396});</literal>
397EOF</userinput></screen>
398
399 </sect3>
400
401 <sect3 id="NetworkManager-init">
402 <title><phrase revision="sysv">Boot Script</phrase>
403 <phrase revision="systemd">Systemd Unit</phrase></title>
404
405 <para revision="sysv">
406 To automatically start the <command>NetworkManager</command> daemon
407 when the system is rebooted, install the
408 <filename>/etc/rc.d/init.d/networkmanager</filename>bootscript from the
409 <xref linkend="bootscripts"/> package.
410 </para>
411
412 <para revision="systemd">
413 To start the <command>NetworkManager</command> daemon at boot, enable
414 the previously installed systemd unit by running the following command
415 as the <systemitem class="username">root</systemitem> user:
416 </para>
417
418 <note>
419 <para>
420 If using <application>Network Manager</application> to manage
421 an interface, any previous configuration for that interface should be
422 removed, and the interface brought down prior to starting
423 <application>Network Manager</application>.
424 </para>
425 </note>
426
427 <indexterm zone="NetworkManager NetworkManager-init">
428 <primary sortas="f-NetworkManager">NetworkManager</primary>
429 </indexterm>
430
431<screen role="root" revision="sysv"><userinput>make install-networkmanager</userinput></screen>
432
433<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager</userinput></screen>
434
435 <para revision="systemd">
436 <application>NetworkManager</application> also ships a systemd unit
437 called <filename>NetworkManager-wait-online.service</filename> which
438 can be used to prevent services that require network connectivity
439 from starting until <application>NetworkManager</application> has
440 established the connection. To enable it, run the following command
441 as the <systemitem class="username">root</systemitem> user:
442 </para>
443
444<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
445
446 </sect3>
447
448 </sect2>
449
450 <sect2 role="content">
451 <title>Contents</title>
452
453 <segmentedlist>
454 <segtitle>Installed Programs</segtitle>
455 <segtitle>Installed Libraries</segtitle>
456 <segtitle>Installed Directories</segtitle>
457
458 <seglistitem>
459 <seg>
460 NetworkManager, nmcli, nm-online, nmtui, and, symlinked to nmtui:
461 nmtui-connect, nmtui-edit, and nmtui-hostname
462 </seg>
463 <seg>
464 libnm.so and several modules under /usr/lib/NetworkManager
465 </seg>
466 <seg>
467 /etc/NetworkManager,
468 /usr/include/libnm,
469 /usr/lib/NetworkManager,
470 /usr/share/doc/NetworkManager-&NetworkManager-version;,
471 /usr/share/gtk-doc/html/{libnm,NetworkManager}
472 (if the documentation is built),
473 and
474 /var/lib/NetworkManager
475 </seg>
476 <!-- A lot of libraries were removed here. We should verify compatibilty. -->
477 </seglistitem>
478 </segmentedlist>
479
480 <variablelist>
481 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
482 <?dbfo list-presentation="list"?>
483 <?dbhtml list-presentation="table"?>
484
485 <varlistentry id="nmcli">
486 <term><command>nmcli</command></term>
487 <listitem>
488 <para>
489 is a command-line tool for controlling
490 <application>NetworkManager</application>
491 and getting its status.
492 </para>
493 <indexterm zone="NetworkManager nmcli">
494 <primary sortas="b-nmcli">nmcli</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry id="nm-online">
500 <term><command>nm-online</command></term>
501 <listitem>
502 <para>
503 is a utility to find out whether you are online.
504 </para>
505 <indexterm zone="NetworkManager nm-online">
506 <primary sortas="b-nm-online">nm-online</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="nmtui">
512 <term><command>nmtui</command></term>
513 <listitem>
514 <para>
515 is an interactive ncurses based interface for
516 <application>nmcli</application>.
517 </para>
518 <indexterm zone="NetworkManager nmtui">
519 <primary sortas="b-nmtui">nmtui</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="nmtui-connect">
525 <term><command>nmtui-connect</command></term>
526 <listitem>
527 <para>
528 is an interactive ncurses based interface connection to
529 activate/deactivate connections.
530 </para>
531 <indexterm zone="NetworkManager nmtui-connect">
532 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
533 </indexterm>
534 </listitem>
535 </varlistentry>
536
537 <varlistentry id="nmtui-edit">
538 <term><command>nmtui-edit</command></term>
539 <listitem>
540 <para>
541 is an interactive ncurses based interface connection editor.
542 </para>
543 <indexterm zone="NetworkManager nmtui-edit">
544 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry id="nmtui-hostname">
550 <term><command>nmtui-hostname</command></term>
551 <listitem>
552 <para>
553 is an interactive ncurses based interface hostname editor.
554 </para>
555 <indexterm zone="NetworkManager nmtui-hostname">
556 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
557 </indexterm>
558 </listitem>
559 </varlistentry>
560
561 <varlistentry id="NetworkManager-prog">
562 <term><command>NetworkManager</command></term>
563 <listitem>
564 <para>
565 is the network management daemon.
566 </para>
567 <indexterm zone="NetworkManager NetworkManager-prog">
568 <primary sortas="b-NetworkManager">NetworkManager</primary>
569 </indexterm>
570 </listitem>
571 </varlistentry>
572
573 <varlistentry id="libnm">
574 <term><filename class="libraryfile">libnm.so</filename></term>
575 <listitem>
576 <para>
577 contains functions used by <application>NetworkManager</application>.
578 </para>
579 <indexterm zone="NetworkManager libnm">
580 <primary sortas="c-libnm">libnm.so</primary>
581 </indexterm>
582 </listitem>
583 </varlistentry>
584
585 </variablelist>
586
587 </sect2>
588
589</sect1>
Note: See TracBrowser for help on using the repository browser.