diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 3d358ae224a4b5a82c996f844b699a4e7c0f127c..cc3e630575bcc86da0455df399bb7437c583a05b 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -561,3 +561,31 @@ Parameters **prosody_ldap_base** (string, mandatory) Base DN under which the lists of users available on the Prosody should be looked-up. + + +Examples +~~~~~~~~ + +Here is an example configuration for setting-up XMPP server using Prosody: + +.. code-block:: yaml + + --- + + prosody_administrators: + - john.doe@example.com + # These are default key and certificate that generated during Prosody + # installation. + prosody_tls_key: /etc/prosody/certs/localhost.key + prosody_tls_certificate: /etc/prosody/certs/localhost.crt + prosody_domains: + - example.com + prosody_ldap_server: ldap.example.com + prosody_ldap_bind_dn: cn=xmpp,ou=services,dc=example,dc=com + prosody_ldap_password: xmpp + # This would require that the memberof overlay is available on LDAP server + # side. + prosody_ldap_filter: '(&(memberOf=cn=xmpp,ou=groups,dc=example,dc=com)(mail=$user@$host))' + prosody_ldap_scope: "onelevel" + prosody_ldap_tls: "true" + prosody_ldap_base: "ou=people,dc=example,dc=com"