Chapter 1 Using This Guide...4. Using the Elluminate Live! System...5. Chapter 3 Changes in Release Installation Overview...

Transcription

1

2

3 Contents Chapter 1 Using This Guide...4 Audience...4 Chapter 2 Using the Elluminate Live! System...5 An Elluminate Live! Overview...5 The Elluminate Live! Server...5 The Elluminate Live! Client...6 The Web Server...6 Elluminate Live! Server Administration...6 Minimum Elluminate Live! Server Requirements...6 Client Technical Requirements...8 Chapter 3 Changes in Release Release Notes...9 Cross Platform Differences...11 Upgrading from vclass 4.x...13 Configuration Differences between vclass 4.1 and Elluminate Live! Chapter 4 Installation Overview...15 Collecting Installation Information...15 Elluminate Live! Host Information...15 Classroom Server Information...17 Web Server Information...17 Administration Tool Information...17 Installing on Windows NT/2000/XP...18 Installing on Linux...19 Required Linux OS software...19 Accessing the Installation CD-ROM...20 Installing with the X-Windows wizard...20 Installing with the UNIX Console Mode Wizard...22 Uninstalling...22 The Java Runtime Environment...23 Elluminate Live! Installation and Configuration Guide i

4 Chapter 5 Chapter 6 Creating Virtual Rooms...24 About the Elluminate Live! Server...24 Concepts...24 Configuring the Elluminate Live! Server...25 General Installation Parameters in elive.conf...26 License Section...27 Paths Section...27 Network Section...28 Log Section...29 Updating the elive.conf File...30 Default Room Parameters in.tmpl Files...30 Template Section...31 Properties Section...32 Labels Section...33 Authorization Section...33 Services Section...34 Commands Section...35 Updating *.tmpl Files...37 Specific Room Parameters in.session Files...37 Session Header Section...38 Properties Section...39 Schedule Section...40 Authorization Section...40 Commands Section...41 Creating, Updating, and Deleting.session Files...42 User Authorization...44 User List Authentication...44 The Master Password File master.passwd...45 The User List File {Room Name}.users...45 The Room Password File {Room Name}.passwd...46 The Room Chair File {Room Name}.chair...46 URL Authentication...47 Implementing an Authentication Script...47 Authenticating a user...47 Identifying the Chair...48 ii Elluminate Live! Installation and Configuration Guide

5 Example Script...48 Chapter 7 Elluminate Live! Web Links...54 Making JAR Files, Web Start, and Open JNLP Accessible...54 Creating JNLP Files for Each Virtual Room...55 Creating Web Pages to Launch the Elluminate Live! Client...56 Chapter 8 Administrative Tools...57 Elluminate Live! Administration Overview...57 The Admin Console...58 Using the Admin Console...58 Controlling Access to the Admin Console...58 GUI Admin Key Tool...59 Command-Line Admin Key Manager...59 Chapter 9 Session Recording and Playback...63 Recording...63 Creating.vcr Files...64 Playing Back A.vcr File...64 List Available Recorded Sessions (playlist.pl)...65 Play a Specific Recorded Session (playvcr.pl)...66 Template jnlp File For Playing Recorded Sessions (playvcr.jnlp)...68 Chapter 10 Configuring SSL...70 SSL Over Shared Network Ports...70 Server Configuration in elive.conf...70 JNLP Configuration...71 SSL Using a Hardware SSL Accelerator or Appliance...71 Server Configuration in elive.conf...71 JNLP Configuration...72 Configuring SSL Key Files...72 Chapter 11 Technical Support...74 Elluminate Live! Installation and Configuration Guide iii

6 Chapter 1 Using This Guide Chapter 1 Using This Guide The Elluminate Live! Installation and Configuration Guide provides all the necessary information you need to install and administer Elluminate Live! servers. Audience This guide is intended for anyone responsible for the preparation, installation and administration of Elluminate Live! virtual classroom servers. It assumes a basic working knowledge in: The Web Server used to host download files and JNLP files which launch the Elluminate Live! client through a browser. The operating systems which will be used to host Elluminate Live! clients. These may include: o Microsoft Windows o Apple Macintosh o Sun Solaris If the Live! server software is to be installed in a Windows environment, a basic working knowledge is assumed for: The administration of Windows Services. If the Live! server software is to be installed in a Linux environment, a basic working knowledge is assumed for: The Red Hat Linux operating system. The Linux Daemon process, as controlled through the Run Level. If the Live! server software is to be installed in a Solaris environment, a basic working knowledge is assumed for: The Sun Solaris operating system. The UNIX Daemon process, as controlled through the Run Level. Elluminate Live! Installation and Configuration Guide 4

7 Chapter 2 Using the Elluminate Live! System Chapter 2 Using the Elluminate Live! System The Elluminate Live! collaboration tool provides an online, interactive, moderator-led learning environment. Elluminate Live! lets participants and moderators interact through a variety of mechanisms including live audio, direct text messaging, shared desktop applications and a shared whiteboard. An Elluminate Live! Overview Elluminate Live! is a Java based client/server application. The Elluminate Live! client runs on Windows and Macintosh personal computers, as well as Sun s SPARC Solaris systems. The Elluminate Live! server software runs on Windows (NT, 2000, and XP), Red Hat Linux (7.x and higher), and Solaris 9. The Elluminate Live! client is launched through a web browser interface, using Sun Microsystems Java Web Start. Java Web Start downloads the Elluminate Live! JAR files and then starts the Elluminate Live! application. On Macintosh classic operation systems (Mac OS 9.0 to 9.2) the Open JNLP application WebLauncher, provided by Elluminate, performs the function of Java Web Start. An Elluminate Live! server acts as a hub connecting Elluminate Live! clients in common meeting rooms (or sessions ). Each server provides real-time messaging, interactive graphing, real-time administration, and Voice Over IP (VOIP) to the classroom participants. Each Elluminate Live! server can host multiple rooms. The Elluminate Live! Server The Elluminate Live! server runs as a Service on Windows and as a Daemon process on UNIX. The Elluminate Live! server accepts client connections on one or more specified TCP/IP Conference Ports and validates user s identification. An authorized participant has a single connection to the Elluminate Live! server, and can join with other participants within a virtual meeting room. When a participant interacts in the virtual room with audio, online messaging, or by using the whiteboard, data is sent from that participant through this single connection to the Live! server. The server routes the data to all other room participants through their own individual connections. To accommodate participants that may have varying connections speeds, the Elluminate Live! server manages the bandwidth of all data transfers within the virtual room. Elluminate Live! Installation and Configuration Guide 5

8 Chapter 2 Using the Elluminate Live! System The Elluminate Live! Client An Elluminate Live! client is a virtual collaboration environment on a Windows or Macintosh personal computer, or on a SPARC Solaris workstation. The Elluminate Live! client is automatically downloaded, launched, and connected to a specific session on an Elluminate Live! server when the user clicks on the appropriate link in a browser. The Web Server The Elluminate Live! client is launched through a link on a web page, using Java Web Start to ensure the user has the appropriate version of the Elluminate Live! software for the session. Web Start will retrieve and validate the appropriate Java JAR files and will launch the Elluminate Live! client. Note that Java Web Start is not available for the Macintosh OS 9.0 to 9.2. For these operating environments, Open JNLP is used to perform the web launching function. The Web Server performs several functions to permit the launching of the Elluminate Live! client. The Web Server provides a copy of Java Web Start and Open JNLP so that the user may download and establish the web launching application for their browser. This only has to happen once to get Web Start or Open JNLP onto the participant s machine. The Web Server hosts a page (or pages) with JNLP links that automatically launch Sun Microsystems Java Web Start or Open JNLP to start An Elluminate Live! client. Java Web Start or Open JNLP downloads the appropriate versions of the JAR files needed for the Elluminate Live! client session from the Web Server, and starts the Elluminate Live! client. Elluminate Live! Server Administration Elluminate Live! server administration is performed by manipulating configuration files that are normally located in the installation directory or subdirectories. Refer to Chapter 5 Creating Virtual Rooms for more details. Several Elluminate Live! server functions can also be administered through the Elluminate Live! Admin Console (Administrative Tools) which can run on a Windows system. Minimum Elluminate Live! Server Requirements Minimum Requirements for a 25-seat Elluminate Live! license: Windows 2000, Windows XP, Windows Server 2003, RedHat Linux (7.x or later), or Solaris 9 75 megabytes of free disk space. This does not include the optional space required for extended log files and session recordings. In general, log files grow slowly, but about 5-10 megabytes of disk space could be required for each recorded 1-hour session. A static IP address. Internet connectivity with firewall access permitting an outside connection to the server s Conference Ports for Elluminate Live! clients, and to the Control Port for administrators. 6 Elluminate Live! Installation and Configuration Guide

9 Chapter 2 Using the Elluminate Live! System 1Mbps (outbound) bandwidth A 500 MHz Pentium 3 for Windows and Linux, or a 300 MHz UltraSPARC II processor for Solaris 256 megabytes of RAM For each addition 25 seats in your license add: 1Mbps (outbound) bandwidth. 200 MHz of Pentium 3 processor speed, 250 MHz of Pentium 4 processor speed, or 150 MHz of SPARC processor speed 50 megabytes of RAM These requirements assume an average room size of 25 participants or less. Larger rooms place higher instantaneous loads on the server and you should increase your hardware configuration accordingly. For instance, if you wish to hold single sessions with as many participants as your license will allow, the additional requirements for each 25 seats increases to: 2Mbps outbound bandwidth; 100 megabytes of RAM; and either 400 MHz of Pentium 3, 500 MHz of Pentium 4, or 300 MHz of SPARC processor speed. This is shown in the following table: Licensed Seats Maximum Room Size Processor(s) in Total MHz Available Memory in Megabytes 500 Pentium SPARC Pentium SPARC Pentium SPARC ,100 Pentium SPARC ,000 Pentium 4 1,200 SPARC ,250 Pentium 4 1,350 SPARC (multiple processor system recommended) 4,000 Pentium 4 2,400 SPARC (multiple processor system required) , Internet Bandwidth in Mbps These requirements also assume that the Elluminate Live! server is not required to perform SSL encryption and decryption for secure communications. See Chapter 10 for more details. Elluminate Live! Installation and Configuration Guide 7

