prosody-modules
26c68a5f432f
mod_candy/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

File

mod_candy/README.markdown @ 2425:26c68a5f432f

mod_statsd: Import bare_sessions from the prosody global, using it as a global directly is deprecated
author Kim Alvefur <zash@zash.se>
date Mon, 19 Dec 2016 07:51:23 +0100
parent 2341:52dd2a51dac8
child 2450:36ffe9d11132
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.2.0/candy-2.2.0.zip
    unzip candy-2.2.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
  ------- -------