dimdim web meeting Files

Deploying Dimdim Conference Server v 1..0 (Alpha) on Linux

1.0 Introduction
====================================================================

This document helps the user to download, install, configure, run and 
manage the Dimdim Conference Server.

1.1) Assumptions:

   1. Your system already has the JRE 1.5.X installed or you have the 
      system privileges to install it.
   2. You have approximately 100mb of free disk space.
   3. In case you are planning to install Dimdim conference Server in 
      a common system area like /usr/local or hive it bind to a
      privileged port number ( Port lower than or equal to 1024) then 
      you need to have an account with super user privileges to 
      install/manage the server. This document assumes that you do have
      user account with super user privileges.
   4. For the purpose of this document it is assumed that the dimdim 
      conference server will be installed in /usr/local/dimdim-1.6 and is
      referred to as ${DIMDIM_HOME} in the rest of the document
   5. The user is familiar with basic Linux shell command such ls, cd, 
      su , etc.
   6. The user is familiar with Linux text editors such as vi.


2.0 Java Runtime Environment (JRE) Verification
=======================================================================

Dimdim Conference Server requires JRE 5.0 to be installed on the system. 
To ensure that you do have the correct JRE installed on user system 
let's do following tests

2.1) Please verify the Java_Home environment variable is set by using 
     the following command. 
    
    		dimdim@elvis> env | grep JAVA_HOME
    
    If you have JAVA_HOME set in your environment - you should see the 
    output as follows. 
    		
    		JAVA_HOME=/usr/java/jre1.5.0_06
    
    And if it is not set then you should not see any output at all. It is 
    possible that you have proper java installed on your system but it is 
    just not referred in your login profile. Generally system wide 
    installation are installed in /usr and if that's the case Java could 
    be found at /usr/java. If you can find java installed in /usr/java 
    then at the command prompt do the following
    
    		dimdim@elvis> JAVA_HOME=/usr/java/jre1.5.0_06
    		dimdim@elvis> Export JAVA_HOME
    
    Once you get the JAVA_HOME setting, please use the following command to 
    find the JRE Version.
       
	dimdim@elvis>$JAVA_HOME/bin/java -version
	java version "1.5.0_08" Java(TM) 2 Runtime Environment,
	Standard Edition (build 1.5.0_08-b03)
	Java HotSpot(TM) Client VM (build 1.5.0_08-b03, mixed mode,sharing)
    
    Please ensure that the output as shown in the above example has the 
    version string start with 1.5.In case you don't find JAVA_HOME settings on 
    your system or your version is older than "JRE 5.0" then jump to Section 
    2.2 for installing the latest JRE 1.5.
    
2.2) Java Runtime Environment (JRE) Download and Installation
    
    1) Download latest JRE for Linux Platform from 
       http://java.sun.com/javase/downloads
       
    2) Please refer http://cruisenews.net/install_java_on_redhat_9.html for 
       detailed JRE Installation instructions.

2.3) Set up Java Environment
     
     Please refer to the following example to set the JAVA_HOME in the .bashrc 
     file. This example assumes that you have installed java in /usr/java 
     directory. Open the .bashrc file and enter the JAVA_HOME and PATH settings. 
     Save the .bashrc once these entries are made in the file.
    
     		dimdim@elvis>vi .bashrc
     	
		     JAVA_HOME=/usr/java/jre1.5.0_06
		     export JAVA_HOME
		     PATH=$JAVA_HOME/bin:$PATH
		     export PATH
           
      Please use the below command to execute the ./bashrc and enforce the above 
      settings.
 		
 		dimdim@elvis>source .bashrc

3.0) Downloading and Deploying Dimdim Conference Server:
================================================================================
     
This section helps the user to download, install and configure Dimdim Conference 
Server.

3.1) Downloading Dimdim Conference Server Installation Toolkit from
     http://www.sf.net/downloads to your typical download directory 
     (e.g. /home/dimdim/downloads)

3.2) Uncompress-Untar the "dimdim-1.6.tar.gz" under download directory. This 
     would create a directory named "dimdim-1.6" under the download directory. 


	i.e.dimdim@elvis>tar -xvzf dimdim-1.6.tar.gz

	-x : extract a file from archive
	-v : verbosely list files processed
	-z : ungzip the file
	-f : archive file


3.3) Move the "dimdim-1.6" directory to the desired final location. We recommend to 
     move the dimdim-1.6 directory under /usr/local. 
    		
    		dimdim@elvis>mv dimdim-1.6 /usr/local
		dimdim@elvis>cd /usr/local/dimdim-1.6
                
Note: To install the dimdim server in a system-wide location such as /usr/local, 
you must login as the root user to gain the necessary permissions. If you do not 
have root access, install the dimdim server in your home directory or a 
subdirectory for which you have write permissions. 