10 Chapter 2 Using the Elluminate Live! System The Elluminate Live! host has asymmetric bandwidth requirements, with a higher outgoing bandwidth than the incoming bandwidth. For instance, each Elluminate Live! session generally has a single incoming audio stream that is used to generate multiple output audio streams one to each participant. Elluminate Live! server is a real-time application and may be significantly affected if limitations require the host system to page to disk. While these specifications are only minimum system requirements, installing Elluminate Live! on a faster server will not necessarily affect performance. However, a more powerful machine can reduce risk of service slowdown under very heavy loads. Client Technical Requirements For a Windows PC: Pentium II 266 MHz processor or faster 64 megabytes of RAM for Windows 95/98/ME, and 128 megabytes for Windows NT/2000/XP Windows 95/98/ME/NT/2000/XP/Server megabytes of available disk space on your hard drive Soundcard with speakers and microphone or headset 28.8 kbps or higher Internet connection For a MAC: Mac OS 9.0, 9.1, 9.2, Mac OS X 10.1 or later G3 233 MHz or better. 64 megabytes for OS 9, and 128 megabytes for OS X and above 20 megabytes of available disk space on your hard drive Stuffit Expander Speakers and microphone, or headset 28.8 kbps or higher Internet connection For a SPARC Solaris: UltraSPARC IIc 300 MHz or faster Solaris megabytes of RAM 20 megabytes of available disk space on your hard drive Soundcard with Speakers and microphone, or headset 28.8 kbps or higher Internet connection 8 Elluminate Live! Installation and Configuration Guide

11 Chapter 3 Changes in Release 5 Chapter 3 Changes in Release 5 Release Notes Release 5 of Elluminate Live! is an upgrade from vclass 4.1 that provides for a number of improvements in both the client and the server. New user interface and server configuration features are described in the table below. Feature New Name and Multiple Versions Window Layouts Description vclass is now called Elluminate Live!, and it now comes in an Enterprise Edition and an Academic Edition. Both versions have similar functionality, with the addition of a shared calculator and some extra clip art (including several new categories of math symbols) in the Academic edition. The layout of the Elluminate Live! internal windows (participant info, direct messaging, audio, and whiteboard) can now be locked. When the layout is locked, these windows cannot be moved or resized individually. They will be automatically sized and positioned when the Elluminate Live! application window is resized. The option to lock or unlock these windows is found under the view menu. The initial default is to have locked windows, but changes to this setting are persistent. There are two new window layouts: tall and minimal flat. The tall layout is suitable for displays that are taller than they are wide, like the portrait display of a tablet PC. The minimal flat layout is suitable for sharing a screen region located underneath or above the Elluminate Live! application window. The window layouts are now selected by single drop down button. The whiteboard and application sharing displays can now optionally scale down to preclude the use of scroll bars. If whiteboard scaling is on, the whiteboard will also scale up to maximize available space. The options to scale these displays are found under Tools -> Application Sharing and Tools -> Whiteboard. Non-scaled is the initial default for both the whiteboard and application sharing display. Changes to these scaled settings are persistent. Elluminate Live! Installation and Configuration Guide 9

12 Chapter 3 Changes in Release 5 Whiteboard A new laser pointer allows anyone with whiteboard privileges to highlight content without marking up the whiteboard. Other participants can see the mouse movements of the laser image. Moderators have a new visual cue that participants are not following and might not be seeing the same screen. The whiteboard navigation bar changes to a pink color when Follow Moderator is turned off, or when a Moderator moves to a screen to which participants cannot follow (i.e. a private screen or a breakout room screen). References to the Image Palette have been replaced with Clip Art and the whiteboard comes with new standard images. Academic Edition users also have a number of new math related symbols available. All users may now create their own clip art collections. These collections are stored in local archive files and can be ed to others. Whiteboard content can be protected from saving and printing, when a moderator selects Protect Whiteboard under the menu item Tools -> Whiteboard. With this option on, users will not be able be able to save or print any whiteboard screens -- even after disconnecting. When the whiteboard is protected, all participants follow the moderator and the Follow Moderator checkbox is replaced by the highlighted label Protected. A new object explorer provides a hierarchical listing of groups and objects for the current screen and displays who created them. The object explorer can be used to select objects even ones that are contained within groups or are in the background. The object explorer is found under the Tools -> Whiteboard menu entry. You can select objects on the current screen created by specific participants by selecting names in the participant info window, right clicking, and then choosing Whiteboard -> Select all Objects Originated by Participants. Whiteboard loading has been simplified and enhanced. A single Load File dialog box is used for Whiteboard, PowerPoint, and Image Files. When the file filter is set for PowerPoint files, the user has the option of importing the PowerPoint file either quickly or with higher quality. When the file filter is set for image files, the user has the option of importing multiple images at the same time each to its own screen. The imported sequence can be in one of: the selected order; alphabetic order; or alpha-number order (e.g. slide2 will be in sequence before slide11 ). When a participant does not have permission to use the whiteboard, the whiteboard tool buttons are no longer visible, and the whiteboard display shifts to use the unused button space. Application Sharing It is now possible for the application sharing host to specify that the display window for the other participants will be fitted to the area being shared instead of covering the entire whiteboard. This facilitates the sharing of a pop-up application on top of the whiteboard, like a calculator or even a video display. This new display mode is now the default for application sharing. Since application sharing is now regularly used in unison with the whiteboard, both features now equally share bandwidth. In previous versions, application sharing data 10 Elluminate Live! Installation and Configuration Guide

13 Chapter 3 Changes in Release 5 always took precedence over whiteboard data. The application sharing window is now always displayed on top of all other windows. Audio A new audio set-up facility walks first time users through the testing and level setting of the speakers and microphone. This facility is available at any time from the menu item Tools -> Audio -> Set up Audio. A new menu item Tools -> Audio -> Select Audio Source allows the user to select from multiple audio sources on their system, such as an alternate microphone. By selecting another audio source such as Stereo Mix the user can share audio from other applications. The available options will vary depending on installed sound cards and audio drivers. Recording Calculator (Academic Edition only) Help Supported Platforms CD Server Installation A moderator may now choose to erase, and optionally restart, the current recording. Buttons for starting and pausing the recording are now available in the bottom status bar. A new menu item Tools -> Calculator -> Follow Moderator replaces the previous Follow moderator setting in the Calculator window itself. This new menu item allows a Moderator to globally hide the Calculator without having to disable the private Calculator function. A new menu item Help -> Web Support provides direct access to Elluminate s HTML support pages. SPARC Solaris 9 is now supported with both the client and the server functions of Elluminate Live!. The Windows Server installer will now start automatically when the CD is loaded. The installers for other supported platforms must still be started manually. Instructions for doing so are contained in the file readme.txt in the root directory of the CD. The Elluminate Live! Installation CD now comes with an optional, but default, Whiteboard available for preloading into each session. Note that the new user features are described in detail in the Moderator and Participant Guides included on the Elluminate Live! installation CD-ROM. The server changes are detailed in the appropriate sections of this document. Cross Platform Differences The Elluminate Live! server will provide essentially the same functions, irrespective of whether it is installed on Linux, Windows, or Solaris. The client portion of Elluminate Live! does have slight variances depending on operating platform. Elluminate Live! Installation and Configuration Guide 11

14 Chapter 3 Changes in Release 5 The following table lists the features that differ on the various client versions of Elluminate Live!: Feature Windows (98,ME,2000,XP) Mac OS 9.x Mac OS X Solaris 9 Whiteboard Whiteboard AppSnap from all displays or from the main display only All All All Main Can Import PowerPoint presentations Yes No Yes With OS X 10.2 and later No Can scale the whiteboard display Yes No Yes Yes Application Sharing Can share own desktop, a region, or an application with others Yes No Yes No Printing Can scale the application sharing display Yes No Yes Yes Can print the Whiteboard and Direct Messages (without having to first save to a PDF file or text file) Yes No Yes No Audio Audio encoder/decoder is high performance native code or java based Audio input processing is high performance native code or java based Native Native Native Native Native Native Native Java Hotkeys Client can use Hotkeys Yes Yes Yes No Secure Communications Client can use SSL communications with the Elluminate Live! server Yes No Yes Yes 12 Elluminate Live! Installation and Configuration Guide

15 Chapter 3 Changes in Release 5 Upgrading from vclass 4.x You may install Elluminate Live! 5 on a machine which already has a previous vclass version installed. By default, the new Elluminate Live! installation will not overwrite vclass 4.x directories or commands. The new default installation directory is C:\Program Files\ELive5 on Windows and /opt/elive5 on Linux. Installation over existing vclass directories will cause erroneous operation and is not recommended. Elluminate Live! 5 can operate simultaneously with an earlier version of vclass on the same server hardware provided these programs do not simultaneously use the same TCP/IP conference and control ports. As the default ports have not changed with Elluminate Live!, you will need to choose alternative values if there is a conflict with a running vclass server. Note that this can be particularly problematic with the firewall friendly ports 80 and 443. It is not possible for Elluminate Live! and vclass to simultaneously listen on the same ports. To upgrade from a running vclass server, the following steps are recommended: 1. Install Elluminate Live! into directories that are different from existing vclass directories. The default installation directories should be fine. When prompted for a license file during the installation, you must provide an Elluminate Live! 5 license file. You cannot use a vclass license file. 2. Assign the Elluminate Live! server unique TCP/IP conference and control ports. This can be done in the wizard during the installation, or afterwards by editing the installed elive.conf file. See Chapter 5 for details. 3. Update the Elluminate Live! server configuration: a. Copy all of the vclass.session and.tmpl files into the Elluminate Live! session directory. Edit these files and update any internal pathnames as appropriate. No other changes are required. b. Copy all of the access control files under the vclass access directory to the Elluminate Live! access directory. No changes are required. 4. Update the web links: a. Copy all of the new Elluminate Live! 5 jar files to a new web directory. b. Copy any web pages with vclass JNLP links. c. Create new JNLP links for the copied web pages that use the new Elluminate Live! JNLP template, template.jnlp. This template is found on the installation CD-ROM. Do not change any JNLP links for existing vclass recorded sessions. vclass recordings have to be played with the appropriate vclass playback utility. Elluminate Live! recordings will require new links to the Elluminate Live! playback utility. 5. If you assigned Elluminate Live! the same TCP/IP ports as vclass (in step 2 above), you must now shut down the previous vclass server. 6. Start the Elluminate Live! 5 server. Elluminate Live! Installation and Configuration Guide 13

16 Chapter 3 Changes in Release 5 7. Test the new web links. 8. Replace the old web pages with the new pages. Configuration Differences between vclass 4.1 and Elluminate Live! 5 This section lists the configuration changes between vclass 4.1 and Elluminate Live! 5. Please refer to Chapter 5 for complete information on how to configure an Elluminate Live! server installation. Changes in Vclass.conf 1. vclass.conf has been renamed elive.conf. 2. A vclass 4.1 license file is not compatible with Elluminate Live!. Changes in *.tmpl files 1. The commands section contains a new whiteboard setting for protected whiteboard files. Changes in *.session files 1. The commands section contains a new whiteboard setting for protected whiteboard files. Changes in *.jnlp files 1. All new JNLP files are required for Elluminate Live!. Starting and Stopping the Server The Windows service is now called Elluminate Live! Version 5 Server. The Linux daemon is now invoked with /etc/init.d/elive5d. 14 Elluminate Live! Installation and Configuration Guide

