more comments and better formatting v1.0
authorRaffael Schmid <raffael@yux.ch>
Fri, 12 Aug 2011 08:28:13 +0000 (10:28 +0200)
committerRaffael Schmid <raffael@yux.ch>
Fri, 12 Aug 2011 08:28:13 +0000 (10:28 +0200)
README

diff --git a/README b/README
index 5704120..59d80a8 100644 (file)
--- a/README
+++ b/README
@@ -4,6 +4,7 @@ OpenVPN Puppet module
 Example Usage:
 --------------
 
+# add a server instance
 openvpn::server {
     "server1":
         country      => "CH",
@@ -13,73 +14,74 @@ openvpn::server {
         email        => "root@example.org";
 }
 
-    openvpn::option {
-        "dev server1":
-            key    => "dev",
-            value  => "tun0",
-            server => "server1";
-        "script-security server1":
-            key    => "script-security",
-            value  => "3",
-            server => "server1";
-        "daemon server1":
-            key    => "daemon",
-            server => "server1";
-        "keepalive server1":
-            key    => "keepalive",
-            value  => "10 60",
-            server => "server1";
-        "ping-timer-rem server1":
-            key    => "ping-timer-rem",
-            server => "server1";
-        "persist-tun server1":
-            key    => "persist-tun",
-            server => "server1";
-        "persist-key server1":
-            key    => "persist-key",
-            server => "server1";
-        "proto server1":
-            key    => "proto",
-            value  => "tcp-server",
-            server => "server1";
-        "cipher server1":
-            key    => "cipher",
-            value  => "BF-CBC",
-            server => "server1";
-        "local server1":
-            key    => "local",
-            value  => $ipaddress,
-            server => "server1";
-        "tls-server server1":
-            key    => "tls-server",
-            server => "server1";
-        "server server1":
-            key    => "server",
-            value  => "10.10.10.0 255.255.255.0",
-            server => "server1";
-        "client-config-dir server1":
-            key    => "client-config-dir",
-            value  => "/etc/openvpn/server1/client-configs",
-            server => "server1";
-        "lport server1":
-            key    => "lport",
-            value  => "1194",
-            server => "server1";
-        "management server1":
-            key    => "management",
-            value  => "/var/run/openvpn-server1.sock unix",
-            server => "server1";
-        "comp-lzo server1":
-            key    => "comp-lzo",
-            server => "server1";
-        "topology server1":
-            key    => "topology",
-            value  => "subnet",
-            server => "server1";
-        "client-to-client server1":
-            key    => "client-to-client",
-            server => "server1";
-    }
+# configure server
+openvpn::option {
+    "dev server1":
+        key    => "dev",
+        value  => "tun0",
+        server => "server1";
+    "script-security server1":
+        key    => "script-security",
+        value  => "3",
+        server => "server1";
+    "daemon server1":
+        key    => "daemon",
+        server => "server1";
+    "keepalive server1":
+        key    => "keepalive",
+        value  => "10 60",
+        server => "server1";
+    "ping-timer-rem server1":
+        key    => "ping-timer-rem",
+        server => "server1";
+    "persist-tun server1":
+        key    => "persist-tun",
+        server => "server1";
+    "persist-key server1":
+        key    => "persist-key",
+        server => "server1";
+    "proto server1":
+        key    => "proto",
+        value  => "tcp-server",
+        server => "server1";
+    "cipher server1":
+        key    => "cipher",
+        value  => "BF-CBC",
+        server => "server1";
+    "local server1":
+        key    => "local",
+        value  => $ipaddress,
+        server => "server1";
+    "tls-server server1":
+        key    => "tls-server",
+        server => "server1";
+    "server server1":
+        key    => "server",
+        value  => "10.10.10.0 255.255.255.0",
+        server => "server1";
+    "client-config-dir server1":
+        key    => "client-config-dir",
+        value  => "/etc/openvpn/server1/client-configs",
+        server => "server1";
+    "lport server1":
+        key    => "lport",
+        value  => "1194",
+        server => "server1";
+    "management server1":
+        key    => "management",
+        value  => "/var/run/openvpn-server1.sock unix",
+        server => "server1";
+    "comp-lzo server1":
+        key    => "comp-lzo",
+        server => "server1";
+    "topology server1":
+        key    => "topology",
+        value  => "subnet",
+        server => "server1";
+    "client-to-client server1":
+        key    => "client-to-client",
+        server => "server1";
+}
 
 
     # define clients