Mercurial > prosody-modules

view mod_candy/README.markdown @ 1869:02390829df1a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_log_mark: Module that sends a line to the log once per minute
author Kim Alvefur <zash@zash.se>
date Tue, 22 Sep 2015 17:55:22 +0200
parents 991a5f74f848
children b3c124850d10
line wrap: on
line source

---
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:

    cd www_files
    curl -OL https://github.com/candy-chat/candy/releases/download/v2.0.0/candy-2.0.0.zip
    unzip www_files

After the module has been loaded, Candy will by default be reachable
from `http://example.com:5280/candy/`

Compatibility
=============

  ------- -------
  trunk   Works
  0.9     Works
  ------- -------