At this point you are ready to configure dimdim conference server before
running the conference server. Please follow the instructions in the following 
section ....


4.0) Configure Dimdim Conference Server:
====================================================================================
Configuring dimdim server requires editing 4 different text files. It is necessary 
that the dimdim conference server be stopped and re-started before and after changing 
any of the configuration files. The detail of server administration are provided in 
the following section. However; it is not necessary to stop the server if you are 
configuring the server for the first time. 
   
4.1) server.xml
---------------
This configuration file is used by the Apache Tomcat server. It is actually located at 
{DIMDIM_HOME}/dimdim-1.6/ConferenceServer/apache-tomcat-5.5.17/conf/. 

However for the sake of convenience we have created a symbolic link to the file under 
{$DIMDIM_HOME} directory. Please follow the steps to modify the relevant properties 
in this configuration file.

	dimdim@elvis>cd /usr/local/dimdim-1.6
	dimdim@elvis>vi server.xml 
       

4.1.1) IP Address:
The server could be configured so that it binds to all the available IP addresses or to 
a specific one. By default the configuration lets  the server bind to all available 
addresses and if that's desirable then it is not necessary to make any changes. However
if it is required that the server binds to a specific IP address then an additional property 
needs to be inserted in the block called <!-- Define a non-SSL HTTP/1.1 Connector -->.
Please insert an additional attribute called "address" in that block before the 
"Connector port" attribute with something like this

	e.g. address="72.232.197.107"

The modified block should look like

    <!-- Define a non-SSL HTTP/1.1 Connector -->
      <Connector address="192.168.0.6" port="DIMDIM_PORT_NUMBER" maxHttpHeaderSize="8192"
       maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
       enableLookups="false" redirectPort="8443" acceptCount="100"
       connectionTimeout="20000" disableUploadTimeout="true" />


4.1.2) Port:
The port to which the server binds to is specified by providing a correct value to the 
"Connector port" attribute. By default the attribute has vale "DIMDIM_PORT_NUMBER" which 
after the change should look like

	e.g. Connector port="80"

The modified block will look like

    <!-- Define a non-SSL HTTP/1.1 Connector -->
      <Connector address="72.232.197.107" port="80" maxHttpHeaderSize="8192"
       maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
       enableLookups="false" redirectPort="8443" acceptCount="100"
       connectionTimeout="20000" disableUploadTimeout="true" />


4.2) dimdim.properties
--------------------------------
This file contains all the information required by all different components of the dimdim 
conference server and has a name=value format. This file is actually located at 
{DIMDIM_HOME}/dimdim-1.6/ConferenceServer/apache-tomcat-5.5.17/webapps/dimdim/WEB-INF/classes/resources/. 

However for the sake of convenience a symbolic link to the file has been provided in the
DIMDIM_HOME directory. Please follow the following steps to change the relevant properties in 
this configuration file.

	dimdim@elvis>cd /usr/local/dimdim-1.6
	dimdim@elvis>vi dimdim.properties

4.2.1) dimdim.serverAddress:
dimdim.serverAddress creates the basis of the URL with which users can access the dimdim 
conference server. It is important to note that this name/address should be resolved by 
the DNS from which the user is accessing the server. And although it is possible to use the 
same address provided in section 4.1.1 - it's recommended that you provide a more friendlier 
name that resolves to the correct IP address. The default value of the property is 
dimdim.serverAddress=_ServerAddress and after modification should look like

	e.g. dimdim.serverAddress=www1.dimdim.com
	
4.2.2) dimdim.serverPortNumber:
This property is used to form the URL by which users access the dimdim conference serverThe 
value of this property should be exactly same as the value of "Connector port" attribute
configured in section 4.1.2.The default value of the property is 
dimdim.serverPortNumber=_ServerPort and after modification should look like

	e.g. dimdim.serverPortNumber=80

4.2.3) dimdim.webappLocalPath:
dimdim.webappLocalPath denotes the fully qualified path of the directory in which conference 
server web application is installed. The default value of this property is 
dimdim.webappLocalPath=WebappLocalPathRequiredForInitialization and after the change should 
look like

 	e.g. dimdim.webappLocalPath=/usr/local/dimdim-1.6/ConferenceServer/apache-tomcat-5.5.17/webapps/dimdim/
 
4.2.4) Dimdim conference server uses a set of properties to let the user describe the SMTP 
credentials. These credentials are required by the server while sending meeting invites. The set
consists of five different properties and a typical configuration should look like

	    email.server=<smtp server address> 
	    email.user=<smtp user name>
	    email.password=<smtp user password>
	    email.sender=<full email address of the above user> 
	    email.PORT=<smtp port number>


