Mercurial > prosody-wiki

annotate mod_couchdb.wiki @ 142:d3dd8fdcae1d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_couchdb: Basic docs.
author Waqas Hussain <waqas20@gmail.com>
date Sat, 10 Jul 2010 01:52:36 +0500
parents
children 33147609a765
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 =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9 In your config file, in the global section add:
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 In your config file, in the modules_enabled list, add "storage" as the first module:
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15 {{{
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16 modules_enabled = {
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17 "storage";
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 }
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
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22 = Compatibility =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24 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
25
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
26 = Quirks =
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
27
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
28 This implementation is a work in progress.
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
29
d3dd8fdcae1d mod_couchdb: Basic docs.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
30 * The data stored in couchdb is limited to: account data, rosters, private XML and vCards