Browse code

more documentation about adminpin etc

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@1449 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 07/07/2009 12:06:58
Showing 1 changed files
... ...
@@ -1,5 +1,7 @@
1 1
 webconference : conference with dial-in and dial-out over DI (xmlrpc)
2 2
 
3
+Intro
4
+-----
3 5
 This conference module can do dial-in, dial-out and mixed 
4 6
 dial-in/dial-out conferences.  It can be controlled over DI functions 
5 7
 from other modules, and, for example, using the xmlrpc2di module, 
... ...
@@ -25,11 +27,28 @@ You will probably want to load uac_auth and xmlrpc2di modules.
25 27
 There is some very simple feedback and call statistics functionality, which 
26 28
 will save its results to a log file.
27 29
 
28
-An admin PIN can be set, which serves to retrieve room PINs (for site administrator
29
-or the like).
30
+A master password can be set, which serves to retrieve room PINs (adminpins),
31
+for site administrator or the like.
30 32
 
31
-implemented DI functions:
33
+Room adminpin handling
34
+----------------------
35
+The adminpin is used so that only authorized users can access the conference control.
36
+The adminpin can be completely disabled by setting ignore_pin in webconference.conf, 
37
+in that case a specified adminpin is just ignored.
32 38
 
39
+On all actions that inspect or modify a room, if the room specified with room/adminpin
40
+does not exist, by default the room is (re)opened with the specified adminpin. 
41
+This means that roomCreate() does not necessarily need to be called; if roomInfo() 
42
+is called with a new room name and adminpin, the room is created and the adminpin 
43
+is set.
44
+
45
+If a room exists and the adminpin is not set (for example if the room is created
46
+by dial-in), the first call to roomInfo/dialout/kick/... with room/adminpin will
47
+set the adminpin.
48
+
49
+
50
+implemented DI functions
51
+------------------------
33 52
 All functions return as extra parameter the serverInfo, a status line showing the 
34 53
 SEMS version, and current call statistics.
35 54
 
... ...
@@ -117,8 +136,6 @@ getRoomPassword and listRooms in only available if master password is set
117 136
 in webconference.conf
118 137
 
119 138
 
120
-
121
-    
122 139
 prompt suggestions: 
123 140
 ------------------
124 141
 entering_conference: You are now entering the conference room.
... ...
@@ -127,3 +144,18 @@ pin_prompt: Welcome to iptel dot org conference. Please enter your room number,
127 144
 wrong_pin: The room number is not correct. Please try again.
128 145
 
129 146
 + the numbers (0.wav ... 9.wav )
147
+
148
+
149
+webconference.iptel.org server
150
+------------------------------
151
+
152
+At the free SIP service iptel.org there is a SEMS webconference server 
153
+running, which can be accessed through its rather simple web GUI at
154
+ https://webconference.iptel.org/ and http://webconference.iptel.org/
155
+and through its XMLRPC control URI
156
+ https://webconference.iptel.org/control
157
+
158
+see also:
159
+--------
160
+pyqt example gui client in 
161
+ apps/webconference/pyqtgui