view mod_storage_ejabberdsql_readonly/README.markdown @ 4983:7c77058a1ac5

mod_compat_roles: New module providing compat shim for trunk's new role API The new role API is translated to is_admin() calls on older versions. On newer versions (which have the role API) this module does nothing. It allows modules to drop their use of is_admin() (which is not available in trunk) and switch to the new role API, while remaining compatible with previous Prosody versions.
author Matthew Wild <mwild1@gmail.com>
date Thu, 11 Aug 2022 17:49:33 +0100
parents 9754eedbc4d1
children
line wrap: on
line source

---
labels:
- 'Type-Storage'
- 'Stage-Alpha'
summary: Ejabberd SQL Read-only Storage Module
...

Introduction
============

This is a storage backend using Ejabberd’s SQL backend. It depends on
[LuaDBI][doc:depends#luadbi]

This module only works in read-only, and was made to be used by
[mod_migrate] to migrate from Ejabberd’s SQL backend.

Configuration
=============

Copy the module to the prosody modules/plugins directory.

In Prosody's configuration file, set:

    storage = "ejabberdsql_readonly"

EjabberdSQL options are the same as the [SQL
ones][doc:modules:mod_storage_sql#usage].

Compatibility
=============

  ------- ---------------------------
  trunk   Works
  0.10    Untested, but should work
  0.9     Does not work
  ------- ---------------------------