view mod_couchdb/README.markdown @ 5667:9bcd257dea4e

mod_http_health: Provide a health check HTTP endpoint Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which was simplified to produce this module.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 16:49:57 +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