Software /
code /
prosody-modules
File
mod_candy/README.markdown @ 2323:35ae59a8196d
Add some documentation stubs
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 01 Oct 2016 20:34:43 +0200 |
parent | 1921:20ee32f620b9 |
child | 2341:52dd2a51dac8 |
line wrap: on
line source
--- 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][doc:installing\_modules] and [enable][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. mod\_candy will automatically configure Candy for username and password or anonymous login depending on the `authentication` option on the current VirtualHost. You then need to download Candy and unpack it into the www\_files directory, for example with curl: cd www_files curl -OL https://github.com/candy-chat/candy/releases/download/v2.0.0/candy-2.0.0.zip unzip candy-2.0.0.zip After the module has been loaded, Candy will by default be reachable from `http://example.com:5280/candy/` It may be helpful to also enable [mod\_default\_bookmarks] so that Candy users always have some room(s) to join, or it will show an empty screen. Compatibility ============= ------- ------- trunk Works 0.10 Works 0.9 Works ------- -------