prosody-modules: mod_storage_ejabberdsql_readonly/README.markdown@39c2824c2880 (annotated)

2227 c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	1	---
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	2	labels:
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	3	- 'Type-Storage'
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	4	- 'Stage-Alpha'
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	5	summary: Ejabberd SQL Read-only Storage Module
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	6	...
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	7
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	8	Introduction
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	9	============
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	10
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	11	This is a storage backend using Ejabberd’s SQL backend. It depends on
2230 9754eedbc4d1 mod_storage_ejabberdsql_readonly, mod_storage_muconference_readonly: Actually fix the links. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 2229 diff changeset	12	[LuaDBI][doc:depends#luadbi]
2227 c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	13
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	14	This module only works in read-only, and was made to be used by
2230 9754eedbc4d1 mod_storage_ejabberdsql_readonly, mod_storage_muconference_readonly: Actually fix the links. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 2229 diff changeset	15	[mod_migrate] to migrate from Ejabberd’s SQL backend.
2227 c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	16
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	17	Configuration
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	18	=============
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	19
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	20	Copy the module to the prosody modules/plugins directory.
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	21
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	22	In Prosody's configuration file, set:
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	23
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	24	storage = "ejabberdsql_readonly"
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	25
2229 4c3bcc56c51e mod_storage_ejabberdsql_readonly, mod_storage_muconference_readonly: Make links use the better syntax. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 2228 diff changeset	26	EjabberdSQL options are the same as the [SQL
2230 9754eedbc4d1 mod_storage_ejabberdsql_readonly, mod_storage_muconference_readonly: Actually fix the links. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 2229 diff changeset	27	ones][doc:modules:mod_storage_sql#usage].
2227 c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	28
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	29	Compatibility
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	30	=============
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	31
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	32	------- ---------------------------
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	33	trunk Works
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	34	0.10 Untested, but should work
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	35	0.9 Does not work
c3ad652cb71f mod_storage_ejabberdsql_readonly: Initial commit Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: diff changeset	36	------- ---------------------------

author	Matthew Wild <mwild1@gmail.com>
	Sat, 24 Sep 2022 09:25:46 +0100
changeset 5062	39c2824c2880
parent 2230	9754eedbc4d1
permissions	-rw-r--r--