summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaffael Schmid <raf@nine.ch>2013-05-16 09:40:45 +0200
committerRaffael Schmid <raf@nine.ch>2013-05-16 09:40:45 +0200
commit5035d233587d46cc7ea15786e59d83e637540707 (patch)
treefab3d19da9c810693d1b12a5ad43463187808a39
parentc4fba60f022282afd84b49de3052d55024c5daab (diff)
better documentation of the client specific configuration, fixes #12
-rw-r--r--manifests/client_specific_config.pp7
1 files changed, 5 insertions, 2 deletions
diff --git a/manifests/client_specific_config.pp b/manifests/client_specific_config.pp
index 1e64a7f..4287421 100644
--- a/manifests/client_specific_config.pp
+++ b/manifests/client_specific_config.pp
@@ -1,11 +1,14 @@
# == Define: openvpn::client_specific_config
#
# This define configures options which will be pushed by the server to a
-# specific client only.
+# specific client only. This feature is explained here:
# http://openvpn.net/index.php/open-source/documentation/howto.html#policy
#
# === Parameters
#
+# All the parameters are explained in the openvpn documentation:
+# http://openvpn.net/index.php/open-source/documentation/howto.html#policy
+#
# [*server*]
# String. Name of the corresponding openvpn endpoint
# Required
@@ -29,7 +32,7 @@
# 'vpn_client':
# server => 'contractors',
# iroute => ['10.0.1.0 255.255.255.0'],
-# ifconfig => '10.10.10.2 255.255.255.0',
+# ifconfig => '10.10.10.1 10.10.10.2',
# dhcp_options => ['DNS 8.8.8.8']
# }
#