annotate mod_candy.wiki @ 392:46960c6716ee

Clarify that Carbons only syncs online clients
author MWild1@gmail.com
date Mon, 15 Jul 2013 09:11:00 +0000
parents 7f8e913031b4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
328
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary Serve Candy from prosody
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 = Introduction =
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 This is a very simple demo module showing how to serve a BOSH-using web app from prosody.
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 = Installation =
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
329
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
8 [http://prosody.im/doc/installing_modules Install] and [http://prosody.im/doc/modules_enabled enable] the module just like any other. Note the included HTML file in the www_files directory, this directory needs to be in the same place as the module.
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
9
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
10 You then need to download Candy and unpack it into the www_files directory, for example with curl:
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
11
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
12 {{{
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
13 curl -L http://github.com/candy-chat/candy/tarball/master | tar xzfv - --strip-components=1
7f8e913031b4 changed mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents: 328
diff changeset
14 }}}
328
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 After the module has been loaded, Candy will by default be reachable from `http://example.com:5280/candy/`
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 = Compatibility =
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 ||trunk||Works||
1f308c72f72e added mod_candy.wiki
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 ||0.9||Works||