Add the prosody module
[mirror/dsa-puppet.git] / 3rdparty / modules / prosody / README.md
1 ![Prosody](http://prosody.im/prosody.png)
2
3 [![Build Status](https://travis-ci.org/mayflower/puppet-prosody.svg?branch=master)](https://travis-ci.org/mayflower/puppet-prosody)
4
5 Puppet module for the [Prosody](http://prosody.im/) Jabber/XMPP server.
6
7 This module is a fork of rtyler/puppet-prosody because the upstream is dead. A
8 bunch of features were added and bugs were fixed.
9
10 If you want to use Prosody in a production environment, this is the Puppet
11 module to use.
12
13 ## Using
14
15 **Note:** This module has currently been tested on CentOS 7, Ubuntu and OpenBSD.
16
17 ```puppet
18 node myserver {
19
20   class { 'prosody':
21     user              => 'prosody',
22     group             => 'prosody',
23     community_modules => ['mod_auth_ldap'],
24     authentication    => 'ldap',
25     custom_options    => {
26                             'ldap_base'     => 'OU="accounts",DC="mydomain",DC="com"',
27                             'ldap_server'   => 'ldapserver1:636 ldapserver2:636',
28                             'ldap_rootdn'   => 'DN="prosody",OU="accounts",DC="mydomain",DC="com"',
29                             'ldap_password' => hiera(prosody-ldap-password),
30                             'ldap_scope'    => 'subtree',
31                             'ldap_tls'      => 'true',
32                           },
33   }
34
35   prosody::virtualhost {
36     'mydomain.com' :
37       ensure   => present,
38       ssl_key  => '/etc/ssl/key/mydomain.com.key',
39       ssl_cert => '/etc/ssl/crt/mydomain.com.crt',
40   }
41
42   prosody::user { 'foo':
43     host => 'mydomain.com',
44     pass => 'itsasecret',
45   }
46 }
47 ```
48
49 ## Support
50
51 Please file bugs and enhancement requests in the [GitHub issue tracker](https://github.com/mayflower/puppet-prosody/issues)