Skip to content

Commit f5a4b5e

Browse files
author
Joshua Hoblitt
committed
add GFMD highlighting to README
1 parent 7b4e426 commit f5a4b5e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -66,24 +66,30 @@ handles these values.
6666
For example, if you wanted to create the configuration option example below in
6767
the file `/etc/pure-ftpd/pure-ftpd.conf`:
6868

69+
```puppet
6970
ChrootEveryone yes
71+
```
7072

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

75+
```puppet
7376
class { 'pureftpd':
7477
config => {
7578
chrooteveryone => 'yes',
7679
}
7780
}
81+
```
7882

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

88+
```puppet
8489
LDAPConfigFile
8590
MySQLConfigFile
8691
PGSQLConfigFile
92+
```
8793

8894

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

119+
```puppet
113120
class { 'pureftpd': }
121+
```
114122

115123
### SELinux Support
116124

125+
```puppet
117126
class { 'pureftpd':
118127
use_selinux => true,
119128
}
129+
```
120130

121131
### Setting Configuration Options
122132

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

136+
```puppet
126137
class { 'pureftpd':
127138
config => {
128139
ipv4only => 'yes',
@@ -189,12 +200,14 @@ as a hash.
189200
pamauthentication => 'yes',
190201
},
191202
}
203+
```
192204

193205
### Enabling LDAP Authentication
194206

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

210+
```puppet
198211
class { 'pureftpd':
199212
config_ldap => {
200213
ldapserver => 'ldap.example.com',
@@ -212,12 +225,14 @@ parameter as a hash.
212225
ldapauthmethod => 'PASSWORD',
213226
},
214227
}
228+
```
215229

216230
### Enabling MYSQL Authentication
217231

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

235+
```puppet
221236
class { 'pureftpd':
222237
config_mysql => {
223238
mysqlserver => 'localhost'
@@ -243,12 +258,14 @@ class parameter as a hash.
243258
mysqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User="\L"'
244259
},
245260
}
261+
```
246262

247263
### Enabling PGSQL Authentication
248264

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

268+
```puppet
252269
class { 'pureftpd':
253270
config_pgsql => {
254271
pgsqlserver => 'localhost',
@@ -271,9 +288,11 @@ class parameter as a hash.
271288
pgsqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User=\'\L\'',
272289
},
273290
}
291+
```
274292

275293
### Pedantic Example
276294

295+
```puppet
277296
class { 'pureftpd':
278297
use_selinux => true,
279298
config => {
@@ -399,6 +418,7 @@ class parameter as a hash.
399418
pgsqlgetbandwidthdl => 'SELECT DLBandwidth FROM users WHERE User=\'\L\'',
400419
},
401420
}
421+
```
402422

403423

404424
Limitations

0 commit comments

Comments
 (0)