Mercurial > prosody-modules
annotate mod_candy/README.markdown @ 2494:d300ae5dba87
mod_smacks: Fix some bugs with smacks-ack-delayed event triggering.
The old code had several flaws which are addressed here.
First of all this fixes the if statement guarding the event generation
There where some timing glitches addressed by this commit as well.
| author | tmolitor <thilo@eightysoft.de> |
|---|---|
| date | Sun, 12 Feb 2017 21:23:22 +0100 |
| parents | 7d86018a6394 |
| children |
| 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 | 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 | 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 | 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 | 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 | 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 |
|
2341
52dd2a51dac8
mod_candy: Update to point to Candy v2.2.0
Kim Alvefur <zash@zash.se>
parents:
1921
diff
changeset
|
27 curl -OL https://github.com/candy-chat/candy/releases/download/v2.2.0/candy-2.2.0.zip |
|
52dd2a51dac8
mod_candy: Update to point to Candy v2.2.0
Kim Alvefur <zash@zash.se>
parents:
1921
diff
changeset
|
28 unzip candy-2.2.0.zip |
| 1782 | 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 |
|
2452
7d86018a6394
mod_candy/README: Link to HTTP configuration info
Kim Alvefur <zash@zash.se>
parents:
2451
diff
changeset
|
31 from `http://example.com:5280/candy/`. See [HTTP configuration][doc:http] |
|
7d86018a6394
mod_candy/README: Link to HTTP configuration info
Kim Alvefur <zash@zash.se>
parents:
2451
diff
changeset
|
32 for more. |
| 1782 | 33 |
|
2450
36ffe9d11132
mod_candy: Add config option for a list of rooms to join
Kim Alvefur <zash@zash.se>
parents:
2341
diff
changeset
|
34 You can configure what rooms to join using either `candy_rooms` (an |
|
36ffe9d11132
mod_candy: Add config option for a list of rooms to join
Kim Alvefur <zash@zash.se>
parents:
2341
diff
changeset
|
35 array) or [mod\_default\_bookmarks]. By default, Candy will attempt to |
|
2451
56bab95e57f0
mod_candy: If no room list is set, try to find a MUC domain and guess a room name of 'candy'
Kim Alvefur <zash@zash.se>
parents:
2450
diff
changeset
|
36 join rooms that the current user has bookmarked. |
|
56bab95e57f0
mod_candy: If no room list is set, try to find a MUC domain and guess a room name of 'candy'
Kim Alvefur <zash@zash.se>
parents:
2450
diff
changeset
|
37 If `candy_rooms` is not set, mod\_candy will attempt to find a MUC |
|
56bab95e57f0
mod_candy: If no room list is set, try to find a MUC domain and guess a room name of 'candy'
Kim Alvefur <zash@zash.se>
parents:
2450
diff
changeset
|
38 component and join a room called "candy" there. If there are no rooms |
|
2450
36ffe9d11132
mod_candy: Add config option for a list of rooms to join
Kim Alvefur <zash@zash.se>
parents:
2341
diff
changeset
|
39 to join, then Candy will show an emtpy screen. |
|
1921
20ee32f620b9
mod_candy/README: Mention mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
1920
diff
changeset
|
40 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
41 Compatibility |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
42 ============= |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
43 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
44 ------- ------- |
|
1919
f61798ecaf77
mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents:
1918
diff
changeset
|
45 trunk Works |
|
f61798ecaf77
mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents:
1918
diff
changeset
|
46 0.10 Works |
|
f61798ecaf77
mod_candy/README: Update compatibility table
Kim Alvefur <zash@zash.se>
parents:
1918
diff
changeset
|
47 0.9 Works |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
48 ------- ------- |