view mod_couchdb/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents fe081789f7b5
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
- 'Type-Storage'
summary: A CouchDB backend for Prosody
...

***Note:** This module needs updating to the 0.8 storage module API.*

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

This is an experimental Prosody backend for CouchDB.

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

In your config file, under the relevant host, add:

    datastore = "couchdb";
    couchdb_url = "http://127.0.0.1:5984/database-name";

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

This module was developed as a prototype during development of the
storage provider API in Prosody 0.8. The final storage provider API is
different, so this module needs updates to work.

Quirks
======

This implementation is a work in progress.

-   The data stored in couchdb is limited to: account data, rosters,
    private XML and vCards