Skip to content

Commit

Permalink
add GFMD highlighting to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua Hoblitt committed Sep 22, 2013
1 parent 7b4e426 commit f5a4b5e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,24 +66,30 @@ handles these values.
For example, if you wanted to create the configuration option example below in
the file `/etc/pure-ftpd/pure-ftpd.conf`:

```puppet
ChrootEveryone yes
```

You would declare it like this to the `pureftpd` module:

```puppet
class { 'pureftpd':
config => {
chrooteveryone => 'yes',
}
}
```

The notable exception to that rule is for these `pure-ftpd.conf` options, which
should not need to be manually declared. Passing a hash of configuration
options to the appropriate class parameter automatically defines these options
for you.

```puppet
LDAPConfigFile
MySQLConfigFile
PGSQLConfigFile
```


### `pure-ftpd` Options
Expand All @@ -110,19 +116,24 @@ examples:
Install the `pure-ftpd` package with an empty `pure-ftpd.conf` config file
(accepting all defaults) and start `pure-ftpd` as a stand alone daemon.

```puppet
class { 'pureftpd': }
```

### SELinux Support

```puppet
class { 'pureftpd':
use_selinux => true,
}
```

### Setting Configuration Options

Options for `pure-ftpd.conf` should be passed into the `config` class parameter
as a hash.

```puppet
class { 'pureftpd':
config => {
ipv4only => 'yes',
Expand Down Expand Up @@ -189,12 +200,14 @@ as a hash.
pamauthentication => 'yes',
},
}
```

### Enabling LDAP Authentication

Options for `pureftpd-ldap.conf` should be passed into the `config_ldap` class
parameter as a hash.

```puppet
class { 'pureftpd':
config_ldap => {
ldapserver => 'ldap.example.com',
Expand All @@ -212,12 +225,14 @@ parameter as a hash.
ldapauthmethod => 'PASSWORD',
},
}
```

### Enabling MYSQL Authentication

Options for `pureftpd-mysql.conf` should be passed into the `config_mysql`
class parameter as a hash.

```puppet
class { 'pureftpd':
config_mysql => {
mysqlserver => 'localhost'
Expand All @@ -243,12 +258,14 @@ class parameter as a hash.
mysqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User="\L"'
},
}
```

### Enabling PGSQL Authentication

Options for `pureftpd-pgsql.conf` should be passed into the `config_pgsql`
class parameter as a hash.

```puppet
class { 'pureftpd':
config_pgsql => {
pgsqlserver => 'localhost',
Expand All @@ -271,9 +288,11 @@ class parameter as a hash.
pgsqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User=\'\L\'',
},
}
```

### Pedantic Example

```puppet
class { 'pureftpd':
use_selinux => true,
config => {
Expand Down Expand Up @@ -399,6 +418,7 @@ class parameter as a hash.
pgsqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User=\'\L\'',
},
}
```


Limitations
Expand Down

0 comments on commit f5a4b5e

Please sign in to comment.