Browse code

import wiki from fossil

devnewton authored on 05/04/2015 at 19:24:13
Showing 4 changed files
1 1
deleted file mode 100644
... ...
@@ -1,192 +0,0 @@
1
-MUCkl tribune 
2
-=============
3
-
4
-A special version of MUCkl with tribune features.
5
-
6
-What is MUCkl ?
7
-===============
8
-
9
-  MUCkl is a web based groupchat application with focus on ease of
10
-  installation and usage. As a user you just need to enter your
11
-  desired nickname and start chatting.
12
-  MUCkl doesn't need Perl, PHP or MySQL at the server side nor Java at
13
-  the client side. It's just plain HTML/JavaScript.
14
-
15
-  MUCkl uses [1]Jabber technology to handle all communication. It
16
-  let's you connect to any predefined [2]MUC-based chat room.
17
-
18
-  This version 
19
-
20
-
21
-  [1] http://www.jabber.org
22
-  [2] http://www.jabber.org/jeps/jep-0045.html
23
-
24
-What is a tribune?
25
-==================
26
-
27
-A tribune is a type of chat popular in some obscure french websites.
28
-
29
-It adds to traditionnal chat some usefull features:
30
-
31
-- norloge: a conversation flow highlightning tool.
32
-- totoz: a way to insert stupid images.
33
-
34
-Supported browsers and plattforms
35
-=================================
36
-
37
-  As of this release MUCkl has not been tested a lot. It should work
38
-  with any version of Internet Explorer since version 5 and all recent
39
-  versions of Gecko ("Mozilla") based browsers. 
40
-
41
-  Feedback on this is very welcome!
42
-
43
-
44
-Prerequisites
45
-=============
46
-
47
-  In order to use MUCkl you need to have access to an [3]HTTP Polling
48
-  or [4]HTTP Binding service for Jabber. These allow you to connect to
49
-  a Jabber server using the HTTP protocol rather than raw TCP/IP
50
-  sockets. There are Jabber servers that have built-in HTTP Polling
51
-  support like [5]ejabberd or some of the commercial ones.
52
-
53
-  There are also some standalone implementations of HTTP Polling
54
-  available like [6]tonneru and [7]webjah. Both allow you to connect
55
-  to any jabber server. Latest versions of punjab have built in
56
-  support for HTTP Polling and HTTP Binding. See [8]punjab's website for
57
-  details.
58
-
59
-  Additionally you need a web server of your choice capable of doing
60
-  address rewriting (at least if you're using an HTTP proxy service
61
-  that is not local to your web server).
62
-
63
-  So to sum it up: If you don't know of any public jabber server which
64
-  offers HTTP Polling as a free service, you will have to install your
65
-  own jabber server or one of the HTTP Polling components mentioned
66
-  above. If you've got the choice use ejabberd as it's the most
67
-  reliable solution available at the moment at no cost.
68
-
69
-  [3] http://www.jabber.org/jeps/jep-0025.html
70
-  [4] http://www.jabber.org/jeps/jep-0124.html
71
-  [5] http://ejabberd.jabberstudio.org
72
-  [6] http://tonneru.tanoshi.net/
73
-  [7] http://www.gonzo.kiev.ua/projects/jabber/index.html#webjah
74
-  [8] http://punjab.sourceforge.net/
75
-
76
-
77
-Installation
78
-============
79
-
80
-  1) Unpacking
81
-
82
-     Unpack MUCkl into a directory accessible by your web server.
83
-
84
-  2) Configure Web Server
85
-
86
-     This is the trickiest part of the setup as it depends on which
87
-     HTTP Polling service you've chosen. It requires some knowledge of
88
-     apache configuration as well as some understanding of what HTTP
89
-     Polling is.
90
-
91
-     First let me explain, what we need to do and why: Due to security
92
-     considerations most browsers don't allow JavaScript to access any
93
-     data outside the domain it has been loaded from. Gecko based
94
-     browsers are even more restrictive in this as they don't allow
95
-     them to access data on a different port either.
96
-
97
-     So say, the HTTP Polling service we plan to use for MUCkl is
98
-     located at http://jabber.somedomain.com:5280/http-poll/ (a
99
-     typical ejabberd URI). MUCkl itself is served at
100
-     http://www.mydomain.com/MUCkl/. Now we have to make sure that our
101
-     installation of MUCkl can access the HTTP Polling service by
102
-     calling some local URI like
103
-     http://www.mydomain.com/http-poll/. So we have to
104
-     setup a rewrite rule which redirects requests on
105
-     http://www.mydomain.com/MUCkl/http-poll/ to
106
-     http://jabber.somedomain.com:5280/http-poll/.
107
-
108
-     Using apache this can be achieved by the following steps:
109
-
110
-     * Make sure that mod_rewrite and mod_proxy (additionally
111
-       mod_proxy_http for apache2) are loaded.
112
-
113
-     * Define a rewrite rule for your MUCkl installation directory (Step 1). 
114
-       E.g. create an .htaccess file within your MUCkl installation
115
-       directory like the following:
116
-
117
-       <IfModule mod_rewrite.c>
118
-         RewriteEngine On
119
-         RewriteRule http-poll/ http://jabber.somedomain.com:5280/http-poll/ [P]
120
-       </IfModule>
121
-
122
-
123
-  3) Setup Jabber Account
124
-
125
-     In order to complete Step 3 and 4 you will need a native Jabber
126
-     client that supports registration of new accounts and the MUC
127
-     protocol for configuration of your chat room. My tip: Use Exodus
128
-     on Windows, tkabber on Linux.
129
-
130
-     Now you need to create a new jabber account. Make sure that you
131
-     can connect to it by way of the chosen HTTP Polling service. So
132
-     most probably using the example above you would create it on
133
-     jabber.somedomain.com.
134
-
135
-     Everybody using your installation of MUCkl will use this account
136
-     data to enter the Jabber network and join your chat room.
137
-
138
-  4) Setup Chat Room
139
-
140
-     Now use some different Jabber account which will be the owner of
141
-     your desired chat room. Enter your room or create a new one and
142
-     configure it to suit your needs (e.g. don't make it
143
-     private/invite only/password protected, as MUCkl doesn't support
144
-     these kind of things).
145
-
146
-  5) Configure MUCkl
147
-
148
-     Now that we have all necessary data at hand we finally may edit
149
-     config.js (located in MUCkl's installation directory). For
150
-     detailed information on how to do this refer to the comments
151
-     given in this file!
152
-
153
-     When done, fire up your prefered browser (see above! ;-)) and
154
-     login to MUCkl.
155
-
156
-
157
-Further Information/Reading
158
-===========================
159
-
160
-  MUCkl is a stripped down version of [9]JWChat - a web based Jabber
161
-  client. As such it uses the [10]JSJaC library for communication with
162
-  the Jabber network. JSJaC allows you to connect to Jabber servers
163
-  using either [11]HTTP Polling or [12]HTTP Binding. Groupchat
164
-  functionality is realized as an implementation of the [13]Multi User
165
-  Conference Protocol [MUC].
166
-
167
-
168
-  [9] http://jwchat.sourceforge.net
169
-  [10] http://jsjac.jabberstudio.org
170
-  [11] http://www.jabber.org/jeps/jep-0025.html
171
-  [12] http://www.jabber.org/jeps/jep-0124.html
172
-  [13] http://www.jabber.org/jeps/jep-0045.html
173
-
174
-
175
-Disclaimer
176
-==========
177
-
178
-  This program is free software; you can redistribute it and/or modify
179
-  it under the terms of the GNU General Public License as published by
180
-  the Free Software Foundation; either version 2 of the License, or
181
-  (at your option) any later version.
182
-
183
-  This program is distributed in the hope that it will be useful, but
184
-  WITHOUT ANY WARRANTY; without even the implied warranty of
185
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
186
-  General Public License for more details.
187
-
188
-  You should have received a copy of the GNU General Public License
189
-  along with this program; if not, write to the Free Software
190
-  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
191
-  USA
192
-
193 1
new file mode 100644
... ...
@@ -0,0 +1,199 @@
0
+MUCkl tribune 
1
+=============
2
+
3
+A special version of MUCkl with tribune features.
4
+
5
+What is MUCkl ?
6
+===============
7
+
8
+  MUCkl is a web based groupchat application with focus on ease of
9
+  installation and usage. As a user you just need to enter your
10
+  desired nickname and start chatting.
11
+  MUCkl doesn't need Perl, PHP or MySQL at the server side nor Java at
12
+  the client side. It's just plain HTML/JavaScript.
13
+
14
+  MUCkl uses [1]Jabber technology to handle all communication. It
15
+  let's you connect to any predefined [2]MUC-based chat room.
16
+
17
+  This version 
18
+
19
+
20
+  [1] http://www.jabber.org
21
+  [2] http://www.jabber.org/jeps/jep-0045.html
22
+
23
+What is a tribune?
24
+==================
25
+
26
+A tribune is a type of chat popular in some obscure french websites.
27
+
28
+It adds to traditionnal chat some usefull features:
29
+
30
+- norloge: a conversation flow highlightning tool.
31
+- totoz: a way to insert stupid images.
32
+
33
+Screenshots
34
+===========
35
+
36
+![norloge](screenshots/norloge.png)
37
+
38
+![totoz](screenshots/totoz.png)
39
+
40
+Supported browsers and plattforms
41
+=================================
42
+
43
+  As of this release MUCkl has not been tested a lot. It should work
44
+  with any version of Internet Explorer since version 5 and all recent
45
+  versions of Gecko ("Mozilla") based browsers. 
46
+
47
+  Feedback on this is very welcome!
48
+
49
+
50
+Prerequisites
51
+=============
52
+
53
+  In order to use MUCkl you need to have access to an [3]HTTP Polling
54
+  or [4]HTTP Binding service for Jabber. These allow you to connect to
55
+  a Jabber server using the HTTP protocol rather than raw TCP/IP
56
+  sockets. There are Jabber servers that have built-in HTTP Polling
57
+  support like [5]ejabberd or some of the commercial ones.
58
+
59
+  There are also some standalone implementations of HTTP Polling
60
+  available like [6]tonneru and [7]webjah. Both allow you to connect
61
+  to any jabber server. Latest versions of punjab have built in
62
+  support for HTTP Polling and HTTP Binding. See [8]punjab's website for
63
+  details.
64
+
65
+  Additionally you need a web server of your choice capable of doing
66
+  address rewriting (at least if you're using an HTTP proxy service
67
+  that is not local to your web server).
68
+
69
+  So to sum it up: If you don't know of any public jabber server which
70
+  offers HTTP Polling as a free service, you will have to install your
71
+  own jabber server or one of the HTTP Polling components mentioned
72
+  above. If you've got the choice use ejabberd as it's the most
73
+  reliable solution available at the moment at no cost.
74
+
75
+  [3] http://www.jabber.org/jeps/jep-0025.html
76
+  [4] http://www.jabber.org/jeps/jep-0124.html
77
+  [5] http://ejabberd.jabberstudio.org
78
+  [6] http://tonneru.tanoshi.net/
79
+  [7] http://www.gonzo.kiev.ua/projects/jabber/index.html#webjah
80
+  [8] http://punjab.sourceforge.net/
81
+
82
+
83
+Installation
84
+============
85
+
86
+  1) Unpacking
87
+
88
+     Unpack MUCkl into a directory accessible by your web server.
89
+
90
+  2) Configure Web Server
91
+
92
+     This is the trickiest part of the setup as it depends on which
93
+     HTTP Polling service you've chosen. It requires some knowledge of
94
+     apache configuration as well as some understanding of what HTTP
95
+     Polling is.
96
+
97
+     First let me explain, what we need to do and why: Due to security
98
+     considerations most browsers don't allow JavaScript to access any
99
+     data outside the domain it has been loaded from. Gecko based
100
+     browsers are even more restrictive in this as they don't allow
101
+     them to access data on a different port either.
102
+
103
+     So say, the HTTP Polling service we plan to use for MUCkl is
104
+     located at http://jabber.somedomain.com:5280/http-poll/ (a
105
+     typical ejabberd URI). MUCkl itself is served at
106
+     http://www.mydomain.com/MUCkl/. Now we have to make sure that our
107
+     installation of MUCkl can access the HTTP Polling service by
108
+     calling some local URI like
109
+     http://www.mydomain.com/http-poll/. So we have to
110
+     setup a rewrite rule which redirects requests on
111
+     http://www.mydomain.com/MUCkl/http-poll/ to
112
+     http://jabber.somedomain.com:5280/http-poll/.
113
+
114
+     Using apache this can be achieved by the following steps:
115
+
116
+     * Make sure that mod_rewrite and mod_proxy (additionally
117
+       mod_proxy_http for apache2) are loaded.
118
+
119
+     * Define a rewrite rule for your MUCkl installation directory (Step 1). 
120
+       E.g. create an .htaccess file within your MUCkl installation
121
+       directory like the following:
122
+
123
+       <IfModule mod_rewrite.c>
124
+         RewriteEngine On
125
+         RewriteRule http-poll/ http://jabber.somedomain.com:5280/http-poll/ [P]
126
+       </IfModule>
127
+
128
+
129
+  3) Setup Jabber Account
130
+
131
+     In order to complete Step 3 and 4 you will need a native Jabber
132
+     client that supports registration of new accounts and the MUC
133
+     protocol for configuration of your chat room. My tip: Use Exodus
134
+     on Windows, tkabber on Linux.
135
+
136
+     Now you need to create a new jabber account. Make sure that you
137
+     can connect to it by way of the chosen HTTP Polling service. So
138
+     most probably using the example above you would create it on
139
+     jabber.somedomain.com.
140
+
141
+     Everybody using your installation of MUCkl will use this account
142
+     data to enter the Jabber network and join your chat room.
143
+
144
+  4) Setup Chat Room
145
+
146
+     Now use some different Jabber account which will be the owner of
147
+     your desired chat room. Enter your room or create a new one and
148
+     configure it to suit your needs (e.g. don't make it
149
+     private/invite only/password protected, as MUCkl doesn't support
150
+     these kind of things).
151
+
152
+  5) Configure MUCkl
153
+
154
+     Now that we have all necessary data at hand we finally may edit
155
+     config.js (located in MUCkl's installation directory). For
156
+     detailed information on how to do this refer to the comments
157
+     given in this file!
158
+
159
+     When done, fire up your prefered browser (see above! ;-)) and
160
+     login to MUCkl.
161
+
162
+
163
+Further Information/Reading
164
+===========================
165
+
166
+  MUCkl is a stripped down version of [9]JWChat - a web based Jabber
167
+  client. As such it uses the [10]JSJaC library for communication with
168
+  the Jabber network. JSJaC allows you to connect to Jabber servers
169
+  using either [11]HTTP Polling or [12]HTTP Binding. Groupchat
170
+  functionality is realized as an implementation of the [13]Multi User
171
+  Conference Protocol [MUC].
172
+
173
+
174
+  [9] http://jwchat.sourceforge.net
175
+  [10] http://jsjac.jabberstudio.org
176
+  [11] http://www.jabber.org/jeps/jep-0025.html
177
+  [12] http://www.jabber.org/jeps/jep-0124.html
178
+  [13] http://www.jabber.org/jeps/jep-0045.html
179
+
180
+
181
+Disclaimer
182
+==========
183
+
184
+  This program is free software; you can redistribute it and/or modify
185
+  it under the terms of the GNU General Public License as published by
186
+  the Free Software Foundation; either version 2 of the License, or
187
+  (at your option) any later version.
188
+
189
+  This program is distributed in the hope that it will be useful, but
190
+  WITHOUT ANY WARRANTY; without even the implied warranty of
191
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
192
+  General Public License for more details.
193
+
194
+  You should have received a copy of the GNU General Public License
195
+  along with this program; if not, write to the Free Software
196
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
197
+  USA
198
+
0 199
new file mode 100644
1 200
Binary files /dev/null and b/screenshots/norloge.png differ
2 201
new file mode 100644
3 202
Binary files /dev/null and b/screenshots/totoz.png differ