17 Chapter 4 Installation Overview Chapter 4 Installation Overview Installing and using Elluminate Live! Software is a process that involves several steps. These steps, and the chapters in which they are discussed, are as follows: Collecting information needed for the installation and configuration in Chapter 4. Installing the server environment in Chapter 4. Creating virtual classrooms in Chapter 5. Setting up user authorization in Chapter 6. Enabling the client web based interface in Chapter 7. Generation of administration keys to enable the Elluminate Live! Admin Console in Chapter 8. Collecting Installation Information During installation the administrator will need a number of pieces of information. It is always easiest if you prepare for the installation by gathering this information in advance. Elluminate Live! Host Information Type of Info Elluminate Live! License File Explanation The Elluminate Live! server software requires a license file to operate. This file is normally sent by from Elluminate. You may either save this file to disk prior to installation (and then provide the pathname to this file during installation) or after installation you can copy your license file over the default file elive.lic that will be found in the installed ELive5\lib directory. If you copy the file after installation, you will need to restart the Elluminate Live! server. As this file is critical to your use of Elluminate Live!, be sure to maintain a backup copy. Elluminate Live! Installation and Configuration Guide 15

18 Chapter 4 Installation Overview Type of Info Elluminate Live! Installation Directory Elluminate Live! Server UserID Elluminate Live! Server Run Level Elluminate Live! Log File Directory Elluminate Live! Recordings Directory Elluminate Live! IP address Explanation The Elluminate Live! software needs to be installed in a directory on the system. For Windows the default is C:\Program Files\ELive5. For UNIX the default is /opt/elive5. On a UNIX system the Elluminate Live! server can either run as root or can run with a UserID with considerably limited access. If you want to save logs in /var/log or use a Conference Port with a number of 1024 or less, you will need to run as root. On a UNIX system the Elluminate Live! server can be automatically run as a Daemon process and managed by the Run Level the system is set to. You will be asked the Run Level to start the Elluminate Live! server. The default level for a UNIX system is 3. The Elluminate Live! server reports virtual classroom usage and various errors in log files. For Windows the default log directory is C:\Program Files\ELive5\logs. For UNIX the default log directory when run as root is /var/logs. When not run as root the default is /opt/elive5/logs. A directory must be provided for recorded Elluminate Live! sessions. A directory should be chosen with sufficient available disk space. While the size of recordings can vary, it is a good rule of thumb to assume that 5 to 10 megabytes will be required for each 1-hour session. The Windows default recording directory is c:\program Files\ELive5\recordings. The UNIX default recording directory is /opt/elive5/recordings. If recordings will need to be communicated to a Web Server to be disseminated over the web, it is advisable to consider where it is best to place recordings to make them accessible to the Web Server. The Elluminate Live! server communicates with the Elluminate Live! clients via TCP/IP. The IP address is the host address that the clients need to know to find the Elluminate Live! server. 16 Elluminate Live! Installation and Configuration Guide

19 Chapter 4 Installation Overview Classroom Server Information Type of Info Elluminate Live! classroom Conference Port number(s) Elluminate Live! classroom Control Port number Explanation The Elluminate Live! client connects to the Elluminate Live! classroom server on the server s TCP/IP Conference Port number(s). The Elluminate Live! server can listen on a number of Conference Ports. To be accessible, these port numbers must pass through all firewalls between the client and the server. The single default port number is 2187, but alternate or additional ports, generally ports 80 and 443, can be specified to deal with limitations imposed by some firewalls. The Elluminate Live! Admin Console connects to the Elluminate Live! server on the server s TCP/IP Control Port number. This Control Port must pass through all firewalls between the Admin Console host and the server. The default port number is Web Server Information Type of Info Document Root Download Directory Explanation A Web Server serves information from a hierarchy starting at its Document Root. You will use this to determine a Download Directory (below). For Apache, this can be found in the file httpd.conf at the DocumentRoot keyword. If you were installing to an IIS web server, you can determine the document root through the IIS management interface. The Elluminate Live! client s JAR files are retrieved from a download directory on the Web Server. You should determine what you want this directory to be, since you will enter it as the Code base in the JNLP files used to start the Elluminate Live! client. Administration Tool Information Type of Info Administrative Key Users and Names Explanation The Admin Console tool uses sets of keys to control access to the Elluminate Live! server. You should determine which user(s) would be getting access keys before you start to generate and distribute these keys. For each user you will be asked for a user name and the password to be associated with that user s key. You will also be asked the key file name and location to save the keys. Elluminate Live! Installation and Configuration Guide 17

20 Chapter 4 Installation Overview Installing on Windows NT/2000/XP To start the Windows installation process, insert the CD-ROM into a CD drive. The installer will start automatically. Follow the instructions to provide the following information: 1. The installation directory 2. Your license key file (this will normally be provided via ) 3. The log file directory 4. The session recording directory 5. The Elluminate Live! server Control Port and Conference Port(s) 6. The maximum bandwidth available to the Elluminate Live! server 7. The maximum available physical memory (or heap size ) for the Elluminate Live! server After providing this information, click Install to continue. The software environment will then be copied to your hard drive and the Elluminate Live! 5 Service will be installed. You will then be asked if you wish to create a key for the Admin Console utility: If you do not wish to create one or more keys files for the Admin Console at this time, you may ensure Launch AdminKeyTool is deselected and click Next to continue. Refer to Chapter 8 for details about how to use the Admin Key Tool and the Admin Console. After the Admin Key Tool is either run or skipped, the Elluminate Live! Service will be automatically started and the installation is complete. 18 Elluminate Live! Installation and Configuration Guide

21 Chapter 4 Installation Overview Installing on Linux UNIX installations can be performed in either an X-window environment or in a console mode environment. Each is started through a command-line which specifies how the installer is to be started. If the argument -i console is added to the command-line, the installer will work in console mode, and will not attempt to use the window system (which might not be present). Required Linux OS software To ensure a smooth installation of the Elluminate Live! server, the necessary Linux OS software must be in place. Sun Microsystems Java Virtual Machine The Elluminate Live! installation includes version of Sun Microsystem s Java Virtual machine. However, prior to installing Elluminate Live! Server on Red Hat Linux, you should check that your Linux system meets Sun Microsystem s stated software requirements. The version of the Java 2 SDK is supported on Intel Pentium platforms running the Linux kernel v and glibc v or later. To check the version of glibc your machine is using, type the following command: ls /lib/libc-* to determine what version of glibc is installed You may have to update your glibc if it is not v or later. Please consult you Red Hat documentation to determine how to do this. Ncompress Utility The installation process requires ncompress. To find out if it is available on your system, run the command: whereis ncompress to see if the command can be found. If it is not available, you need to install the RPM file, ncompress i386.rpm from our CD under the installs\linux\supporting_rpms directory. To install ncompress, please consult your Red Hat documentation. Elluminate Live! Installation and Configuration Guide 19

22 Chapter 4 Installation Overview Accessing the Installation CD-ROM If your system does not automount the CD-ROM, when it is inserted, examine the file /etc/fstab to see if there is a line specifying the CD-ROM drive and where it will mount. If there is, you can simply execute the mount command for the CD-ROM device, such as mount /dev/cdrom. If not, you will have to specify both the device and the mount point, like: mount /dev/cdrom /mnt/cdrom. Installing with the X-Windows wizard To start the UNIX GUI installation process, execute the file elive5.bin that is located in the installs\linux\disk1\instdata\vm or installs\solaris\disk1\instdata\vm directory, of the installation CD-ROM. Follow the instructions to provide the following information: 1. The installation directory 2. Your license key file (this will normally be provided via ) 3. The UserID to run the server as (this will preset the log file directory default) 4. The log file directory 5. The session recording directory 6. The Elluminate Live! server Control Port and Conference Port(s) 7. The maximum bandwidth available to the Elluminate Live! server 8. The maximum available physical memory (or heap size ) for the Elluminate Live! server After providing this information, click Install to continue. The software environment will then be copied to your hard drive and the Elluminate Live! Daemon will be installed. You will then be asked: 9. The Run Level to start the Elluminate Live! server daemon and if you wish this to be started at the end of the installation process. 10. To generate the Master.keys file, and if you wish to create a key for the Admin Console utility: 20 Elluminate Live! Installation and Configuration Guide

23 Chapter 4 Installation Overview If you do not wish to create one or more keys files for the Admin Console at this time, you may ensure Launch AdminKeyTool is deselected and click Next to continue. Refer to Chapter 8 for details about how to use the Admin Key Tool and the Admin Console. After the Admin Key Tool is either run or skipped, the Elluminate Live! Service will be started as specified, and the installation is complete. Elluminate Live! Installation and Configuration Guide 21

24 Chapter 4 Installation Overview Installing with the UNIX Console Mode Wizard To start the UNIX Console Mode installation process, execute the file elive5.bin -i console that is located in the installs\linux\disk1\instdata\vm or installs\solaris\disk1\instdata\vm directory of the installation CD-ROM. Follow the instructions to provide the following information: 1. The installation directory 2. Your license key file (this will normally be provided via ) 3. The UserID to run the server as (this will preset the log file directory default) 4. The log file directory 5. The session recording directory 6. The Elluminate Live! server control port and conference ports 7. The maximum bandwidth available to the Elluminate Live! server 8. The maximum available physical memory (or heap size ) for the Elluminate Live! server After providing this information, click Install to continue. The software environment will then be copied to your hard drive and the Elluminate Live! Daemon will be installed. You will then be asked: 9. The Run Level to start the Elluminate Live! server daemon and if you wish this to be started at the end of the installation process. 10. To generate the Master.keys file. Refer to Chapter 8 for details about how to use the Admin Key Tool, Admin Key Manager, and the Admin Console. After the Master.keys file is generated, the Elluminate Live! Service will be started as specified, and the installation is complete. Uninstalling Windows NT, 2000, XP Uninstall To uninstall the Elluminate Live! Server Scheduler from Windows, run the Add or Remove Programs applet in the control panel. Select Elluminate Live! Version 5 and click the Change/Remove button. 22 Elluminate Live! Installation and Configuration Guide

