From da37dd95c39f3f100020164473eed53a317fb53f Mon Sep 17 00:00:00 2001
From: Micah <micah@leap.se>
Date: Tue, 12 Jul 2016 16:45:26 -0400
Subject: git subrepo clone https://leap.se/git/puppet_openvpn
 puppet/modules/openvpn

subrepo:
  subdir:   "puppet/modules/openvpn"
  merged:   "26d4edc"
upstream:
  origin:   "https://leap.se/git/puppet_openvpn"
  branch:   "master"
  commit:   "26d4edc"
git-subrepo:
  version:  "0.3.0"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "1e79595"

Change-Id: I596766ccfb806b3ca2d1c755c4e24c5ad3d997f9
---
 puppet/modules/openvpn/Readme.markdown | 54 ++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 puppet/modules/openvpn/Readme.markdown

(limited to 'puppet/modules/openvpn/Readme.markdown')

diff --git a/puppet/modules/openvpn/Readme.markdown b/puppet/modules/openvpn/Readme.markdown
new file mode 100644
index 00000000..6bcf49ea
--- /dev/null
+++ b/puppet/modules/openvpn/Readme.markdown
@@ -0,0 +1,54 @@
+# OpenVPN Puppet module
+
+Puppet module to manage OpenVPN servers
+
+## Features:
+
+* Client-specific rules and access policies
+* Generated client configurations and SSL-Certificates
+* Downloadable client configurations and SSL-Certificates for easy client configuration
+* Support for multiple server instances
+
+Tested on Ubuntu Precise Pangolin, CentOS 6, RedHat 6.
+
+
+## Dependencies
+  - [puppet-concat](https://github.com/ripienaar/puppet-concat)
+
+
+## Example
+
+```puppet
+  # add a server instance
+  openvpn::server { 'winterthur':
+    country      => 'CH',
+    province     => 'ZH',
+    city         => 'Winterthur',
+    organization => 'example.org',
+    email        => 'root@example.org',
+    server       => '10.200.200.0 255.255.255.0'
+  }
+
+  # define clients
+  openvpn::client { 'client1':
+    server => 'winterthur'
+  }
+  openvpn::client { 'client2':
+    server   => 'winterthur'
+  }
+
+  openvpn::client_specific_config { 'client1':
+    server => 'winterthur',
+    ifconfig => '10.200.200.50 255.255.255.0'
+  }
+```
+
+Don't forget the [sysctl](https://github.com/luxflux/puppet-sysctl) directive ```net.ipv4.ip_forward```!
+
+
+# Contributors
+
+These fine folks helped to get this far with this module:
+* [@jlambert121](https://github.com/jlambert121)
+* [@jlk](https://github.com/jlk)
+* [@elisiano](https://github.com/elisiano)
-- 
cgit v1.2.3