vpn-provider: Do not quit vpnd if there are no VPN configurations

[platform/upstream/connman.git] / README

diff --git a/README b/README
index dfb87f8..0f86bc1 100644 (file)
--- a/README
+++ b/README
@@ -31,6 +31,11 @@ Also plugins with additional features are available:
        - PACrunner proxy handling
        - PolicyKit authorization support
 
+Note that when ConnMan starts, it clears all network interfaces that are
+going to be used. If this is not desired, network interfaces can be ignored
+either by setting NetworkInterfaceBlacklist in the main.conf config file or
+by using the -I command line option.
+
 
 Compilation and installation
 ============================
@@ -39,9 +44,10 @@ In order to compile Connection Manager you need following software packages:
        - GCC compiler
        - GLib library
        - D-Bus library
-       - GnuTLS library
        - IP-Tables library
+       - GnuTLS library (optional)
        - PolicyKit (optional)
+       - readline (command line client)
 
 To configure run:
        ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
@@ -88,7 +94,7 @@ For a working system, certain configuration options need to be enabled:
 
                It is safe to build a daemon with Bluetooth support and no
                running bluetoothd. The start of bluetoothd is automatically
-               detected and only a runtime depedency. It is not needed to
+               detected and only a runtime dependency. It is not needed to
                build ConnMan.
 
        --disable-ofono
@@ -101,7 +107,20 @@ For a working system, certain configuration options need to be enabled:
 
                It is safe to build a daemon with oFono support and no
                running ofonod. That start of ofonod is automatically
-               detected and only a runtime dependecy. It is not needed to
+               detected and only a runtime dependency. It is not needed to
+               build ConnMan.
+
+       --disable-dundee
+
+               Disable support for Bluetooth DUN devices
+
+               By default Bluetooth DUN technology (dundee) support is
+               built-in and enabled. This option can be used to build a
+               small daemon for a specific system where dundee is not used.
+
+               It is safe to build a daemon with dundee support and no
+               running dundee. That start of dundee is automatically
+               detected and only a runtime dependency. It is not needed to
                build ConnMan.
 
        --disable-pacrunner
@@ -129,6 +148,24 @@ For a working system, certain configuration options need to be enabled:
                scripts are in place. It detects an already configured
                loopback device and leaves it as it is.
 
+       --disable-wispr
+
+               Disable support for WISPr hotspot logins
+
+               For systems with really minimal memory requirements, this
+               will disable the support for WISPr hotspot logins. The code
+               for WISPr will be still compiled into the daemon, but its
+               requirement on GnuTLS for secure connections will be lifted.
+
+               The missing GnuTLS support shrinks the memory requirements
+               by about 30% and for systems that are more stationary and do
+               not log into hotspots this might be a better trade off.
+
+               Disabling WISPr support is not disabling the portal detection
+               support. A portal will still be detected, but instead of being
+               asked for login credentials, the request for a browser session
+               will be made through the agent.
+
        --enable-polkit
 
                Enable support for PolicyKit authorization
@@ -145,6 +182,44 @@ For a working system, certain configuration options need to be enabled:
                written to use NetworkManager to detect online/offline
                status and have not yet been converted to use ConnMan.
 
+       --disable-client
+
+               Disable support for the command line client
+
+               By default the command line client is enabled and uses the
+               readline library. For specific systems where ConnMan is
+               configured by other means, the command line client can be
+               disabled and the dependency on readline is removed.
+
+       --enable-selinux
+
+               Enable support for compiling SElinux type enforcement rules
+
+               The TE rules are needed if host environment is in enforcing
+               mode. Without this option, the VPN client process cannot
+               send notification to connman-vpnd via net.connman.Task
+               interface. The compiled connman-task.pp module needs to
+               also installed using this command
+                       # semodule -i connman-task.pp
+               in order to enable the dbus access.
+
+
+Kernel configuration
+====================
+
+In order to support tethering, the following kernel configuration options
+need to be enabled either as modules (m) or builtin (y):
+
+CONFIG_BRIDGE
+CONFIG_IP_NF_TARGET_MASQUERADE
+
+In order to enable CONFIG_IP_NF_TARGET_MASQUERADE, the following options need
+to be enabled also as modules (m) or builtin (y):
+
+CONFIG_NETFILTER
+CONFIG_NF_CONNTRACK_IPV4
+CONFIG_NF_NAT_IPV4
+
 
 wpa_supplicant configuration
 ============================
@@ -189,3 +264,13 @@ server will not always work. Some of the symptons are that additional
 routes will not be set by ConnMan if the uplink is a cellular
 network. While the same setup works well for a WiFi or ethernet
 uplink.
+
+
+Information
+===========
+
+Mailing list:
+       connman@connman.net
+
+For additional information about the project visit ConnMan web site:
+       http://www.connman.net