Instructions for Integrating Gong with Moodle

These are the instructions for integrating Gong with Moodle.

  1. Install Gong
  2. Install Moodle
  3. Install the Gong module in Moodle
  4. Prepare the Moodle 'Base Path' in Gong
  5. Use Gong in Moodle

1. Install Gong

 
Step 1.1 INSTALL GONG
  • Setup Gong according to the Gong setup instructions
    • As Moodle will run at port 80 you need to change the configuration of Tomcat so that it uses another port (our suggestion is 8080). To do this edit server.xml and search for '80'. You will find it used by this directive:
      <Connector port="80" ...
      Change the 80 to 8080, save the file, and restart Tomcat. You can then access http://localhost:8080.
  • Please make sure Gong works before moving to step 2
    • For example, using Gong only, make a voice board, record a message, post it to the board, play it back.
    • When you do this it makes sense to use Gong as an applet rather than as an application because when Gong is used inside Moodle as an applet. You can see how to build a test web page with the Gong applet from the instruction page.
 
Step 1.2 CONFIGURE GONG
  • Edit the file gongServer.ini in the Gong server directory
  • Change the four authentication parameters in the file according to your environment
  • You must change the parameter:
    • Auth.AccessList
      If you want to use this parameter, please remove the "#" in front of it
      Set the value to the hostname of your Moodle server.
  • Most people don't need to change the following three parameters:
    • Auth.Port
      If you want to use this parameter, please remove the "#" in front of it
      Set this value if you would like to use a different port for user authentication. The default value is 8001.
    • Auth.SessionLifetime
      If you want to use this parameter, please remove the "#" in front of it
      Change this value (milliseconds) to the lifetime of a Moodle session key storing in the Gong server. The default value is 300000 (5 minutes).
    • Auth.AllowCreateUser
      If you want to use this parameter, please remove the "#" in front of it
      Change the value to 'true' or 'false' to specify whether any user can be created in the Gong system when there are requests from Moodle. i.e. if the logged on user in Moodle does not exist in the Gong system, an account will be automatically generated in Gong. The default value is 'true'.
      Warning: Set this value to 'false' may result in users unable to access any Gong activity from Moodle

2. Install Moodle

 
Step 2.1 INSTALL MOODLE
  • You can skip this stage if you already have Moodle installed
  • (We have checked that Gong works with Moodle versions 1.5, 1.6, 1.7 and 1.8)
  • If you don't have Moodle installed, then follow these steps to install it:
  • Download Moodle here
  • Setup Moodle according to Moodle setup instructions
  • Please make sure Moodle works before moving to step 3
    • For example, using Moodle only, make a course, add a student account, check whether students can access the course
 

3. Install the Gong module in Moodle

 
Step 3.1 DOWNLOAD GONG MOODLE MODULE
  • Download the Gong moodle module here
 
Step 3.2 EXTRACT THE FILES
  • You will see that all the files in the zip file are in the directory gong
  • Extract the directory and files to the directory moodle/mod/ to create moodle/mod/gong
 
Step 3.3 CONFIGURE MOODLE
  • Edit the file config.php in the directory that you have just created i.e. edit moodle/mod/gong/config.php
  • Change the following four parameters in the file according to your environment
  • You must change the following parameter:
    • $GONG_CONFIG['GongServerHost']
      Set this value to your Gong server host. Please do not use localhost or 127.0.0.1. Instead you should use the IP address or hostname of your Gong server
  • Most people don't need to change the following three parameters:
    • $GONG_CONFIG['GongServerPort']
      Change this value to your Gong server port. The default value is 8000. You should not change this value if you have not changed it in step 1.1
    • $GONG_CONFIG['GongServerAuthenticationPort']
      Change the value to your Gong server authentication port. The default value is 8001. You should not change this value if you have not changed it in step 1.2
    • $GONG_CONFIG['ChineseInput']
      Change the value to true or false. The default value is false. When this setting is true, the teacher can choose whether Gong should display the Chinese Mandarin Pinyin Interface and Chinese Cantonese Yale Interface. If your class is using Pinyin or Yale for learning Chinese, set this parameter to 'true'
    • $GONG_CONFIG['GongBasePath']
      The Gong Base path is the path where the board in moodle should put. If the Gong Base Path is "/moodle". The voice board of course (e.g. COMP303) in moodle will be put inside "/moodle" (i.e. "/moodle/COMP303"). If the "Group mode" of this course is "Separate group", the voice board of each group (i.e. LA1) will be put into the "/moodle/COMP303/LA1".
 
Step 3.4 INSTALL GONG IN MOODLE
A typical admin menu
A Typical Admin Menu
  • Log on Moodle as admin
  • Click on the 'Admin..' link
  • The Gong module will be automatically installed and you will receive a message saying that the module was installed and the database tables was created
The resulting screen display after pressing "Admin..."
The Message Indicating Successful Gong Module Installation
after Pressing "Admin..." (click to enlarge image)

4. Prepare the Moodle 'Base Path' in Gong

 
Step 4.1 ACCESS THE GONG SERVER USING THE GONG APPLET OR APPLICATION
Gong Logon
Access Server Using Gong Applet or Application
(click to enlarge image)
  • Please make a Gong applet or application according to the instruction page
  • Use the applet or application to access the Gong server you have installed in step 1
  • Log on the Gong server using the administrator account
 
Step 4.2 CREATE THE MOODLE BASE PATH IN THE BOARD SELECTION WINDOW
Create the Moodle Board
Create the Moodle Board
(click to enlarge image)
  • In the Board Selection window select Create Board under the root folder "Discussion Boards"
  • Please use the name of the board as specified in the "Base Path" setting in step 3.3, the default value is "/Moodle"
    When you create the board you can remove the beginning '/' character because that indicates the root folder.
 

5. Use Gong in Moodle

 
Step 5.1 LOGIN TO MOODLE AS ADMIN OR TEACHER AND PRESS "Turn editing on"
Turn editing on
Turn Editing On (click to enlarge image)
  • Log on Moodle as admin or teacher
  • Go into a course
  • Turn the editing on by pressing the button "Turn editing on"
 
Step 5.2 ADD A GONG ACTIVITY
Add Gong
Add the Gong Activity (click to enlarge image)
  • Press "Add an activity..."
  • Select "Gong"
 
Step 5.3 EDIT GONG ACTIVITY
Edit Gong
Edit Gong (click to enlarge image)
  • You can then edit the Gong activity
  • After editing press the "save change" button