freifunk/puppet-ff_gw
0
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

add usage doc

Browse source
This commit is contained in:
Martin Schuette 2014-04-23 17:30:01 +02:00
parent c17cd98a0b
commit 22b5b16db4
1 changed files with 38 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -16,11 +16,36 @@ design pattern.
Install as a puppet module, then include with node-specific parameters. Install as a puppet module, then include with node-specific parameters.
### Dependencies
Install Puppet and some required modules with:
```
apt-get install puppet
puppet module install puppetlabs-stdlib
puppet module install puppetlabs-apt
puppet module install puppetlabs-vcsrepo
puppet module install saz-sudo
puppet module install torrancew-account
```
Then add this module (which is not in the puppet forge, so it has to be
downloaded manually):
```
cd /etc/puppet/modules
git clone https://github.com/freifunkhamburg/puppet-ff_gw.git ff_gw
```
### Parameters
Now include the module in your manifest and provide all parameters.
Basically there are three kinds of parameters: user accounts (optional if you Basically there are three kinds of parameters: user accounts (optional if you
do manual user management), network config (has to be in sync with the wiki do manual user management), network config (has to be in sync with the wiki
page), and credentials for fastd and openvpn. page), and credentials for fastd and openvpn.
Example puppet code:
Example puppet code (save e.g. as `/etc/puppet/gw.pp`):
``` ```
class { 'ff_gw': class { 'ff_gw':
@ -54,3 +79,15 @@ MIIE ...
} }
``` ```
### Run Puppet
To apply the puppet manifest (e.g. saved as `gw.pp`) run:
```
puppet apply --verbose gw.pp
```
The verbose flag is optional and shows all changes.
To be even more catious you can also add the `--noop` flag to only show changes
but not apply them.