4.3) wrapper.conf:
-----------------
This file is used by the dimdim script which allows user to start / stop and monitor the server. 
This file is actually located at {DIMDIM_HOME}/dimdim-1.6/ConferenceServer/apache-tomcat-5.5.17/conf/.

However for the sake of convenience a symbolic link to the file has been provided under 
DIMDIM_HOME directory. Please follow the following steps to change the relevant properties in 
this configuration file.

	dimdim@elvis>cd /usr/local/dimdim-1.6
	dimdim@elvis>vi wrapper.conf 

The wrapper.java.command property is the only one that requires the change. The property denotes 
the absolute path for the java executable. The default value for the property is 
wrapper.java.command=DIMDIM_JAVA_HOME/bin/java which after the change should look like

	e.g. wrapper.java.command = /usr/java/jre1.5.0_03/bin/java




5.0) Configure Dimdim Streaming Server (For Adavnced Users):
====================================================================================
Dimdim Conference Server is shipped with 1 instance of Streaming Server out of which is 
activated by default.

To add more servers one needs to do the following steps:

a) copy the directory server1 under dimdim/StreamingServerCluster as serverN where N is the number 
of the streaming server (e.g. server2, server3).

	dimdim@elvis>cd /usr/local/dimdim-1.6/StreamingServerCluster
	dimdim@elvis>cp -R server1 server2

b) Now edit the serverN/conf/red5.properties to change to rtmpt port field (called "rtmpt.port")
to set the port number at which this server instance shall listen.

A thumbrule is to use 30000+N where N is the server number (server2 => N = 2)

	dimdim@elvis> vi conf/red5.properties
	
and edit the rtmpt.port field to read like:

	rtmpt.port=30002

c) Now edit the serverN/webapps/dimdimPublisher/red5-web.properties to set the virtual hosts as
127.0.0.1:<rtmpt-port> and localhost:<rtmpt-port>. For example if we set the port of server2 in the
previous step to 30002 then :

	dimdim@elvis>vi server2/webapps/dimdimPublisher/red5-web.properties

and make the second line read:

webapp.virtualHosts=*, localhost, localhost:30002, 127.0.0.1:30002

Repeat this process with N=3,4,5 etc. to create more instances of the streaming server.


User can modify the number of active Streaming Servers by modifying the 
dimdim.red5.config.count in the Red5Config.properties file. This file is actually located at 
{DIMDIM_HOME}/ConferenceServer/apache-tomcat-5.5.17/webapps/ROOT/WEB-INF/classes/resources/.
However for the sake of convenience we have created a symbolic link to the file under 
DIMDIM_HOME directory. Please follow the following steps to change the relevant properties in 
this configuration file.

	dimdim@elvis>cd /usr/local/dimdim-1.6
	dimdim@elvis>vi Red5Config.properties 
         
The default value for the dimdim.red5.config.count is "count" which after the modification 
should look like

	e.g. dimdim.red5.config.count=2

6.0) Administrating Dimdim Conference Server
===================================================================================

6.1) Start Dimdim Conference Server
Please follow the following steps to start the conference server.

	 dimdim@elvis>cd /usr/local/dimdim-1.6
	 dimdim@elvis>./dimdim start
    
It takes approximately 5-10 seconds to start the conference server on a typical configuration. 
and the server is started as the detached daemon process.The output of the start command 
looks like

	Starting Dimdim Conference Server...
	
You can verify the status of the server by specifying status command (Refer Section 6.3). However to functionally 
verify if the server has indeed started correctly; start the browser from the command line with 
http://<dimdim.serverAddress>:<dimdim.serverPort> (e.g. http://conference.dimdim.com).If you can 
see the welcome page that means the server has started properly.

You can also verify the status of the server by using status command described in next section.


6.2) Stop Dimdim Conference Server
Please follow the following steps to stop the conference server
.		 
	 dimdim@elvis>cd /usr/local/dimdim-1.6
	 dimdim@elvis>./dimdim stop
	 
It could take few seconds for the dimdim script to stop the server and the typical output 
from the command looks like 

	Stopping Dimdim Conference Server...
	Waiting for Dimdim Conference Server to exit...
	Waiting for Dimdim Conference Server to exit...
	Waiting for Dimdim Conference Server to exit...
	Waiting for Dimdim Conference Server to exit...
	Waiting for Dimdim Conference Server to exit...
	Stopped Dimdim Conference Server.

6.3) Check Dimdim Conference Server Status
Please follow the following steps to check the status of the conference server
.		 
	 dimdim@elvis>cd /usr/local/dimdim-1.6
	 dimdim@elvis>./dimdim status
	 
It could take few seconds for the dimdim script to check the server status and the typical 
output from the command looks like 

	Dimdim Conference Server is running (15810).