Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated documentation to conform with REFERENCE.md standard for forge #311

Merged
merged 2 commits into from
Oct 27, 2018
Merged

updated documentation to conform with REFERENCE.md standard for forge #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1df3f0
updated documentation to conform with REFERENCE.md standard for forge
danquack Oct 26, 2018
499953f
Add link to contributors list.
Dan33l Oct 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 4 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,57 +35,9 @@ Puppet module to manage OpenVPN servers and clients.

* Version >= 4.10.0

## Example

```puppet
# add a server instance
openvpn::server { 'winterthur':
country => 'CH',
province => 'ZH',
city => 'Winterthur',
organization => 'example.org',
email => '[email protected]',
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 10.200.200.51',
}

# a revoked client
openvpn::client { 'client3':
server => 'winterthur',
}
openvpn::revoke { 'client3':
server => 'winterthur',
}
## REFERENCES

# a server in client mode
file {
'/etc/openvpn/zurich/keys/ca.crt':
source => 'puppet:///path/to/ca.crt';
'/etc/openvpn/zurich/keys/zurich.crt':
source => 'puppet:///path/to/zurich.crt';
'/etc/openvpn/zurich/keys/zurich.key':
source => 'puppet:///path/to/zurich.key';
}
openvpn::server { 'zurich':
remote => [ 'mgmtnet3.nine.ch 1197', 'mgmtnet2.nine.ch 1197' ],
require => [ File['/etc/openvpn/zurich/keys/ca.crt'],
File['/etc/openvpn/zurich/keys/zurich.crt'],
File['/etc/openvpn/zurich/keys/zurich.key'] ];

}
```
Please see [REFERENCE](REFERENCE.md) for more details.

## Example with hiera

Expand Down Expand Up @@ -188,6 +140,7 @@ Details of these ciphers and their uses can be found in the documentation links
Note : TLS ciphers suites shipped with OSes ubuntu14.04 and debian8 are too old compared to our default values.
If the openvpn server is running on these OSes with clients on more modern OSes, you will probably have to use custom value for option `tls_cipher`.


## Contributions

This module is maintained by [Vox Pupuli](https://voxpupuli.org/). Voxpupuli
Expand All @@ -200,3 +153,4 @@ Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for more details.

* Raffael Schmid <[email protected]>
* Vox Pupuli Team
* List of contributors https://github.com/danquack/puppet-openvpn/graphs/contributors
Loading