d19da3becb6f5d648d6b6918964eb6f4f24f88cb
[platform/upstream/connman.git] / README
1 Connection Manager
2 ******************
3
4 Copyright (C) 2007-2010  Intel Corporation. All rights reserved.
5
6
7 Functionality and features
8 ==========================
9
10 The following features are built-in into Connection Manager:
11         - Generic plugin infrastructure
12         - Device and network abstraction (with basic storage support)
13         - IPv4, routing and DNS configuration
14
15 Various plugins can be enabled for networking support:
16         - Ethernet plugin
17         - WiFi plugin with WEP40/WEP128 and WPA/WPA2 (personal only) support
18         - Bluetooth plugin
19
20 Also plugins with additional features are available:
21         - Resolver plugin (DNS proxy)
22         - Loopback setup
23         - PolicyKit support
24
25
26 Compilation and installation
27 ============================
28
29 In order to compile Connection Manager you need following software packages:
30         - GCC compiler
31         - GLib library
32         - D-Bus library
33         - PolicyKit (optional)
34
35 To configure run:
36         ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
37
38 Configure automatically searches for all required components and packages.
39
40 To compile and install run:
41         make && make install
42
43
44 Configuration and options
45 =========================
46
47 For a working system, certain configuration options need to be enabled:
48
49         --enable-ethernet
50
51                 Enable support for Ethernet network cards
52
53         --enable-wifi
54
55                 Enable support for WiFi devices (requires wpa_supplicant)
56
57
58         --enable-bluetooth
59
60                 Enable support for Bluetooth devices (requires BlueZ)
61
62         --enable-dnsproxy
63
64                 Enable DNS proxy support for /etc/resolv.conf abstraction
65
66                 The best solution for multiple connections and proper DNS
67                 handling is a DNS proxy server. This binds a DNS proxy
68                 server to port 53 on the loopback interface (127.0.0.1).
69
70                 The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
71                 entry, but can now set the immutable bit or be on a read-only
72                 filesystem. No further modification to that file will be made.
73
74                 It is important that this is not used together with other
75                 DNS proxy solution like dnsmasq.
76
77         --enable-loopback
78
79                 Enable setup of loopback device
80
81                 For distributions with a really minimal init system and no
82                 networking scripts this can take care of setting up the
83                 loopback device and enabling it.
84
85                 It is safe to select this option even if networking scripts
86                 are in place. It detects an already configured loopback
87                 device and leaves it as it is.
88
89         --enable-polkit
90
91                 Enable support for PolicyKit authorization
92
93                 This allows to check every D-Bus access against a security
94                 policy and so restrict access to certain functionality.
95