25 Chapter 4 Installation Overview UNIX GUI Mode Uninstall To uninstall Elluminate Live! from UNIX in Console Mode, run the Uninstallelive5/Uninstall_ELive5 script located in installation directory. No files created after the installation will be removed. This includes: configuration files, user authentication files, and recorded sessions. UNIX Console Mode Uninstall To uninstall Elluminate Live! from UNIX in Console Mode, run the Uninstallelive5/Uninstall_ELive5 script located in installation directory, with the command-line argument of -i console. No files created after the installation will be removed. This includes: configuration files, user authentication files, and recorded sessions. Installation Directory Cleanup The Installation Directory and some files will be left after uninstallation to hold various configuration changes (and in the case of UNIX, the java runtime environment, and the UninstallerData directory). To completely cleanup the installation, you will need to manually delete the installation directory and any directories and files left under it. The Java Runtime Environment Both the Windows and UNIX installers will set up the appropriate java runtime environment for the server and tools. This is done in a way that does not conflict with any other java runtime environment already installed on the server. Elluminate Live! Installation and Configuration Guide 23

26 Chapter 5 Creating Virtual Rooms Chapter 5 Creating Virtual Rooms About the Elluminate Live! Server The Elluminate Live! server is an application that runs within the Windows or Linux environment and hosts multiple virtual meeting rooms (or sessions ). The server runs on a host machine and listens on one or more network ports for connections from clients wishing to join a virtual room. The virtual rooms available on a given server are identified by a unique name. Configuring the Elluminate Live! server consists of two basic parts: 1. Setting up the server by specifying license data, where to look for configuration files, and overall parameters affecting operation of the server. This is primarily done in the elive.conf file. 2. Defining what virtual classrooms are available, setting how the rooms behave, and when and to whom the rooms are available. This is primarily done in the.tmpl and.session authentication files. Concepts The server manages a number of abstractions: Virtual meeting room Session Groups and Templates A virtual meeting room is an active room that users can join. A session is a description of a single named virtual room, containing information about when it should be launched, whether it should be recorded, how the users are authenticated to join the room, etc. Sessions are used to define rooms and schedules. Sessions are defined in session files. A template is a generic session description supplying the information about unnamed, unscheduled sessions. Each template is used to provide a central location for defining information that is common across a single group of sessions. These group definitions can be omitted from individual session descriptions, and can 24 Elluminate Live! Installation and Configuration Guide

27 Chapter 5 Creating Virtual Rooms Virtual rooms are launched in one of two ways: provide definitions for virtual rooms that are launched on demand, rather than on schedule. Templates for session groups are defined in.tmpl files. Scheduled On Demand A.session file (e.g. Math10.session) is created for a room which runs on a scheduled basis. The server makes the room available as defined in the schedule, with the settings for the room (such as how participants get authenticated) defined by the session file, or if not defined in the session file, from a common template. The server can be configured to automatically launch rooms on demand. When this is enabled, a user that joins a virtual room that is not running is verified based on the authentication information in an associated template. If the user is authenticated, the server will start the room. The room will stay running until it has been empty for a preset length of time, after which, the virtual room will be terminated. Configuring the Elluminate Live! Server When you administer the Elluminate Live! Software, you are: 1. Managing the general installation parameters; 2. Setting default room parameters for Elluminate Live! virtual rooms groups; and 3. Setting specific room parameters for selected Elluminate Live! virtual rooms. General installation parameters (in elive.conf ) include: The license key file path Installation pathnames Network configuration The Elluminate Live! log file and flags Default room parameters (in *.tmpl files) include: Default virtual room participant permissions Default virtual room participant authentication mechanism Default recording action of virtual rooms Default bandwidth limit for virtual rooms Default preloaded whiteboard presentation (if any) Default whiteboard protection status Elluminate Live! Installation and Configuration Guide 25

28 Chapter 5 Creating Virtual Rooms Specific room parameters (in *.session files) include: The virtual room operational schedule The virtual room participant authentication mechanism The virtual room start time setting The virtual room recording action The virtual room bandwidth limit The virtual room preloaded whiteboard presentation (if any) The whiteboard protection status Normally, the general installation parameters do not need to be modified after installation unless support for secure communications is required. The definable parameters in this file come with reasonable defaults or are always configured during the installation of the Elluminate Live! software. As a general rule, default room parameters only need to be specified when there is a group of rooms that must have an authentication method, a recording action, or a preloaded whiteboard that is different from the general default. Also as a general rule, specific room parameters only need to be provided if there are individual virtual room sessions that require a unique authentication mechanism, recording action, or a preloaded whiteboard. Specific room parameters are also required if a virtual room must have a defined start and stop schedule and automatic room creation is not acceptable. All of these installation and operational parameters are stored in editable XML format files. To set or modify a parameter, the appropriate XML file is simply modified in place with a text editor, such as Notepad in Windows, or emacs in Linux. Depending on which XML file is modified, the Elluminate Live! server may have to be stopped and then restarted to pick up the changes. The format and use of each of the configuration XML files is described below. General Installation Parameters in elive.conf The general installation parameters are provided in an XML format file called elive.conf which is located in the root of the installation directory. For a windows installation, this is typically C:\Program Files\ELive5\elive.conf. For a Linux installation, this is typically /opt/elive5/elive.conf. The location of the root Elluminate Live! directory, and therefore this file, is chosen during installation and may vary between systems. A typical elive.conf file for Windows may look like the following: <?xml version="1.0" encoding="utf-8"?> <schedulerconfig> <license path= c:\sample server config\elive.lic \> <paths 26 Elluminate Live! Installation and Configuration Guide

29 Chapter 5 Creating Virtual Rooms sessions="c:\sample server config\sessions" services="c:\sample server config\lib\services"/> <network bandwidth= > <conference port= 2187 protocols= jinx /> <conference port= 80 protocols= jinx /> <conference port= 443 protocols= jinx /> <console port= 2188 keyfile="c:\sample server config\lib\master.keys"/> </network> <log file="c:\sample server config\logs\elive.log" size=" "> log.load log.launch log.access.grant log.access.deny </log> </schedulerconfig> License Section The license section is initially configured to refer to elive.lic in the installed lib directory. When prompted to provide the license file during the installation, the file you specify is copied over this elive.lic file. If you do not already have a license file at the time you do the install, and choose to accept the default values, elive.lic will contain a default 2-user license. When you receive your license file, overwrite elive.lic with the new one, or change the path in the license section to refer to the new file, and restart the server. Paths Section This section specifies: The sessions pathname for the directory that contains: o o.tmpl files that define default room parameters for groups of rooms (see below).session files that define specific room parameters for select virtual rooms (see below) The services pathname for the directory that contains optional features of the Elluminate Live! server. The values in this section are set during the installation. Modification of this section of elive.conf is not recommended. Elluminate Live! Installation and Configuration Guide 27

30 Chapter 5 Creating Virtual Rooms Network Section This section specifies the network ports and resources that are used by the Elluminate Live! server. The optional bandwidth attribute allows you to specify an upper limit to the bandwidth that will be used by the Elluminate Live! server (specified in bits-per-second). If it is not supplied, the server will not try to limit aggregate bandwidth. The network section has various sub-sections which define the network resources used by the server: The console sub-section defines the TCP port and master key file needed to allow remote management of the Elluminate Live! server using the Admin Console tool. Some administration operations for the Elluminate Live! server can be handled from a remote machine through the Admin Console tool. The Elluminate Live! Admin Console connects to the Elluminate Live! server on its single Control Port number. This number must be unique from all other network services on the host machine and from all Conference port numbers (see below). The Control Port number must be in the range Note that for UNIX, if a port is selected in the range , the server must be run as root. This Control Port must pass through all firewalls between the Admin Console and the Elluminate Live! server. Since some firewalls restrict access to some ports, or only allow access to specific ports, it may be necessary modify the value of this field. Normally, however, the default Elluminate Live! Control Port number of 2188 is sufficient. The pathname of the master key file is used by the remote access Admin Console tool to authenticate connections to the console port. The keys in the admin key file are maintained using the Admin Key Tool or Admin Key Manager. Modification of this pathname is not recommended. Only one instance of the console sub-section is allowed. A conference sub-section defines a port on which the Elluminate Live! server will accept connections from clients wishing to join a conference, and the protocols that can be run on that port. Elluminate Live! must be assigned at least one TCP Conference Port number. Multiple ports can be provided with multiple instances of this sub-section. The port numbers must be unique from all other network services on the host machine, and from each other, and the console port number (see above). Conference Port numbers must be in the range Note that for UNIX, if a port is selected in the range , the server must be run as root. This Conference Port must pass through all firewalls between the client and the server. Since some firewalls restrict access to some ports, or only allow access to specific ports (for instance, port 80), it may be necessary to configure multiple ports. Normally, however, the default Elluminate Live! Conference Port number of 2187 is sufficient. Refer to the Web Links chapter for information on how to specify connections to Conference Ports. The protocols attribute of a conference port determines whether the port allows and/or requires a secured protocol for connections received on that port. The standard protocol for normal unencrypted conferencing is called jinx, and is configured automatically during installation. The protocols only need to be changed if secure conferencing is being configured. Secure conferencing can not be configured from within the installation. 28 Elluminate Live! Installation and Configuration Guide

31 Chapter 5 Creating Virtual Rooms For a description of how to configure secure conferencing, see Chapter 10. A single ssl sub-section defines the file and password for the Secure Socket Layer (ssl) encryption keys required for encrypted communication. This section is NOT created during installation and is only required if secure client connections are to be used. For a description of how to configure secure conferencing, see Chapter 10. Log Section This section specifies: The pathname of the current Elluminate Live! log file. The maximum size in bytes of the Elluminate Live! log file. When the log file grows over this maximum size, it is renamed to {prefix}.1.{suffix}. For instance, the default name for this log file is elive.log. When it grows over the maximum size, this file will be renamed to elive.1.log and logging will continue in a new file called elive.log again. Previous log files have their middle number increased by one. So, for instance, if there already was a file called elive.1.log, it is renamed to elive.2.log. In this way, if the current log file is always called elive.log. The previous log file would be called elive.1.log, the next oldest would be called elive.2.log, and so on. As there is no automatic truncation of log files and no limit to the number of log files that can be generated, care should be taken to ensure sufficient disk space. It may become necessary to delete old log files. The log file tracking specifications. There are four options that may or may not be provided. Including the log.load option creates a log entry for each session or template that is loaded into the Elluminate Live! server. This occurs whenever a specific room parameters or a default room parameters file (see below) is created or modified. Including the log.launch option creates a log entry whenever a virtual room starts. Including the log.access.grant option creates a log entry whenever any virtual room participant is granted access. Including the log.access.deny option creates a log entry whenever any virtual room participant is refused access. Note that the values in this Log section are set during installation. Modification of the Log section of elive.conf is not normally required. Elluminate Live! Installation and Configuration Guide 29

