view mod_couchdb/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 4d73a1a6ba68
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