Diff

mod_candy/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
child 1864:991a5f74f848
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_candy/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,34 @@
+---
+labels:
+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
+============
+
+[Install](http://prosody.im/doc/installing_modules) and
+[enable](http://prosody.im/doc/modules_enabled) 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
+  ------- -------