32 Chapter 5 Creating Virtual Rooms Updating the elive.conf File For changes to this file to be processed, the Elluminate Live! server must be restarted. In Windows, this means that the Elluminate Live! Service must be stopped and then started again. In Linux, the Elluminate Live! daemon program must be restarted with the following command: /etc/init.d/elive5d restart. Note that stopping or restarting the Elluminate Live! server will immediately terminate all running virtual rooms. Default Room Parameters in.tmpl Files Default room parameters for virtual rooms are provided in XML format files that have a suffix.tmpl. The purpose of.tmpl files is to specify behaviors for virtual rooms that are automatically created when participants and moderators connect to the Elluminate Live! server. Also, by defining default classroom attributes, the.tmpl files serve to reduce the size of specific operational parameter files (called.session see below) and centralize possible changes. Each.tmpl file defines default room parameters for a group of room sessions. The name of the associated room group is defined at the top of the file in the template header and is described in more detail below. There is one special file, typically called Default.tmpl, that contains parameters for sessions that do not belong to any named group. The.tmpl files are normally located in the sessions directory under the root installation directory. For a windows installation, this is typically C:\Program Files\ELive5\sessions. For a Linux installation, this is typically /opt/elive5/sessions. The location of the root Elluminate Live! directory, and therefore the sessions directory, is chosen during installation and may vary between systems. In addition, it is possible to change the name and location of the sessions directory by modifying the general installation parameters in the file elive.conf. See the previous section for more details. Please refer to Chapter 7 for information on how to specify connections to classroom sessions and to different classroom groups. A typical.tmpl file for Windows may look like the following. Please note that the highlighted section is actually just two single lines. <?xml version="1.0" encoding="utf-8"?> <template groupname="sales" autolaunch="true" grace="5"> <properties supervised="true" defaultaccess="false"/> <labels session="class" Session="Class" sessions="classes" Sessions="Classes" 30 Elluminate Live! Installation and Configuration Guide

33 Chapter 5 Creating Virtual Rooms participant="participant" Participant="Participant" participants="participants" Participants="Participants" group="breakout room" Group="Breakout room" groups="breakout rooms" Groups="Breakout rooms" moderator="moderator" Moderator="Moderator" moderators="moderators" Moderators="Moderators"/> <auth class="fileaccessmanager"> <accessdir string="c:\program Files\ELive5\access"/> <passwordfile string="c:\program Files\ELive5\access\master.passwd"/> </auth> <services> <all/> </services> <commands> <setup>starttime set {schedule.start,date,yyyy-mm-dd} {schedule.start,time,hh:mm}</setup> <setup>recorder path c:\sample server config\recordings\{session.name}.{schedule.start,date,yyyy-mm-dd}.vcr</setup> <setup>recorder options append</setup> <setup>recorder mode remote</setup> <setup>whiteboard preload file:///c:\preloads\welcome.wbd</setup> <setup>whiteboard maximagecache </setup> </commands> </template> Template Section This header section specifies: The name of the Elluminate Live! session group for which the settings in the file are to apply. If groupname="name" is provided, all of the settings in the file will apply to session names that start with the string NAME. Note that NAME can be any alphanumeric string. One, and only one,.tmpl file in the sessions directory may exclude the groupname setting from the Template Section. The contained settings, normally provided in a file called Default.tmpl, apply to all sessions that do not belong to a named group (i.e. Elluminate Live! sessions that do not start with a NAME string). The default launching action for virtual rooms. Elluminate Live! Installation and Configuration Guide 31

34 Chapter 5 Creating Virtual Rooms If autolaunch="true" is provided, then the act of connecting to a virtual room in the associated group will result in the automatic creation of that room if it is not already running. If autolaunch="false" is provided, or this setting is omitted altogether, than no participant or moderator will be able to connect to a room in the associated group unless it had been scheduled to run and is currently active. Rooms are scheduled by creating or modifying specific room parameter files (see.session files below). The number of minutes that an automatically launched room will stay open after the final participant leaves. The grace="n" parameter specifies N number of minutes. If grace= 5 is provided, then the automatically launched room will stay open for 5 minutes after the final participant leaves. If this setting is omitted altogether, automatically launched rooms will close 15 minutes after the final participant leaves. Note that restarting a room involves some server overhead and may result in a new recording file (see Commands section below). Peak bandwidth limits. It is possible to limit the peak bandwidth of each connection to a virtual room. This may be desirable if the Elluminate Live! server is hosted on a machine with limited or shared connectivity to the Internet. Peak participant bandwidth is limited by providing the speed= construct. For example, to limit peak speed to 56 kilobits per second, the string speed= would be used. Valid options are: speed= speed= speed= speed= speed= Regardless of this setting, the Elluminate Live! server will not establish a connection to a client at a peak bandwidth setting that is higher than the maximum specified by the client. The absence of the speed= modifier allows the Elluminate Live! server to communicate with each client based solely on each client s bandwidth settings. Note that any bandwidth limitation in this template section can be overridden on a per-classroom basis through the use of additional speed= modifiers in specific operation parameter files (see below). Properties Section This section specifies: The ability for moderators to see private messages and the permission status of participants immediately after the last moderator leaves. 32 Elluminate Live! Installation and Configuration Guide

35 Chapter 5 Creating Virtual Rooms If supervised="true" is provided, moderators can see all private messages, and participants will lose all virtual room communication permissions when the last moderator leaves the room. If supervised="false" is provided, moderators do not see all private messages, and participant s permissions are unchanged when the last moderator leaves the room. The starting permission status of participants joining a virtual room. If defaultaccess="false" is provided, participants will enter virtual rooms with all of their permissions off. If defaultaccess="true" is provided, participants will enter virtual rooms with all of their permissions on. To ensure consistent behavior, the properties section should be included in every.tmpl file. The recommended default behavior of supervised="true" and defaultaccess="false" ensures that there are no unmonitored communications in a virtual room. Moderators must always be present for participants to communicate with each other and moderators are always privy to participant interactions. Labels Section This section specifies the names that are used to identify the moderator and participant roles as well as the names used for sessions and breakout rooms. For instance, by changing the moderator= settings, the moderator role could be changed to teacher or tutor. All references to moderator in the virtual room would reflect the new setting. If one of the role names is changed, all plural and capitalization forms of that role should be changed. For example, if a moderator is to be known as a teacher in the virtual room, the following four strings should be provided: teacher, Teacher, teachers, Teachers. Authorization Section This section specifies the default authorization mechanism that is to be used to validate participants and moderators entering a virtual room. There are two supported mechanisms: 1. User List Authentication - The user names and passwords of the participants are specified via name lists. 2. URL Authentication User names and passwords are authenticated via a servlet or cgi script that is accessible to the room server by way of a URL. Both of these mechanisms are described in detail in Chapter 6 User Authorization. Elluminate Live! Installation and Configuration Guide 33

36 Chapter 5 Creating Virtual Rooms User List Authentication To specify user names and passwords via name lists, the following format is used: <auth class="fileaccessmanager"> <accessdir string="c:\program Files\ELive5\access"/> <passwordfile string="c:\program Files\ELive5\access\Master.passwd"/> </auth> The class= line is internal to Elluminate Live! and should appear as shown. The accessdir string= line specifies the directory that contains the per-room user authentication lists. The passwordfile string= line specifies the file that contains the master user authentication list. See Chapter 6 for more information. URL Authentication It is possible to perform user authentication via a web server cgi script or servlet that will lookup the participants from a database, internal data store, or whatever mechanism you choose to implement. However, this does require you to write, or already possess, a script to answer Elluminate Live! server queries. To specify user names and passwords via a servlet or cgi script, the following format is used: <auth class="remoteaccessmanager"> <url string=" </auth> The class= line is internal to Elluminate Live! and should appear as shown. The url string= line specifies a network URL for a servlet or cgi script. See Chapter 6 for more information. Services Section This section is for internal Elluminate Live! use and should not be modified. 34 Elluminate Live! Installation and Configuration Guide

37 Chapter 5 Creating Virtual Rooms Commands Section This section specifies commands that are to be executed by a virtual room immediately after it starts running. The format for specifying commands is <setup>command parameters</setup>. There are several commands that are useful to specify. 1. Set the start time that is displayed in the virtual room with: <setup>starttime set string</setup> A string value of {schedule.start,date,yyyy-mm-dd_hhmm} is used to substitute in the scheduled start time. The next section about specific operation parameters explains how to specify a schedule. If a room is auto launched, the displayed start time will be the time that the first person joined the virtual room. If this command line is omitted, no start time will be displayed in the virtual room. 2. Set the filenames (which must have a suffix of.vcr ) for session recordings with: <setup>recorder path filename</setup> If a session is recorded, it will be written to the specified file. The use of the substitution strings ensures that each recording is given a unique and easily identifiable file name. There are three possible substitution strings that may be used in filename: {schedule.start,date,yyyy-mm-dd_hhmm} is replaced with the scheduled start time. {session.name} is replaced with the name of the room (for example Toms Meeting ). {schedule.length} is replaced with the scheduled length in minutes. This value will be 0 for rooms that are automatically launched. Note that if this path is not set, recording cannot be turned on. 3. Specify the recording file append/overwrite option with: <setup>recorder options option</setup> There are two values that can be used for option: append specifies that new recordings to an existing file will add to the end of the file. This makes for longer recordings but ensures that previous recordings are not overwritten. Since new recordings are created every time a room starts up, it is strongly recommended that the append option be used. Otherwise it is possible for someone to join an auto launched room and inadvertently overwrite an earlier recording. overwrite specifies that new recordings to an existing file will overwrite the file. If no option is specified, this is the default. Elluminate Live! Installation and Configuration Guide 35

38 Chapter 5 Creating Virtual Rooms 4. Specify the recording default with: <setup>recorder mode option</setup> There are three values that can be used for option: on specifies that sessions will be recorded. The session moderator cannot control recording. off specifies that sessions will not be recorded. The session moderator cannot control recording. remote Recording is turned on and off by the session moderator. Refer to Chapter 9 for more information about session recording and playback. 5. Specify a whiteboard file to preload with: <setup>whiteboard preload URL</setup> If this command is provided, then the Elluminate Live! whiteboard file specified with URL will be automatically loaded into the virtual room when the room starts. This file must be a native Elluminate Live!.wbd whiteboard format file. The value used for URL can have either the format specification for a remote web based file, or the file:/// format specification for a local file on the Elluminate Live! server machine. This URL can also contain the substitution strings defined in point 2 above. 6. Specify that the whiteboard file contains protected content with: <setup>whiteboard ProprietaryOption</setup> There are two values that can be used for ProprietaryOption: proprietaryon specifies that that the whiteboard content is to be protected. Participants will not be able to print or save the whiteboard contents. proprietaryoff specifies that that the whiteboard content is not protected. Participants are able to print and save whiteboard contents. This is the default. This command is generally only used in concert with the whiteboard preload command (above). By using these two commands together, a room can be automatically loaded with protected content. Note that any moderator is able to change the protected state of the whiteboard from within the virtual room. 7. Specify a memory limit for whiteboard images with: <setup>whiteboard maximagecache bytes</setup> 36 Elluminate Live! Installation and Configuration Guide

