Changeset - 7e22669e0bf6
[Not reviewed]
0 2 0
Branko Majic (branko) - 2 years ago 2023-11-19 11:25:53
branko@majic.rs
MAR-181: Add release notes and update role reference documentation for xmpp_server role.
2 files changed with 23 insertions and 10 deletions:
0 comments (0 inline, 0 general)
docs/releasenotes.rst
Show inline comments
 
Release notes
 
=============
 

	
 

	
 
x.y.z
 
-----
 

	
 
Dropped support for Debian 9 (Jessie), alongside changes required to
 
run applications using Debian-only repositories.
 

	
 
**Breaking changes:**
 

	
 
* ``xmpp_server`` role
 

	
 
  * Parameter ``xmpp_prosody_package`` has been dropped.
 

	
 
**New features/improvements**
 

	
 
* ``xmpp_server`` role
 

	
 
  * Drop dependency on the external (Prosody) package
 
    repository. Install everything using official Debian
 
    repositories. This should help avoid future issues with Prosody
 
    project removing older versions of packages or dropping entire
 
    repository archives for older Debian releases.
 

	
 

	
 
6.0.0
 
-----
 

	
 
Added support for Debian 10 (Buster), alongside a couple of minor
 
changes and features/improvements.
 

	
docs/rolereference.rst
Show inline comments
 
@@ -840,15 +840,12 @@ XMPP Server
 

	
 
The ``xmpp_server`` role can be used for setting-up Prosody, an XMPP server, on
 
destination machine.
 

	
 
The role implements the following:
 

	
 
* Sets-up the Prosody apt repository.
 
* Sets-up the Debian backports repository and pins the ``lua-ldap``
 
  package to it (needed for Lua 5.2 support with Prosody 0.11).
 
* Deploys XMPP TLS private key and certificate.
 

	
 
  .. warning::
 
     The issued certificate must have multiple FQDNs listed as subject
 
     alternative names (DNS names) for each configured domain:
 

	
 
@@ -945,19 +942,12 @@ Parameters
 
  Password used for authenticating to the LDAP server.
 

	
 
**xmpp_ldap_server** (string, mandatory)
 
  Fully qualified domain name, hostname, or IP address of the LDAP server used
 
  for user authentication and listing.
 

	
 
**xmpp_prosody_package** (string, optional, ``prosody-0.11``)
 
  Name of Prosody package from the Prosody repositories to
 
  install. This makes it possible to easily test the latest Prosody or
 
  to switch to a different nightly build. It should be noted that
 
  only the default version is getting properly tested. Prosody
 
  versions lower than ``0.10.x`` are not supported.
 

	
 
**xmpp_server_archive_expiration** (string, optional, ``never``)
 
  Expiration period for messages stored server-side using `XEP-0313:
 
  Message Archive Management
 
  <https://xmpp.org/extensions/xep-0313.html>`_. The value should be
 
  compatible with `Prosody mod_mam
 
  <https://prosody.im/doc/modules/mod_mam>`_ configuration option
0 comments (0 inline, 0 general)