mod_couchdb/README.markdown
author Ben Smith <bens@effortlessis.com>
Tue, 14 May 2024 07:31:34 -0700
changeset 5912 dcea4b4c415d
parent 1807 4d73a1a6ba68
permissions -rw-r--r--
Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.

---
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