39 Chapter 5 Creating Virtual Rooms If this command is provided, then the combined amount of compressed image data that can be present on all public whiteboard screens is limited to the number of bytes specified by bytes. If a room participant attempts to load an image or presentation that will exceed this total value, the user will be presented with a dialog box warning them to delete some unused images and/or reduce the number of images in their presentation. Setting this value can be useful for controlling the overall Elluminate Live! server memory usage on machines with a limited amount of memory. If this line is not provided, the default value is (10 million bytes). Updating *.tmpl Files Changes to these template files do not require the Elluminate Live! server to be restarted. The running Elluminate Live! server checks the sessions directory for *.tmpl file changes about once a minute. If any such file has been added, deleted, or updated, the changes are processed and will take effect on all subsequently launched virtual rooms. To ensure that any changes were processed successfully, just check the end of elive.log in the installed logs directory. Processing information will appear in this file no more than one minute after changes are saved to a *.tmpl file. Specific Room Parameters in.session Files Specific parameters for individual virtual rooms are provided in XML format files that have a suffix of.session. Each such file contains parameters for a uniquely named virtual room. The room name is provided at the top of the file in the Session header and is described in more detail below. These room parameter files are normally located in the sessions directory under the root installation directory. For a windows installation, this is typically C:\Program Files\ELive5\sessions. For a Linux installation, this is typically /opt/elive5/sessions. The location of the Elluminate Live! installation directory, and therefore these files, is chosen during installation and may vary between systems. In addition, it is possible to change the name and location of the sessions subdirectory by modifying the general installation XML file elive.conf (see above) after installation. A typical room parameter file, which may be called Math10.session, may look like the following: <?xml version="1.0" encoding="utf-8"?> <session conferencename="math 10"> <properties supervised="true" defaultaccess="false"/> <schedule days="mon wed fri" Elluminate Live! Installation and Configuration Guide 37

40 Chapter 5 Creating Virtual Rooms from=" " to=" " start="16:30" duration="60" grace="10" /> <schedule from=" " to=" " start="11:00" duration="180" grace="10" /> <auth class="remoteaccessmanager"> <url string=" </auth> <commands mode="append"> <setup>recorder mode on</setup> <setup>whiteboard preload file:///c:\preloads\math10.wbd</setup> </commands> </session> Note a.session file is always used in conjunction with an associated default room parameters.tmpl file. If a session is not specifically used with a named group, the.session file will instead be used in conjunction with the default.tmpl file, which is normally called Default.tmpl. Session Header Section This header section specifies: The name of the Elluminate Live! session for which the settings in the file are to apply. The conferencename="group/name" specification is used to uniquely identify the optional associated group and the name of the room for which the included parameters apply. Note that NAME and GROUP can be any alphanumeric string and that the name, but not the group, is displayed in the title bar of the running virtual room. To generate a web link to this virtual room, the session name in the associated JNLP file must match the group and name provided in this heading. For example, if conferencename="advancedmath Math 10" was used to define the session, the group name in the associated.tmpl file would be AdvancedMath, and the session name in the associated JNLP file would be AdvancedMath Math 10. See Chapter 7 Elluminate Live! Web Links for more details. 38 Elluminate Live! Installation and Configuration Guide

41 Chapter 5 Creating Virtual Rooms Peak bandwidth limits. It is possible to limit the peak bandwidth of each connection to the running virtual room session. This may be desirable if the Elluminate Live! server is hosted on a machine with limited or shared connectivity to the Internet. Peak participant bandwidth is limited by providing the speed= construct. For example, to limit peak speed to 56 kilobits per second, the string speed= would be used. Valid options are: speed= speed= speed= speed= speed= Regardless of this setting, the Elluminate Live! server will not establish a connection to a client at a peak bandwidth setting that is higher than the maximum specified by the client. The absence of the speed= modifier allows the Elluminate Live! server to communicate with each client based solely on each client s bandwidth settings. Note that any bandwidth limitation in this template section will override the use of alternate speed= modifiers in the associated.tmpl file. Properties Section This optional section specifies: The ability for moderators to see private messages and the permission status of participants immediately after the last moderator leaves. If supervised="true" is provided, moderators can see all private messages, and participants will lose all virtual room communication permissions when the last moderator leaves the room. If supervised="false" is provided, moderators do not see all private messages, and participant s permissions are unchanged when the last moderator leaves the room. The starting permission status of participants joining a virtual room. If defaultaccess="false" is provided, participants will enter virtual rooms with all of their permissions off. If defaultaccess="true" is provided, participants will enter virtual rooms with all of their permissions on. Elluminate Live! Installation and Configuration Guide 39

42 Chapter 5 Creating Virtual Rooms The default behavior of supervised="true" and defaultaccess="false" ensures that there are no unmonitored communications in a virtual classroom. Moderators must always be present for participants to communicate with each other and moderators are always privy to participant interactions. This section is not normally included in a.session file as the defaults in the associated.tmpl file usually provide the desired behaviors. Schedule Section This mandatory section specifies the scheduled times that the current room is to be automatically started. By providing multiple versions of this section, any number of scheduled times may be specified. The format of a schedule entry is as follows: <schedule Mandatory. Heading days="mon wed fri" Optional. The weekdays on which the class will run. Valid space separated values are mon, tue, wed, thu, fri, sat, and sun. If no days are specified, the class will run on each day between the start and end dates (inclusive). from=" " Optional. First date in the form YYYY-MM-DD. to=" " Optional. Last date in the form YYYY-MM-DD. start="16:30" Mandatory. Start time in 24 hour format: HH:MM duration="60" Mandatory. The session duration in minutes. grace="10" Optional. The amount of time in minutes that the room is to open early and close late. /> Note that if this section is not included, the room will never start. Authorization Section This optional section specifies the authorization mechanism that is to be used to validate participants and moderators entering the specified virtual room. This section is only required if the desired authentication method differs from the one specified in the associated.tmpl file. As with the default room parameters specified in.tmpl files, there are two supported mechanisms: 1. User List Authentication 2. URL Authentication Both of these methods are described in detail in Chapter 6 User Authorization. 40 Elluminate Live! Installation and Configuration Guide

43 Chapter 5 Creating Virtual Rooms User List Authentication To specify user names and passwords via name lists, the following format is used: <auth class="fileaccessmanager"> <accessdir string="c:\program Files\ELive5\access"/> <passwordfile string="c:\program Files\ELive5\access\Master.passwd"/> </auth> The class= line should appear as shown. The accessdir string= line specifies the directory that contains the per-room user authentication lists. The passwordfile string= line specifies the file that contains the master user authentication list. See Chapter 6 for more information. URL Authentication It is possible to perform user authentication via a web server cgi script or servlet that will lookup the class participants from a database, internal data store, or whatever mechanism you choose to implement. However, this does require you to write, or already possess, a script to answer Elluminate Live! server queries. To specify user names and passwords via a servlet or cgi script, the following format is used: <auth class="remoteaccessmanager"> <url string=" </auth> The class= line should appear as shown. The url string= line specifies a network URL for a servlet or cgi script. See Chapter 6 for more information. Commands Section This optional section specifies commands that are to be executed by the virtual room immediately after it starts running. These commands can either replace or be appended to the commands specified in the associated default room parameters.tmpl file. To replace the commands of the associated.tmpl file, include the string mode="replace" after <commands. Elluminate Live! Installation and Configuration Guide 41

44 Chapter 5 Creating Virtual Rooms To add to the existing commands, include the string mode="append". If the mode is not specified, mode="replace" is assumed. Note that, in append mode, commands provided in this section will override equivalent commands provided in the.tmpl file. Any command that can appear in the default room parameters.tmpl file (documented above), can appear in this section. This section is primarily used in append mode in conjunction with the equivalent section in the associated default room parameters.tmpl file. The session start time, recorder path, recorder file append option, and default recording action (on, off, or remote), are all normally set in the.tmpl file. This section is then used to alter the recording action for the current room with: <setup>recorder mode option</setup> There are three values that can be used for option: on specifies the session will be recorded. The session moderator cannot control recording. off specifies that session will not be recorded. The session moderator cannot control recording. remote specifies that the recording is turned on and off by the session moderator. Refer to Chapter 9 for more information about session recording and playback. This section is also sometimes used to specify a whiteboard file that is to be automatically loaded into the virtual room: <setup>whiteboard preload URL</setup> The URL to load must be a native Elluminate Live!.wbd whiteboard format file. The value used for URL can have either the format specification for a remote web based file, or the file:/// format specification for a file that is local to the Elluminate Live! server machine. Creating, Updating, and Deleting.session Files Changes to these files do not require the Elluminate Live! server to be restarted. The running Elluminate Live! server checks the sessions folder for new, changed, or deleted files with the.session suffix about once a minute. If a file has been added or updated, it is processed and changes will take effect on all subsequently launched virtual rooms. If a file has been deleted, previously scheduled launches of the associated room will be cancelled, and if the room is currently running, it will be immediately shut down. To ensure that all file changes were processed successfully, just check the end of elive.log in the installed logs directory. Information and errors will appear in elive.log when.session files are processed. 42 Elluminate Live! Installation and Configuration Guide

45 Chapter 5 Creating Virtual Rooms Elluminate Live! Installation and Configuration Guide 43

46 Chapter 6 User Authorization Chapter 6 User Authorization Elluminate Live! Server supports two virtual room user access control mechanisms; User List Authentication, and URL Authentication. User List Authentication uses user lists and passwords that are stored in appropriately named and formatted files. These files are typically stored in the installed Elluminate Live! access directory. User List Authentication is easy to set up and administer, and it only requires the creation of a small number access specification files for each virtual room. The drawback of this user authentication mechanism is in its flexibility. Only an administrator with access to the authorization files can maintain the lists of users and passwords. And every virtual room must have its access control files defined even if the room is automatically launched. URL Authentication permits user access control via a web server cgi script or servlet that can lookup the participants from a database, internal data store, or whatever mechanism you choose to implement. URL Authentication can be as flexible as desired and can even tap into existing password databases that are maintained by the end users. Virtual room access can be as loose or constrained as needed. The drawback of this authentication mechanism is that it requires the necessary cgi scripts to be written. Each of these user authentication methods is described in detail below. User List Authentication User List Authentication provides access control through a number of files that typically reside in the installed access directory. The location of the access control files is defined in the.tmpl files and in specific.session files. Refer to Chapter 5 for a description of.tmpl and.session files. User List Authentication provides a single central file that contains the user names and their passwords -- normally called master.passwd. Additional files are defined for each virtual room that define: the room s Moderator or Chair ; optionally a universal password for the room; and optionally a user list that may or may not be used to supersede the passwords in the master.passwd file. Each of these four files is described below and working examples of these files can be found in the examples subdirectory under the installed access directory. 44 Elluminate Live! Installation and Configuration Guide

