annotate mod_couchdb.wiki @ 155:7aa92b889524

Expand introduction and note that this plugin is not needed for 0.8+
author MWild1
date Sat, 16 Oct 2010 18:47:19 +0000
parents 33147609a765
children 3b8d6c25756f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
142
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
1 #summary A CouchDB backend for Prosody
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
2 #labels Stage-Alpha
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
3
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
4 = Introduction =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
5
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6 This is an experimental Prosody backend for CouchDB.
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8 = Configuration =
146
33147609a765 mod_couchdb: Updated docs to reflect the new storage system (simpler now).
Waqas Hussain <waqas20@gmail.com>
parents: 142
diff changeset
9 In your config file, under the relevant host, add:
142
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
10 {{{
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
11 datastore = "couchdb";
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
12 couchdb_url = "http://127.0.0.1:5984/database-name";
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13 }}}
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15 = Compatibility =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17 Only works with trunk. As the trunk API is in flux, update this module as well when you update trunk.
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19 = Quirks =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21 This implementation is a work in progress.
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23 * The data stored in couchdb is limited to: account data, rosters, private XML and vCards