Skip to content

Commit

Permalink
vpn: Document that values in vpn-config-format.txt do not comprise wh…
Browse files Browse the repository at this point in the history
…itespace
  • Loading branch information
pmeerw authored and pfl committed Aug 28, 2013
1 parent 4c66d75 commit 92cf003
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions doc/vpn-config-format.txt
Expand Up @@ -6,26 +6,27 @@ vpnd will be looking for its configuration files at VPN_STORAGEDIR
which by default points to /var/lib/connman-vpn. Configuration file names
must not include other characters than letters or numbers and must have
a .config suffix. Those configuration files are text files with a simple
format and we typically have one file per provisioned network.
key-value pair format organized into sections. Values do not comprise leading
trailing whitespace. We typically have one file per provisioned network.

If the config file is removed, then vpnd tries to remove the
provisioned service. If individual service entry inside config is removed,
then the corresponding provisioned service is removed. If service
entry is changed, then corresponding service is removed and then
immediately re-provisioned.
provisioned service. If an individual service entry inside a config is removed,
then the corresponding provisioned service is removed. If a service
section is changed, then the corresponding service is removed and immediately
re-provisioned.


Global entry [global]
=====================
Global section [global]
=======================

These files can have an optional global entry describing the actual file.
The 2 allowed fields for that entry are:
These files can have an optional global section describing the actual file.
The two allowed fields for this section are:
- Name: Name of the network.
- Description: Description of the network.


Provider entry [provider_*]
===========================
Provider section [provider_*]
=============================

Each provisioned provider must start with the [provider_*] tag.
Replace * with an identifier unique to the config file.
Expand Down

0 comments on commit 92cf003

Please sign in to comment.