doc/connman.conf.5.in

   1 .\" connman.conf(5) manual page
   2 .\"
   3 .\" Copyright (C) 2012,2015 Intel Corporation
   4 .\"
   5 .TH "connman.conf" "5" "2015-10-15" ""
   6 .SH NAME
   7 main.conf \- ConnMan configuration file
   8 .SH SYNOPSIS
   9 .B @sysconfdir@/connman/main.conf
  10 .SH DESCRIPTION
  11 .P
  12 .B main.conf
  13 is a configuration file for ConnMan. The configuration file is
  14 optional but it can be used to set up various aspects of ConnMan's
  15 behavior. The location of the file may be changed through use of
  16 the \fB\-\-config= \fRargument for \fBconnman\fP(8).
  17 .SH "FILE FORMAT"
  18 .P
  19 The configuration file consists of sections (groups) of key-value pairs.
  20 Lines beginning with a '#' and blank lines are considered comments.
  21 Sections are started by a header line containing the section enclosed
  22 in '[' and ']', and ended implicitly by the start of the next section
  23 or the end of the file. Each key-value pair must be contained in a section.
  24 .P
  25 Description of sections and available keys follows:
  26 .SS [General]
  27 This section is the only mandatory section of the configuration file.
  28 .TP
  29 .BI InputRequestTimeout= secs
  30 Set input request timeout. Default is 120 seconds
  31 The request for inputs like passphrase will timeout
  32 after certain amount of time. Use this setting to
  33 increase the value in case of different user
  34 interface designs.
  35 .TP
  36 .BI BrowserLaunchTimeout= secs
  37 Set browser launch timeout. Default is 300 seconds
  38 The request for launching a browser for portal pages
  39 will timeout after certain amount of time. Use this
  40 setting to increase the value in case of different
  41 user interface designs.
  42 .TP
  43 .BI BackgroundScanning=true\ \fR|\fB\ false
  44 Enable background scanning. Default is true.
  45 If wifi is disconnected, the background scanning will follow a simple
  46 backoff mechanism from 3s up to 5 minutes. Then, it will stay in 5
  47 minutes unless user specifically asks for scanning through a D-Bus
  48 call. If so, the mechanism will start again from 3s. This feature
  49 activates also the background scanning while being connected, which
  50 is required for roaming on wifi.
  51 When BackgroundScanning is false, ConnMan will not perform any scan
  52 regardless of wifi is connected or not, unless it is requested by
  53 the user through a D-Bus call.
  54 .TP
  55 .BI UseGatewaysAsTimeservers=true \fR|\fB\ false
  56 Assume that service gateways also function as timeservers.
  57 Default is false.
  58 .TP
  59 .BI FallbackTimeservers= server\fR[,...]
  60 List of Fallback timeservers separated by ",".
  61 These timeservers are used for NTP sync when there are
  62 no timeservers set by the user or by the service, and
  63 when UseGatewaysAsTimeservers = false. These can contain
  64 a mixed combination of fully qualified domain names, IPv4
  65 and IPv6 addresses.
  66 .TP
  67 .BI FallbackNameservers= server\fR[,...]
  68 List of fallback nameservers separated by "," appended
  69 to the list of nameservers given by the service. The
  70 nameserver entries must be in numeric format, host
  71 names are ignored.
  72 .TP
  73 .BI DefaultAutoConnectTechnologies= technology\fR[,...]
  74 List of technologies that are marked autoconnectable
  75 by default, separated by commas ",". The default value
  76 for this entry when empty is ethernet,wifi,cellular.
  77 Services that are automatically connected must have been
  78 set up and saved to storage beforehand.
  79 .TP
  80 .BI DefaultFavoriteTechnologies= technology\fR[,...]
  81 List of technologies that are marked favorite by default,
  82 separated by commas ",". The default value for this entry
  83 when empty is ethernet. Connects to services from this
  84 technology even if not setup and saved to storage.
  85 .TP
  86 .BI AlwaysConnectedTechnologies= technology\fR[,...]
  87 List of technoolgies which are always connected regardless
  88 of PreferredTechnologies setting (AutoConnect = true). The
  89 default value is empty and this feature is disabled unless
  90 explicitly enabled in the config file.
  91 .TP
  92 .BI PreferredTechnologies= technology\fR[,...]
  93 List of preferred technologies from the most preferred
  94 one to the least preferred one separated by commas ",".
  95 Services of the listed technology type will be tried one
  96 by one in the order given, until one of them gets connected
  97 or they are all tried. A service of a preferred technology
  98 type in state 'ready' will get the default route when
  99 compared to another preferred type further down the list
 100 with state 'ready' or with a non-preferred type; a service
 101 of a preferred technology type in state 'online' will get
 102 the default route when compared to either a non-preferred
 103 type or a preferred type further down in the list.
 104 .TP
 105 .BI NetworkInterfaceBlacklist= interface\fR[,...]
 106 List of blacklisted network interfaces separated by ",".
 107 Found interfaces will be compared to the list and will
 108 not be handled by connman, if their first characters
 109 match any of the list entries. Default value is
 110 vmnet,vboxnet,virbr,ifb.
 111 .TP
 112 .BI AllowHostnameUpdates=true\ \fR|\fB\ false
 113 Allow connman to change the system hostname. This can
 114 happen for example if we receive DHCP hostname option.
 115 Default value is true.
 116 .TP
 117 .BI AllowDomainnameUpdates=true\ \fR|\fB\ false
 118 Allow connman to change the system domainname. This can
 119 happen for example if we receive DHCP domainname option.
 120 Default value is true.
 121 .TP
 122 .BI SingleConnectedTechnology=true\ \fR|\fB\ false
 123 Keep only a single connected technology at any time. When a new
 124 service is connected by the user or a better one is found according
 125 to PreferredTechnologies, the new service is kept connected and all
 126 the other previously connected services are disconnected. With this
 127 setting it does not matter whether the previously connected services
 128 are in 'online' or 'ready' states, the newly connected service is
 129 the only one that will be kept connected. A service connected by the
 130 user will be used until going out of network coverage. With this
 131 setting enabled applications will notice more network breaks than
 132 normal. Default value is false.
 133 .TP
 134 .BI TetheringTechnologies= technology\fR[,...]
 135 List of technologies that are allowed to enable tethering separated by ",".
 136 The default value is wifi,bluetooth,gadget. Only those technologies listed
 137 here are used for tethering. If one wants to tether ethernet,
 138 then add "ethernet" in the list.
 139 NOTE that if ethernet tethering is enabled, then a DHCP server is
 140 started on all ethernet interfaces. Tethered ethernet should
 141 never be connected to corporate or home network as it will disrupt
 142 normal operation of these networks. Due to this ethernet is not
 143 tethered by default. Do not activate ethernet tethering unless you
 144 really know what you are doing.
 145 .TP
 146 .BI PersistentTetheringMode=true\ \fR|\fB\ false
 147 Restore earlier tethering status when returning from offline mode,
 148 re-enabling a technology, and after restarts and reboots.
 149 Default value is false.
 150 .TP
 151 .BI Enable6to4=true\ \fR|\fB\ false
 152 Automatically enable Anycast 6to4 if possible. This is not recommended, as the
 153 use of 6to4 will generally lead to a severe degradation of connection quality.
 154 See RFC6343.  Default value is false (as recommended by RFC6343 section 4.1).
 155 .TP
 156 .BI VendorClassID= string
 157 Set DHCP option 60 (Vendor Class ID) to the given string. This option can
 158 be used by DHCP servers to identify specific clients without having to
 159 rely on MAC address ranges, etc
 160 .TP
 161 .BI EnableOnlineCheck=true\ \fR|\fB\ false
 162 Enable or disable use of HTTP GET as an online status check.
 163 When a service is in a READY state, and is selected as default,
 164 ConnMan will issue an HTTP GET request to verify that end-to-end
 165 connectivity is successful. Only then the service will be
 166 transitioned to ONLINE state.
 167 If this setting is false, the default service will remain in READY state.
 168 Default value is true.
 169 .TP
 170 .BI OnlineCheckInitialInterval= secs, OnlineCheckMaxInterval= secs
 171 Range of intervals between two online check requests.
 172 When an online check request fails, another one is triggered after a
 173 longer interval. The intervals follow the power of two series of numbers
 174 between OnlineCheckInitialInterval and OnlineCheckMaxInterval.
 175 Default range is [1, 12], corresponding to the following intervals, in
 176 seconds: 1, 4, 9, 16, 25, 36, 49, 64, 81, 100, 121 and 144.
 177 .TP
 178 .BI EnableOnlineToReadyTransition=true\ \fR|\fB\ false
 179 WARNING: Experimental feature!!!
 180 In addition to EnableOnlineCheck setting, enable or disable use of HTTP GET
 181 to detect the loss of end-to-end connectivity.
 182 If this setting is false, when the default service transitions to ONLINE
 183 state, the HTTP GET request is no more called until next cycle, initiated
 184 by a transition of the default service to DISCONNECT state.
 185 If this setting is true, the HTTP GET request keeps beeing called to guarantee
 186 that end-to-end connectivity is still successful. If not, the default service
 187 will transition to READY state, enabling another service to become the
 188 default one, in replacement.
 189 Default value is false.
 190 .TP
 191 .BI AutoConnectRoamingServices=true\ \fR|\fB\ false
 192 Automatically connect roaming services. This is not recommended unless you know
 193 you won't have any billing problem.
 194 Default value is false.
 195 .TP
 196 .BI AddressConflictDetection=true\ \fR|\fB\ false
 197 Enable or disable the implementation of IPv4 address conflict detection
 198 according to RFC5227. ConnMan will send probe ARP packets to see if an
 199 IPv4 address is already in use before assigning the address to an interface.
 200 If an address conflict occurs for a statically configured address, an IPv4LL
 201 address will be chosen instead (according to RFC3927). If an address conflict
 202 occurs for an address offered via DHCP, ConnMan send a DHCP DECLINE once and
 203 for the second conflict resort to finding an IPv4LL address.
 204 Default value is false.
 205 .SH "EXAMPLE"
 206 The following example configuration disables hostname updates and enables
 207 ethernet tethering.
 208 .PP
 209 .nf
 210 [General]
 211 AllowHostnameUpdates = false
 212 AllowDomainnameUpdates = false
 213 TetheringTechnologies = ethernet,wifi,bluetooth,gadget
 214 .fi
 215 .SH "SEE ALSO"
 216 .BR connman (8)