We Create Innovations for Joomla!
 
 
 
JLive! Chat Documentation
 
 
JLive! Chat Documentation PDF Print E-mail



Joomla! Webserver System Requirements:


Operator Computer System Requirements:

  • Compatible with: Microsoft Windows 98+, Windows ME, Windows NT, Windows 2K, Windows XP, Windows Vista, Redhat Linux, Fedora Linux, CentOS Linux, Debian Linux, Ubuntu Linux, Mac OS X 10.3+
  • At least 50MB free space on hard disk
  • Internet Connectivity




JLive! Chat Installation Steps:

  1. Download JLive_Chat.zip (For Windows), and extract the contents of the archive file.
  2. Install the JLive! Chat component (com_livechat.zip) onto your Joomla! Website via your Joomla! Administrator
  3. Install the JLive! Chat plugin (plugin_livechat.zip) onto your Joomla! Website via your Joomla! Administrator
  4. Generate an operator access key file by going to 'JLive! Chat -> Operators' from within your Joomla! Administrator
  5. Create a 'JLive! Chat - Popup Window' menu item through the Menu Manager from within your Joomla! Administrator
  6. Install the JLive! Chat desktop application onto your computer by running (JLive_Chat_Setup.exe)
  7. Launch the JLive! Chat desktop application, Select 'File -> My Websites' from the top menu, and Open the new website wizard by clicking on the New button (specify the key file you generated in step 5)
  8. That's it, JLive! Chat is now installed and listening for live chat requests. The JLive! Chat application you installed onto your computer will await any livechat requests from your Joomla! website(s).
  9. Next you should disable your webserver's logging feature since JLive! Chat will be making numerous requests to your webserver in order to synchronize data. This step is optional but is highly recommended otherwise you may face webserver performance degradation and/or your hard disk filling up. You can read how to disable your webserver's logging here. If you do not have access to change your server configuration files, or if you are in a shared hosting environment, we highly recommend using our hosted version of JLive! Chat instead at the Ultimate Live Chat.com




Multi-Computer/Multi-Operator Setup:

In order to setup multiple operators/multiple computers to use JLive! Chat, you must generate a separate key for each operator/computer.



Disable Webserver Logging:

Disabling logging for certain requests to your webserver will prevent performance degradation and/or your hard disk filling up. This step is not required but is highly recommended. If you do not have access to change your server configuration files, or if you are in a shared hosting environment, we highly recommend using our hosted version of JLive! Chat instead at the Ultimate Live Chat.com

Edit your Joomla! website's .htaccess file, and insert the following 2 lines under "RewriteEngine On", so the end result will look like this:
RewriteEngine On

RewriteCond %{QUERY_STRING} do_not_log=true [NC]
RewriteRule ^.*$ - [E=dontlog:1]

Then edit your virtual host configuration file, and follow the steps for your platform below.

Apache Webserver Instructions

  • Edit your virtual host configuration file, which is usually named httpd.conf, or apache2.conf, or <your-site-name>.conf and add "env=!dontlog" to the end of the "CustomLog" attribute, and add "AllowOverride All" or "AllowOverride FileInfo" so that it looks like this: <VirtualHost www.yourdomain.com:80>

    DocumentRoot "/var/www/vhosts/www.yourdomain.com/httpdocs"
    ServerName www.yourdomain.com


    ......                            <-- Some other lines here

    <Directory "/var/www/vhosts/www.yourdomain.com/httpdocs">

    ......                            <-- Some other lines here


    # Either AllowOverride FileInfo, or AllowOverride All
    AllowOverride All

    </Directory>


    # Add env=!dontlog to the end of the CustomLog Attribute
    CustomLog /var/www/vhosts/www.yourdomain.com/logs/access.log common env=!dontlog



    ......                            <-- Some other lines here


    <VirtualHost>
  • Save those changes and restart apache.


Plesk Webserver Instructions

  • Edit /var/www/vhosts/<your-website.com>/conf/httpd.include and add "env=!dontlog" to the end of the "CustomLog" attribute. The end result should look something like this: <VirtualHost 100.22.22.22:80>

    CustomLog /var/www/vhosts/<your-website.com>/statistics/logs/access_log plesklog env=!dontlog
  • Save those changes and restart apache. You can restart apache by issuing the following command on linux:

    /etc/init.d/httpd restart

    or

    /etc/init.d/apache2 restart

  • The only drawback on Plesk is that if you change your virtual host's settings through the Plesk Administration site, your changes to the httpd.include file will be overwritten by plesk. One way to work around this is to keep a backup copy of your httpd.include and perhaps name it httpd.good.include. That way if Plesk overwrites your httpd.include file, then you can just copy the correct httpd.good.include over the incorrect httpd.include file.





Building a Custom Installation File:

You can use Nullsoft Scriptable Install System (NSIS) to create your own custom JLive! Chat setup file (JLive_Chat_Setup.exe).Edit the installer.nsi file to your needs and then open the installer.nsi file with Nullsoft Scriptable Install System (NSIS) and it will automatically bundle a new JLive_Chat_Setup.exe file with your custom changes.





Hiding Help Menu Items (Custom Branding):

You can hide all the "Help" menu items within the JLive! Chat desktop application, except for the "Debug Report" menu item, by placing a file named custom.lock in the JLive! Chat application directory.

You can also create your own custom JLive_Chat_Setup.exe setup file  for distribution, which contains the custom.lock file by default, by following the instructions specified in the "Build a Custom Installation File" section in this documentation.





Troubleshooting:

In order for JLive! Chat to be able to function properly, it must have access to insert its required Javascript file into your template's <head></head> tag. Please ensure that your template contains the following line within the opening and closing <head></head> tag:

<jdoc:include type="head">

Your Joomla! template's <head></head> section should look something like this: <head>
<jdoc:include type="head">
......                            <-- Some other lines here
</head>


For proper functionality, Please ensure that the allow_url_fopen is set to "On" in your webserver's php.ini file.

Your Joomla! Administrator is usually located @ http://<your-site>/administrator

If you have any further questions or support issues, please contact us by submitting a support ticket.

Last Updated on Sunday, 31 January 2010 17:05