XenForo

Our installation instructions are slightly different depending on the version of XenForo you are running. Please select:

XenForo version 1.4 and higher
XenForo version lower than 1.4

Xenforo version 1.4 and higher

Installing CometChat as a Xenforo plugin (1.4+)

Step 1
Download the zip package of CometChat Plugin for XenForo to your computer.

Step 2
Unzip the package. You should see two folders (‘cometchat’ and ‘library’) and two files (‘addon-cometchat.xml’ and ‘readme.txt’).

Step 3
Upload the entire ‘cometchat’ folder to your forum system root directory. For example, if your forum URL is ‘http://www.mysite.com/forum’, it should be placed at ‘http://www.mysite.com/forum/cometchat/’.

Please CHMOD the following folders to 777 (Recursively):
/cometchat/writable/

Step 4
Upload the entire ‘CometChat’ folder from ‘library’ folder to your forum system ‘library’ directory. For example, if your forum URL is ‘http://www.mysite.com/forum’, it should be placed at ‘http://www.mysite.com/forum/library/CometChat’.

Step 5
Login to AdminCP, go to ‘Home’ -> ‘Add-ons’ -> ‘Install Add-on’. Upload ‘addon-cometchat_plugin.xml’ file that has been provided in the CometChat Plugin package and click ‘Install Add-on’.

Installing CometChat - Ready Integrations - xenForo - 1

Step 6
You will see ‘CometChat Plugin’ listed in the ‘Installed add-ons’ section. CometChat is now installed on your website.

Installing CometChat - Ready Integrations - xenForo -2

User Group permissions.

You can use the plugin to restrict CometChat usage to specific groups. For example, if you wish to prevent access to the user group ‘Registered’:

Step 1
Go to ‘Users’ -> ‘User Group Permissions’ -> ‘Registered’.

Installing CometChat - Ready Integrations - xenForo -3

Step 2
Go to ‘Personal Conversation Permissions’ and set ‘Can view CometChat’  to never.

Installing CometChat - Ready Integrations - xenForo -4

Xenforo – CometChat Message Sync

This plugin supports message synchronization with Xenforo. To enable synchronization:

Step 1
Go to ‘Home’ -> ‘Options’ -> ‘CometChat Administration Panel’.

Installing CometChat - Ready Integrations - xenForo -5

Step 2
Select ‘Would you like to sync CometChat Messages and XenForo Conversations’.

Step 3
Click ‘Save Changes’.

 
Chat With Me Button

This plugin can add a ‘Chat With Me’ Button below user avatars in Forum Threads. This button can be used to initiate a chat with the user.

Installing CometChat - Ready Integrations - xenForo -6

To set the text for this button:

Step 1
Go to ‘Home’ -> ‘Options’ -> ‘CometChat Administration Panel’.

Step 2
Set the ‘Chat With Me’ field.

Installing CometChat - Ready Integrations - xenForo -7

Step 3
Click ‘Save Changes’.

Note: If you wish to remove this simply empty the ‘Chat with Me’ field and click ‘Save Changes’.

Troubleshooting

Step 1
Sometimes the CometChat Installation might fail. The most common reason for this is that file permissions for the ‘cometchat’ folder have not been set properly.

Step 2
Sometimes the CometChat bar will appear on your site, but with broken images. To Correct this:

  1. Go to ‘Home’ -> ‘Options’ -> ‘CometChat Administration Panel’.
  2. Set the CometChat base url field.
  3. Click ‘Save Changes’.

 

XenForo version lower than 1.4

Introduction

This guide will help you through the installation process and get CometChat running on your site.

Installation is very straight forward, only taking about 5 minutes from uploading the files to viewing the CometChat bar on your site.

Before you begin, you will need an FTP client, if you do not have one, some popular solutions include FileZilla (free) or CuteFTP (trial).

You do not need programming knowledge to install CometChat, but a working knowledge of FTP functions is a plus.

This guide assumes that you have successfully downloaded the latest release of CometChat and have the zip file “unzipped” and ready to go. If not, you can download the package from the Members Area.

The instructions will term the zip file you downloaded as cometchat.zip.

Uploading

At this point, you should have the zip archive cometchat.zip and find a single folder- “cometchat”.

If you don’t know already, find out the folder in which XenForo is installed.

If you access your XenForo site via ‘http://www.domain.com’, then look for the webroot directory.

The “webroot” directory is usually ‘public_html’ or ‘www’, but this varies from server to server so if you’re unsure, contact your hosting provider.

Using your FTP client, copy the cometchat folder inside your XenForo folder. e.g. http://www.domain.com/cometchat

Installation

Step 1

You should now run the installer file through your web browser by entering the URL to it into your browser address bar (if you have followed our example, type in http://www.domain.com/cometchat/install.php, naturally substituting ‘domain.com’ for your web address).

If the installation was completed successfully, then two lines of HTML code will be displayed on your screen. Please copy these two lines. Also the page may display a list of files and folders which may require additional permissions. Please CHMOD those files/folders to 777.

Step 2

Now edit your template header.

Login to XenForo administration control panel and click on the Appearance tab.

Select Templates and search for PAGE_CONTAINER and open it for editing.

Paste the copied code immediately after <head> tag and save your settings.
Now delete install.php file from the cometchat folder.

That’s all! Now log-in to your site and you will be able to see the CometChat bar. For customizing the text, icons, plugins, theme and modules, please refer to the documentation for Administration Panel.

Not finding what you need?

The CometChat team is here to help!