Overview

The AVChat Module for PHPFox 3.8 (Nebula) handles the integration between a PHPFox 3.8 web site and the AVChat video chat software.

End of life

PHPFox 3.8 (Nebula), released Nov 28, 2014, is the last release in the 3.8 series.

If you’re looking for something specific just hit Ctrl+F on your browser.

Installation Instructions

Download & extract archives

Download these 2 archives from your private client/trial area to your computer:

  1. AVChat 3.0.zip contains AVChat
  2. avchat3_phpfox30x_module.zip contains the PHPFox module

Extract the 2 archives somewhere on your computer. Here’s their contents:

Media Server Application

Once we’ve downloaded & unzipped everything the next thing we need to do is to setup the media server app to which AVChat will connect to.

AVChat uses a media server to send all the audio video and text data between users. AVChat supports the 3 major media servers:

  • Red5
  • Adobe Media Server
  • Wowza

Here’s how to install the avchat30 app on each one of them:

Upload the avchat30 folder from the Files to upload to your media server (Red5) folder to your Red5's webapps folder (C:\Program Files\Red5\webapps on Win, /opt/red5/webapps/ on Linux).

On Linux, chmod the new avchat30 folder to 666.

For versions of Red5 1.0.7 or higher one additional change needs to be made:

  1. Go to /Your_Red5_Install_Directory/webapps/avchat30/WEB-INF
  2. Open red5-web.xml with any text editor
  3. Uncomment line 37

Restart the Red5 server.

Upload the avchat30 folder (you will find it in your AVChat archive in the Files to upload to your media server (FMS) folder) to the applications folder of your AMS installation.

On Linux, chmod the new avchat30 folder to 666.

Upload the applications, lib and conf folders from the Files to upload to your media server (Wowza) folder to the root folder of your Wowza Media Server installation.

Restart the Wowza server.

Module & AVChat installation

Upload files to your website

Connect using an FTP client to your website and:

  1. upload the include and module folders from the PHPFox module archive to your website root
  2. upload the contents of the Files to upload to your web site folder from the AVChat archive to /module/avchat3/include/plugin/

Folder permissions

If your website’s hosted on a Linux server go to /module/avchat3/include/plugin/ and CHMOD the uploadedFiles and tokens folders to 777.

Complete installation

Activate the module

Now open your PHPFox’s AdminCP area in a web browser, and go to Extensions->Import Products.

You will be prompted to install AVChat3 Module for phpFox 3. Click the Install link. The module will install and you’ll receive a confirmation message:

Product successfully installed.

Connect AVChat to the media server app

Now go to Settings->Manage Settings and click on the General AVChat 3 Settings link. The AVChat 3 settings page will load.

In the RTMP Connectionstring section insert your connection string for the media server app ( it should look like this rtmp://media-server-ip/avchat30/_definst_ ). Scroll to the bottom and click Submit.

Your AVChat copy is now configured to connect to the media server.

Enter the chat, connect and insert the license key

There’s a new Video Chat link in the PHPFox menu, click on it. The page with AVChat on it will load and AVChat’s login screen will show up.

Your username will be automatically filled and the gender will be pre-selected:

Click [Enter Chat]. AVChat will now connect to the media server and ask you for the license key.

Enter the key (It’s in your private client/trial area) and press [Submit].

Module Features

Access the AVChat admin area

If you want to log in as hidden, kick/ban users, close/delete rooms, view users IP’s and a lot of other cool stuff that admins do, you’ll have to use the AVChat admin interface.

By default, users that are part of the Administrators and Staff user groups have access to the admin area of AVChat.

While logged in click the Video Chat link in the main menu. The AVChat admin interface will automatically load if you have access to it.

Open AVChat in a pop up

You might want AVChat to open in a pop up window to make it easier for your users to browse your website while in the chat.

  1. From AdminCP click on Settings -> Manage Settings
  2. Click on General AVChat 3 Settings
  3. Under Open Method select popup
  4. Click on Submit at the bottom of the page

Limiting features to certain user groups

PHPFox user groups

Each user in PHPFox belongs to a user group.

PHPFox ships with 4 default user groups that can not be removed:

  • Administrator
  • Registered User
  • Guest
  • Staff

Limiting AVChat features

To control what AVChat features (creating rooms, sending PM’s, viewing webcams, etc.) are available to each user group do the following from the AdminCP:

  1. go to Users -> Manage User Groups.
  2. click the arrow in front of the user group you want to change AVChat permissions for and select Manage User Settings.
  3. select Avchat3 in the list to the left. The permissions for AVChat 3 will load up.
  4. change the permissions for that user group and click SAVE at the bottom.

Location of AVChat & module files

All the AVChat files including:

  • all the module files
  • index.swf and admin.swf
  • language files
  • themes
  • audio/video quality profile files
  • avc_settings.xml
  • integration.php

are located in /module/avchat3/include/plugin/.