47 Chapter 6 User Authorization The Master Password File master.passwd This master password file is typically called master.passwd and normally resides in the installed access directory. It contains the central list of users and their passwords. Each line in this file should contain a single user/password specification in the form: "USER NAME=PASSWORD". Spaces are permitted in both the user name and the password. Note that blank lines and lines starting with are ignored. An example file: The master password list follows. Tom=to Hal=hh Dean=de Ward=wa Bruce=bs Jannal=jvs Mike=mm Heather=hs Mary=mp The User List File {Room Name}.users This file contains a list of logon id's for a specific virtual room that is identified by the name of the file itself. The prefix of the file name MUST match the conference name of the associated virtual room, optionally with spaces and other special characters removed. Each line in this file should contain a single user specification in the form: "USER NAME" or "USER NAME=PASSWORD". Spaces are permitted in both the user name and the password. Note that blank lines and lines starting with are ignored. Passwords provided in this file are specific to the associated virtual room. If a username is provided without a password, then that user MUST be listed in the "Master.passwd" file. If a specific user list is not desired, a general password can be defined in the file "{Room Name}.passwd". In fact, the general password file must be provided if this User List File does not exist. An example file: The list of users for this virtual room are as follows: Tom Hal Dean Ward Bruce Give Jannal a unique password for this room. Elluminate Live! Installation and Configuration Guide 45

48 Chapter 6 User Authorization Jannal=newpwd Mike Fred does not exist in master.passwd, so assign a password here Fred=ff The Room Password File {Room Name}.passwd This file contains a single general access password for a virtual room that is identified by the name of the file itself. The prefix of the file name MUST match the conference name of the associated virtual room, optionally with spaces and other special characters removed. The one significant line in this file specifies the general access password. Spaces are permitted. During user authentication, this password can be used with arbitrary user names to gain access to the associated virtual room. Users that appear in the associated file "{Room Name}.users" CANNOT use this password. They must each use their own passwords that are defined in the "{Room Name}.users" file, or if not defined there, in the Master.passwd" file. If a general password is not desired, do not provide this file. Instead, create the "{Room Name}.users" file and list the accepted login id's. Blank lines and lines starting with are ignored in this file. An example file: The general password for arbitrary users is as follows: Generic The Room Chair File {Room Name}.chair This file contains the moderator name, or chair, of a virtual room that is identified by the name of the file itself. The prefix of the file name MUST match the conference name of the associated virtual room, optionally with spaces and other special characters removed. This file MUST exist in order for a moderator to be defined for a virtual room. The one significant line in this file specifies the user name of the moderator or "chair". Spaces are permitted in the user name. (Note that the password for the moderator IS NOT defined in this file.) Blank lines and lines starting with are ignored in this file. An example file: The moderator for this room is as follows: Jannal 46 Elluminate Live! Installation and Configuration Guide

49 Chapter 6 User Authorization URL Authentication URL Authentication provides access control through a web server cgi script or servlet. This script or servlet can lookup the participants from a database, internal data store, or implement whatever mechanism you wish. The location of the script or servlet URL is defined in.tmpl file and in.session files. Refer to Chapter 5 for a description of these files. Implementing an Authentication Script The Elluminate Live! server will query the authorization URL whenever a user tries to join. The specific requests, and the parameters of the requests, are passed to the single authorization URL as parameters to an HTML get query. The response is returned as the content of the request. In the unique circumstances of the Web Server and the data available to it, the cgi script simply needs to be able to answer two requests appropriately: 1. A user request to validate a room participant. The reply is y or n. 2. A chair request to ask who is the moderator or chair of the conference. The reply is the name of the chair. Authenticating a user The following parameters are supplied to the authentication URL, from the Elluminate Live! server, to determine if a user may join a room: req=mayattend Specifies that this request is asking if the named user may attend the room conf=<conference name> Specifies the name of the conference (room) being joined. Spaces in the conference name will be encoded according to the URL encoding conventions. (eg. Room 1 would be encoded as conf=room+1) name=<user name> The name of the user wishing to join the room, encoded using URL encoding conventions. challenge=<challenge> The random challenge value sent by the server to the client being authenticated. response=<response> The MD5 hash of the challenge string concatenated with the authentication token. The authentication server should compute this value from the supplied challenge and known authentication token. If the hex values match, then the user may join the room. This challenge/response mechanism allows authentication without ever sending the authentication token over the network, either between the Elluminate Live! Elluminate Live! Installation and Configuration Guide 47

50 Chapter 6 User Authorization server and the client, or between the Elluminate Live! server and the authentication server. The response determines if the user can join the room. If the first character of the response is a y the user may join. If the first character is an n the user may not join the room. Any other response is considered an error, and the user cannot join. Identifying the Chair The following parameters are supplied to the authentication URL, from the Elluminate Live! server, to determine the name of the chair of the conference. req=getchair Specifies that this request is asking for the name of the room chair. conf=<conference name> Specifies the name of the conference (room) for which the chair is being requested. The response is the name of the room chair. The Elluminate Live! server matches the returned name against the user name to determine if the user is the chair. The user must still be authenticated to join the conference. Example Script The following section provides an example of a CGI script that could be used to authenticate participants if used as the target of an Authentication URL for An Elluminate Live! server. This script implements a user authentication strategy that is equivalent to the User List Authentication mechanism. It uses the same master.passwd file and the same {Room Name}.chair, {Room Name}.users, and {Room Name}.passwd files that are used by the User List Authentication method. The one difference is that, unlike User List Authentication, spaces and special characters in the conference name are not removed to determine the access control file s {Room Name}. It is not recommended that this CGI script be used. It is supplied only as an example of how to implement URL Authentication. CGI Perl Script The example CGI Perl script show below can be found on the CD-ROM in the web-server/resources/example_cgi_scripts directory. Separate Windows and Linux versions of this script are located under their respective subdirectories. To implement this script, you may have to change the $accessdir variable (see bolded line below) from "/opt/elive5/access/" to the appropriate pathname for your Web Server. On Windows, for instance, this might 48 Elluminate Live! Installation and Configuration Guide

51 Chapter 6 User Authorization be "C:\\Program Files\\ELive5\\access\\". The first line of the script might also have to be updated to reflect the location of Perl.!/usr/bin/perl This CGI script performs remote authentication for An Elluminate Live! server using MD5 challenge/response authentication. use Digest::MD5; Set the directory containing the access files, and the path to the master password list $accessdir = "/opt/elive5/access/"; $master = "$accessdir/master.passwd"; parse the URL arguments into name/value pairs and decode the = split(/&/, $ENV{'QUERY_STRING'}); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%([a-fa-f0-9][a-fa-f0-9])/pack("c", hex($1))/eg; $ARGS{$name} = $value } extract the request and conference name $req = $ARGS{'req'}; $conf = $ARGS{'conf'}; if ($req eq "getchair") { get the chair for the conference $chair = getchair($conf); send it to the caller print "ContentType: text/plain\n\n"; print "$chair\n"; } elsif ($req eq "mayattend") { Determine if a specific user may join the conference Get the name, challenge, and responses from the login attempt $name = $ARGS{'name'}; $challenge = $ARGS{'challenge'}; $response = $ARGS{'response'}; Determine if they are valid $answer = mayattend($conf, $name, $challenge, $response); Send the result to the caller Elluminate Live! Installation and Configuration Guide 49

52 Chapter 6 User Authorization print "ContentType: text/plain\n\n"; print "$answer\n"; } else { Unknown reauest dienice("unknown request $req"); } exit; Determine if a named user is authenticated into a specific conference based on the challenge/response pair sub mayattend { my($conf,$name,$challenge,$response) try to get the users password for this conference. If there is none, then the user may not join $pw = getpassword($conf,$name); if (!defined($pw)) { return "no"; } Construct the key, consisting of the challenge concatenated with the response as unicode characters. As perl doesn't support unicode very well, we just prepend a 0 byte to each character. This is fine for the challenge, which is a hex number, but only works for password which are in the ASCII7 set. $key = "$challenge$pw"; $key =~ s/./\0$&/g; Compute the MD5 hash of the combined key. $md5 = Digest::MD5->new(); $md5->add($key); $verify = $md5->hexdigest(); Force the case of the two hex hashes to be the same before comparing $verify =~ tr/abcdef/abcdef/; $response =~ tr/abcdef/abcdef/; The user is authenticated if what they sent matches what we computed $answer = ($verify eq $response)? "yes" : "no"; } return "$answer"; Get the name of the conference chair sub getchair { my($conf) 50 Elluminate Live! Installation and Configuration Guide

53 Chapter 6 User Authorization try to open the chair file for the conference. If we can't then the conference does not exist, and we send an error. open(inf, "$accessdir$conf.chair") dienice(" Unknown conference close(inf); foreach $line (@lines) { $content = getcontent($line); if ($content ne "") { return $content; } } } dienice(" No chair defined for conference $conf"); Get the password for a named user in a conference. sub getpassword { my($conf,$name) try to get a specific password for this user $pw = getuserpassword($conf,$name); if there is no password for this user, see if there is a generic password for the conference if (!defined($pw)) { $pw = getconferencepassword($conf); } } return $pw; Return a user-specific password for this conference, either specified directly in the users file as user=password or from the master password file, if the users file just contains the user name sub getuserpassword { my($conf,$name) open the user list file for the conference. If it does not exist, then there are no users specifically allowed in. open(inf, "$accessdir$conf.users") return close(inf); iterator over the lines looking for one with a matching user name foreach $line (@lines) { $content = getcontent($line); ($user,$pass) = split(/=/, $content); Elluminate Live! Installation and Configuration Guide 51

54 Chapter 6 User Authorization if ($user eq $name) { } } we have found the user name. If a password is included, return it, otherwise, look in the master password file for the users password if ($pass ne "") { return $pass; } else { return getmasterpassword($name); } } If we didn't find the users name, return that the password is undefined return undef; Get a users password from the master password file. sub getmasterpassword { my($name) try to open the master password file. If we can't, return that there is not password available open(inf, $master) return close(inf); Iterator over the master user list, until we find the named user, then return their password foreach $line (@lines) { $content = getcontent($line); ($user,$pass) = split(/=/, $content); if (user eq $name) { return $pass; } } } if we didn't find the user in the list, return that the password is not defined return undef; Get the conference wide generic password sub getconferencepassword { my($conf) Try to open the conference password file. if it can't be opened then there is not generic conference password 52 Elluminate Live! Installation and Configuration Guide

