Mercurial > prosody-modules

annotate mod_candy/README.markdown @ 1920:4310a104c498

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_candy/README: Describe how it decides login method
author Kim Alvefur <zash@zash.se>
date Thu, 22 Oct 2015 15:55:43 +0200
parents f61798ecaf77
children 20ee32f620b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 summary: Serve Candy from prosody
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
3 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
5 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
6 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
8 This is a very simple demo module showing how to serve a BOSH-using web
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
9 app from prosody.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
11 Installation
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
12 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
1918
c6db9d3dcff7 mod_candy/README: Compact links
Kim Alvefur <zash@zash.se>
parents: 1917
diff changeset
14 [Install][doc:installing\_modules] and [enable][doc:modules\_enabled]
c6db9d3dcff7 mod_candy/README: Compact links
Kim Alvefur <zash@zash.se>
parents: 1917
diff changeset
15 the module just like any other. Note the included HTML file in the
c6db9d3dcff7 mod_candy/README: Compact links
Kim Alvefur <zash@zash.se>
parents: 1917
diff changeset
16 www\_files directory, this directory needs to be in the same place as
c6db9d3dcff7 mod_candy/README: Compact links
Kim Alvefur <zash@zash.se>
parents: 1917
diff changeset
17 the module.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
1920
4310a104c498 mod_candy/README: Describe how it decides login method
Kim Alvefur <zash@zash.se>
parents: 1919
diff changeset
19 mod\_candy will automatically configure Candy for username and password
4310a104c498 mod_candy/README: Describe how it decides login method
Kim Alvefur <zash@zash.se>
parents: 1919
diff changeset
20 or anonymous login depending on the `authentication` option on the
4310a104c498 mod_candy/README: Describe how it decides login method
Kim Alvefur <zash@zash.se>
parents: 1919
diff changeset
21 current VirtualHost.
4310a104c498 mod_candy/README: Describe how it decides login method
Kim Alvefur <zash@zash.se>
parents: 1919
diff changeset
22
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
23 You then need to download Candy and unpack it into the www\_files
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
24 directory, for example with curl:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
25
1864
991a5f74f848 mod_candy: Update to work with a stable release instead of git (which no longer works)
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
26 cd www_files
991a5f74f848 mod_candy: Update to work with a stable release instead of git (which no longer works)
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
27 curl -OL https://github.com/candy-chat/candy/releases/download/v2.0.0/candy-2.0.0.zip
1917
b3c124850d10 mod_candy/README: Correct command for unzipping Candy release
Kim Alvefur <zash@zash.se>
parents: 1864
diff changeset
28 unzip candy-2.0.0.zip
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
30 After the module has been loaded, Candy will by default be reachable
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
31 from `http://example.com:5280/candy/`
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
33 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
34 =============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
35
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
36 ------- -------
1919
f61798ecaf77 mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents: 1918
diff changeset
37 trunk Works
f61798ecaf77 mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents: 1918
diff changeset
38 0.10 Works
f61798ecaf77 mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents: 1918
diff changeset
39 0.9 Works
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
40 ------- -------