diff mod_candy/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_candy/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,20 @@
+#summary Serve Candy from prosody
+
+= Introduction =
+This is a very simple demo module showing how to serve a BOSH-using web app from prosody.
+
+= Installation =
+
+[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.
+
+You then need to download Candy and unpack it into the www_files directory, for example with curl:
+
+{{{
+curl -L http://github.com/candy-chat/candy/tarball/master | tar xzfv - --strip-components=1
+}}}
+
+After the module has been loaded, Candy will by default be reachable from `http://example.com:5280/candy/`
+
+= Compatibility =
+||trunk||Works||
+||0.9||Works||