55 Chapter 6 User Authorization open(inf, "$accessdir$conf.passwd") return close(inf); iterate over the lines and return the first non-blank, non-comment line as the password foreach $line (@lines) { $content = getcontent($line); if ($content ne "") { $pw = $content; last; } } } return $pw; Take a line read from a file and strip comments and leading/trailing whitespace from them sub getcontent { my($line) Trim the trailing newline chomp($line); trim any comments ($content,$comment) = split(//, $line); Trim leading and trailing whitespace $content =~ s/^\b*(.*)\b*$/$1/; } return the content of the line return $content; Report an error by returning an invalid access status and an error message sub dienice { my($errmsg) print "Status: 403 Invalid access\n"; print "ContentType: text/plain\n"; print "\n"; print "Error: $errmsg\n"; exit; } Elluminate Live! Installation and Configuration Guide 53

56 Chapter 7 Elluminate Live! Web Links Chapter 7 Elluminate Live! Web Links Java Web Start and XML-based JNLP files from Sun Microsystems provide an established mechanism for automatically downloading and launching java-based programs from a web page. Java Web Start is not available for the Macintosh OS 9.0 to 9.2. For these operating environments, Elluminate provides Open JNLP to perform the web launching function. Once Java Web Start or Open JNLP is installed on the client machine, clicking on an HTML link to a JNLP file in a browser will invoke Java Web Start (or Open JNLP), which in turn, will interpret the JNLP file to determine how to download and then launch the application. When Java Web Start launches the application, it passes along any parameters that are specified in the JNLP file. With the client side Elluminate Live! application, the JNLP parameters include; the conference name, server host address, and the preferred Elluminate Live! server conference port. The Elluminate Live! Java application uses this information to join the appropriate Elluminate Live! virtual room. For this whole process to work, you need to: 1. Make the Elluminate Live! client java-executable files (JAR files) available on your web site. 2. Create unique JNLP files for each Elluminate Live! virtual room. 3. Create web pages that contain the links to the JNLP files. 4. Define the JNLP mime file type on the web server. The web-server directory on the CD-ROM contains the Elluminate Live! client JAR files, an example web page with JNLP links, and example JNLP files. Making JAR Files, Web Start, and Open JNLP Accessible The JAR files, the Java Web Start installers, and the Open JNLP installer, need to be accessible through a Web Server. The Web Start and Open JNLP downloads will be referenced through a link on a Web Page. The JNLP files that start the Elluminate Live! client, will be accessible on Web Pages as links, and these files will refer to the JAR files through the codebase directive. 54 Elluminate Live! Installation and Configuration Guide

57 Chapter 7 Elluminate Live! Web Links The codebase directive locates the JAR files (relative to the top of the Web Server s DocumentRoot). Creating JNLP Files for Each Virtual Room A JNLP file is a statement to Java Web Start about the aspects of the Elluminate Live! client s configuration, and connection to An Elluminate Live! server. In the following excerpt from a JNLP file, you will note four highlighted areas; the codebase or JAR file directory, the room server hostname or IP, the room server Conference Port, and the room name. These areas indicate where you need to make substitutions from your knowledge of the Web Server s JAR file directory, and the names and numbers assigned by you to the room. <?xml version="1.0" encoding="utf-8"?> <!-- JNLP File for Elluminate Live! --> <jnlp spec="1.0+" codebase="*** insert URL of directory containing the class jar files here ***"> <information> <title>elluminate Live!</title> <vendor>elluminate</vendor> <description>web Collaboration</description> </information>... <application-desc main-class="com.elluminate.live.academic.main"> <argument>-url</argument> <argument>jinx://*** insert server hostname or IP here ***:*** insert IP port here ***/*** insert room name here ***</argument> </application-desc> </jnlp> The codebase directory is specified as an URL at the beginning of the JNLP file. An example codebase specification line for a web directory at would be: codebase= > The remaining Elluminate Live! information is specified in a single URL near the end of the JNLP file with the format: jinx://server Host Name:Optional Port/Classroom Name Note that this URL must appear in the JNLP file between the strings <argument> and </argument> and that the argument lines should appear in the order shown above. An example URL for a Math 10 virtual room configured on port 2187 on a machine located at IP address would be: jinx:// :2187/math 10 or jinx:// /math 10 Since 2187 is the default Elluminate Live! port, it does not have to be specified. Elluminate Live! Installation and Configuration Guide 55

58 Chapter 7 Elluminate Live! Web Links To indicate that the room belongs to a specific group, just prefix the room name with the group name and then a. For example, if the room name is Math 10, and the group name is AdvancedMath, then the full session name that must be inserted into the JNLP file would be AdvancedMath Math 10, as in the following example: jinx:// /advancedmath Math 10 Group names and session names are described in more detail in Chapter 5. Note that the room name will show up in the top window bar of the running virtual room, but the group name prefix, will not. Creating Web Pages to Launch the Elluminate Live! Client When you create Web Pages to launch the Elluminate Live! client, you are making html HREF references to the JNLP files. To ensure that a user clicking on this reference will automatically get Java Web Start to launch the virtual room, the web server must have a MIME Type defined for JNLP: application/x-java-jnlp-file jnlp Refer to your web server s documentation to determine how to add a mime type definition. You then simply create appropriate JNLP files and create a web page referring to them, as in the following example: <html> <head> <title>elluminate Live!</title> </head> <body> <a href=lib/j2re-1_4_2_03-windows-i586-p.exe>download Java Web Start</a> <p> <a href=example.jnlp>enter Room</a> </body> </html> 56 Elluminate Live! Installation and Configuration Guide

59 Chapter 8 Administrative Tools Chapter 8 Administrative Tools Elluminate Live! Administration Overview It is possible to perform the majority of the Elluminate Live! Server administration tasks by manipulating and/or reviewing the following files: File Administrative Controls For More Information elive.conf Updating the site license key file path Changing the available server bandwidth Changing the TCP/IP Conference Port numbers for the Elluminate Live! Server Changing the TCP/IP Control Port numbers for the Elluminate Live! Server Changing the Elluminate Live! server log file location *.tmpl *.session Defining the default virtual room participant permissions Defining the virtual room user authentication method Defining the name of an associated Elluminate Live! group for which the settings in the file are to apply Turning session recording to on, off, or remote Specifying whether recordings should overwrite or append to exiting files Setting session peak bandwidth limitations Creating virtual room schedules Allowing/Preventing the automatic creation of virtual rooms Setting the virtual room Start Time display value Specifying preloaded whiteboard slides for rooms Chapter 5 Chapter 5 Master.passwd {Room Name}.chair {Room Name}.users {Room Name}.passwd Managing the virtual room user and password lists. Chapter 6 Elluminate Live! Installation and Configuration Guide 57

60 Chapter 8 Administrative Tools elive.log Review history of processing errors, user access attempts, virtual room starts and stops, etc. Chapter 5 It is not possible, however, to get a view into the running Elluminate Live! server by simply updating and observing these files. Rather, the Admin Console tool can be used to obtain, and affect, the status of the Elluminate Live! server and any running classrooms. The Admin Console Elluminate Live! server is installed with an Admin Console utility. This Admin Console can be used for the following unique functions: View a list of the running and scheduled rooms. View a list of connected users in each running room. Remove a user from a running room Suspend access to any currently running room Shutdown any currently running room Shutdown the Elluminate Live! server (the Admin Console cannot be used to start the server). In addition, it is also possible to use the Admin Console to define and/or delete scheduled Elluminate Live! sessions. This has the effect of creating and/or deleting.session files. Using the Admin Console The Admin Console communicates with the Elluminate Live! server on a TCP/IP Control Port that is specified in the elive.conf file. Controlling Access to the Admin Console To prevent unauthorized access, a user wishing to use the Admin Console with a specific server must have a cryptographic key and password issued to them. Keys are generated by the Admin Key Tool or Admin Key Manager. Administration keys, and the certificates used to verify them, are stored in key files. The server has a master key file called Master.keys that is stored in the installed Elluminate Live! lib directory. The master key file contains the server master key, and a certificate for each user allowed to use the Admin Console. When the Elluminate Live! Server is installed, a master key is generated and stored in the master key file. 58 Elluminate Live! Installation and Configuration Guide

61 Chapter 8 Administrative Tools Each user who can access the admin console has an administrative key file. This file is created when the user s administration key is generated with the Admin Key Tool or Admin Key Manager. The user key file contains the user s administration key and a certificate for the server master key. Each user key file is encrypted with a password. GUI Admin Key Tool The Admin Key Tool is a GUI tool used to maintain the key files which control access to the Admin Console. This tool, called AdminKeyTool, is installed in Windows under the Elluminate Live! Version 5 program group in the start menu. Under Linux, this program can be found under the installed Elluminate Live! bin directory. Multiple encryption keys may be created with this tool, providing the ability to assign a unique key to each administrator, and permitting easy key revocation. When the Admin Key Tool is invoked for the first time, only the key file for the server will be listed. (The server key file is created by the installer, called Master.keys, and is located in the lib directory under the root of the installed Elluminate Live! directory.) To create a new key, click on the Create Admin Key button. Follow the instructions to provide: the name of the key owner; a password for the administration key file; and the pathname of the administration key file itself. After the key is created it will be shown in the list. You may create as many key files as you wish. To delete a key and therefore invalidate the associated key file, select it from the list and click on the Delete Admin Key button. Changes to the Administrative keys (stored in the Master.keys file) will be picked up by the Elluminate Live! server immediately and do not require a restart of the server. Command-Line Admin Key Manager Sites running their Elluminate Live! Server Scheduler without a windowing environment can use the AdminKeyManager utility to administer their Master.keys and administrative keys files. This tool is located in the installed Elluminate Live! bin directory. AdminKeyManager is a command-line utility that supports the following arguments: Elluminate Live! Installation and Configuration Guide 59

62 Chapter 8 Administrative Tools Argument Description -add name path Generates a new key with the specified user name and writes it into the administrative key file specified by path. The AdminKeyManager tool will prompt for the password for this name. It is possible to put multiple add commands on a single command line. The certificate for this key will be added to the master key file, and the administrative key file generated. -cpw path -del name -list -master path -quit Changes the password associated with the administrative key file found at path. Will prompt for the existing password for this file. Delete the administrative key for the specified user name. List the master and administrative keys defined for the Elluminate Live! Server Scheduler. This information is derived from the master key file. Define the path of the Master.keys file to the AdminKeyManager. This information is required for any operation. This argument is used to simply initialize the master key file and generate the server master key if it does not already exist. This is automatically done whenever one of the other operations is performed, but using quit allows the master key file to be created without performing any other operation. Starting the Admin Console The Admin Console program is called AdminConsole and is installed in Windows under the Elluminate Live! Version 5 program group in the start menu. Under Linux, this program can be found under the installed Elluminate Live! bin directory. 60 Elluminate Live! Installation and Configuration Guide