Update the readme
[NetworkManager.git] / README
1 Networking that Just Works
2 --------------------------
3
4 NetworkManager attempts to keep an active network connection available at all
5 times.  The point of NetworkManager is to make networking configuration and
6 setup as painless and automatic as possible.  NetworkManager is intended to
7 replace default route, replace other routes, set IP addresses, and in general
8 configure networking as NM sees fit (with the possibility of manual override as
9 necessary).  In effect, the goal of NetworkManager is to make networking Just
10 Work with a minimum of user hassle, but still allow customization and a high
11 level of manual network control.  If you have special needs, we'd like to hear
12 about them, but understand that NetworkManager is not intended for every
13 use-case.
14
15 NetworkManager will attempt to keep every network device in the system up and
16 active, as long as the device is available for use (has a cable plugged in,
17 the killswitch isn't turned on, etc).  Network connections can be set to
18 'autoconnect', meaning that NetworkManager will make that connection active
19 whenever it and the hardware is available.
20
21 "Settings services" store lists of user- or administrator-defined "connections",
22 which contain all the settings and parameters required to connect to a specific
23 network.  NetworkManager will _never_ activate a connection that is not in this
24 list, or that the user has not directed NetworkManager to connect to.
25
26
27 How it works:
28
29 The NetworkManager daemon runs as a privileged service (since it must access
30 and control hardware), but provides a D-Bus interface on the system bus to
31 allow for fine-grained control of networking.  NetworkManager does not store
32 connections or settings, it is only the mechanism by which those connections
33 are selected and activated.
34
35 To store pre-defined network connections, two separate services, the "system
36 settings service" and the "user settings service" store connection information
37 and provide these to NetworkManager, also via D-Bus.  Each settings service
38 can determine how and where it persistently stores the connection information;
39 for example, the GNOME applet stores its configuration in GConf, and the system
40 settings service stores it's config in distro-specific formats, or in a distro-
41 agnostic format, depending on user/administrator preference.
42
43 A variety of other system services are used by NetworkManager to provide
44 network functionality: wpa_supplicant for wireless connections and 802.1x
45 wired connections, pppd for PPP and mobile broadband connections, DHCP clients
46 for dynamic IP addressing, dnsmasq for proxy nameserver and DHCP server
47 functionality for internet connection sharing, and avahi-autoipd for IPv4
48 link-local addresses.  Most communication with these daemons occurs, again,
49 via D-Bus.
50
51
52 Why doesn't my network Just Work?
53
54 Driver problems are the #1 cause of why NetworkManager sometimes fails to
55 connect to wireless networks.  Often, the driver simply doesn't behave in a
56 consistent manner, or is just plain buggy.  NetworkManager supports _only_
57 those drivers that are shipped with the upstream Linux kernel, because only
58 those drivers can be easily fixed and debugged.  ndiswrapper, vendor binary
59 drivers, or other out-of-tree drivers may or may not work well with
60 NetworkManager, precisely because they have not been vetted and improved by the
61 open-source community, and becuase problems in these drivers usually cannot
62 be fixed.
63
64 Sometimes, command-line tools like 'iwconfig' will work, but NetworkManager will
65 fail.  This is again often due to buggy drivers, becuase these drivers simply
66 aren't expecting the dynamic requests that NetworkManager and wpa_supplicant
67 make.  Driver bugs should be filed in the bug tracker of the distribution being
68 run, since often distributions customize their kernel and drivers.
69
70 Sometimes, it really is NetworkManager's fault.  If you think that's the case,
71 please file a bug at http://bugzilla.gnome.org and choose the NetworkManager
72 component.  Attaching the output of /var/log/messages or /var/log/daemon.log
73 (wherever your distribution directs syslog's 'daemon' facility output) is often
74 very helpful, and (if you can get) a working wpa_supplicant config file helps
75 enormously.
76
77