doc/connman-vpn.conf.5.in

   1 .\" connman-vpn.conf(5) manual page
   2 .\"
   3 .\" Copyright (C) 2015 Intel Corporation
   4 .\"
   5 .TH "connman-vpn.conf" "5" "2015-10-15" ""
   6 .SH NAME
   7 connman-vpn.conf \- ConnMan-VPN configuration file
   8 .SH SYNOPSIS
   9 .B @sysconfdir@/connman/connman-vpn.conf
  10 .SH DESCRIPTION
  11 .P
  12 .B connman-vpn.conf
  13 is a configuration file for ConnMan-VPN. The configuration file is
  14 optional but it can be used to set up various aspects of ConnMan-VPN's
  15 behavior. The location of the file may be changed through use of
  16 the \fB\-\-config= \fRargument for \fBconnman-vpn\fP(8).
  17 .P
  18 DAC privileges (user, group and supplementary groups) of a VPN binary
  19 ran by \fBconnman-vpn\fP(8) can be controlled by this configuration.
  20 Configuration in
  21 .B connman-vpn.conf
  22 is for all VPN types and can be overridden by defining separate configs into
  23 .B @sysconfdir@/connman/vpn-plugin/
  24 using the plugin name + .conf suffix using the same syntax. For example,
  25 for OpenVPN the path to config is
  26 .B  @sysconfdir@/connman/vpn-plugin/openvpn.conf
  27 which will override any value in the main configuration.
  28
  29 .SH "FILE FORMAT"
  30 .P
  31 The configuration file consists of sections (groups) of key-value pairs.
  32 Lines beginning with a '#' and blank lines are considered comments.
  33 Sections are started by a header line containing the section enclosed
  34 in '[' and ']', and ended implicitly by the start of the next section
  35 or the end of the file. Each key-value pair must be contained in a section.
  36 .P
  37 Description of sections and available keys follows:
  38 .SS [General]
  39 This section is the only mandatory section of the configuration file.
  40 .TP
  41 .BI InputRequestTimeout= secs
  42 Set input request timeout. Default is 300 seconds. The request for inputs
  43 like passphrase will timeout after certain amount of time. Use this setting
  44 to increase the value in case of different user interface designs.
  45 .SS [DACPrivileges]
  46 This section controls the DAC privileges to use for a VPN binary used by a VPN
  47 plugin. DAC privileges that can be set are user, group and supplementary groups.
  48 .TP
  49 .BI User= username/uid
  50 User on the system to use for running VPN binary. Username or uid can be used.
  51 .TP
  52 .BI Group= groupname/gid
  53 The main group to use for running VPN binary. Group name or gid can be used.
  54 .TP
  55 .BI SupplementaryGroups= groupnames/gids
  56 Comma separated list of supplementary groups to set for the VPN binary. Groups
  57 can be defined with their names or gid's.
  58 .SH "EXAMPLES"
  59 The following example configuration sets InputRequestTimeout to 10 minutes,
  60 runs VPNs as user "vpn_user" of group "vpn" with additional supplementary
  61 groups "inet" and "net_admin".
  62 .PP
  63 .nf
  64 [General]
  65 InputRequestTimeout = 600
  66
  67 [DACPrivileges]
  68 User = vpn_user
  69 Group = vpn
  70 SupplementaryGroups = inet, net_admin
  71 .fi
  72 .SH "SEE ALSO"
  73 .BR connman (8), \ connman-vpn (8)