Support Garage
Get Help With Your AVChat Products & Services
Getting started with PHPFox and AVChat
The AVChat Module for PHPFox 3.x handles the integration between your PHPFox web site and our AVChat software.
Here's what it will do:
PHPFox 3.x Module | |
---|---|
user name integration | yes |
gender integration | yes |
profile url integration | yes |
profile image integration | yes |
placement of video chat within the web site (user and admin interface) | yes |
allow for different features for different PHPFox user groups (by editing external config file). | Directly from the admin area of PHPFox. |
Display in the web site who's in the video chat | yes |
If you cannot find the answer you’re looking for here, we encourage you to try our forums. There's also more documentation regarding AVChat in the documentation area for the main standalone version.
All the specific documentation regarding PHPFox is on this page so if you're looking for something specific just hit Ctrl+F on your browser.
Here are the PHPFox related topics we will cover on this page:
- 1. Installing AVChat integration kit for 3.x
- 2. Accessing the AVChat admin interface in PHPFox
- 3. Location of AVChat files in a PHPFox installation
- 4. Opening up the video chat in a pop up instead of in line in the web site
- 5. Placing ads around the video chat
- 6. PHPFox's user groups and limiting features for specific user groups
1. Installing AVChat integration kit for PHPFox 3.x
First you have to download 2 archives from the client/trial area on avchathq.com to your computer. These 2 archives are:
- AVChat 3.0.zip (contains media server files for Red5/FMIS/Wowza and AVChat Standalone)
- avchat3_phpfox30x_module.zip (contains the module files)
Extract the 2 archives somewhere on your computer to have all the files handy! We will use files from both archives!
After installation, the first time you will log in the video chat you will be asked or a license key. It's in your client/trial area.
1.1 Setting up the avchat30 application on the media server
First you need to install the avchat30 app on your media server. If you don't know what a media server is check out the requirements. If you already have a media server (Red5, FMIS, FMIS hosting, Wowza) here's what you need to do:
Red5 installed on a dedicated server or VPS
Upload the avchat30 folder from the Files to upload to your media server (Red5) folder to the webapps folder of your Red5 installation (C:\Program Files\Red5\webapps on Win, /opt/red5/webapps/ on Linux)
Chmod the new avchat30 folder to 777.
Restart the Red5 server
You're done, move to step below
Wowza installed on a dedicated server or VPS
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: C:\Program Files\Wowza Media Systems\Wowza Media Server Pro 1.7.2\ on my computer.
Restart the Wowza server
You're done, move to step below
AMS installed on a dedicated server or VPS
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 FMIS installation (C:\Program Files\Macromedia\Flash Media Server\applications on Windows, /opt/macromedia/fms/applications/ on Linux)
Chmod the new avchat30 folder to 777
You're done, move to step below
1.2.1 Installing the AVChat Module for PHPFox 3.x
- Copy include and module folders from avchat3_phpfox30x_module (extract avchat3_phpfox30x_module.zip) to the root of your PHPFox installation
- copy from the AVChat3.0.zip unzipped archive the contents of the Files to upload to your website folder into [your site]/module/avchat3/include/plugin/ .
- Chmod the [your site]/module/avchat3/include/plugin/uploadedFiles folder to 777 (otherwise the upload function might not work)
- Chmod the [your site]/module/avchat3/include/plugin/tokens folder to 777 (otherwise we might have token generation issues later on)
- Now login as admin in the PHPFox admin area
- Go to Extensions->Product->Import Products and you will be prompted to install AVChat3 Module for PHPFox
- Click on Install
- After installation go to Settings->Manage Settings->Avchat3 (from Module Settings section) and complete the RTMP Connectionstring field with your connection string rtmp://myFMSserver.com/avchat30/_definst_
DONE!!!
You will now find a link to the AVChat 3 Module for PHPFox in the main menu!
2. Accessing the AVChat admin interface in PHPFox
If you want to log in as hidden, kick/ban users, close/delete rooms, view users IP's and a lot of other stuff that makes you feel like GOD you will have to use the AVChat admin interface, here's how to access it:
From the front end of the web site:
- go to Video Chat link in the main menu. The AVChat admin interface will automatically load if you have access to it. By default, users that are part of the Administrators and Staff user groups have access to the admin area of AVChat. To allow more user groups to access the admin area of AVChat 3 see Part 6 below.
3. Location of AVChat files in a PHPFox installation
[your site]/module/avchat3/include/plugin/
4. Opening up the video chat in a pop up
- From Admin CP click on Settings -> Manage Settings:
- Click on General AVChat 3 Settings
- Under Open Method select popup:
- Click on Submit at the bottom of the page
5. Placing ads around the video chat
You can use Ad module from PHPFox to place ads in the video chat page. Follow these steps to acomplish this.
- Log into your PHPFox AdminCP
- Go to Modules -> Create New Campaign, a form will show up
![]()
- Select the Banner Type (HTML or Image) you want to show on your video chat page
- If you have selected Image you will need to select a file (JPG, GIF, PNG) from your computer and set a Banner Link for it. If HTML, you must enter the HTML code in textarea.
- Enter the name of your campaign (Campaign Name)
- From Module Placement select Avchat3
- From Placement select in which Block you want your ad to be shown (Block 2 if you want your ad to be shown above the video chat, Block 4 under the chat, Block 1 in the left side, Block 3 for right side - see "View Site Layout" for better understanding)
- Press Submit!
After completing these steps, your Video Chat page should look like this:
6. PHPFox's user groups and limiting features for specific user groups
Each user in PHPFox belongs to a user group.
PHPFox ships with 4 default user groups that can not be removed: Administrators, Registered User, Guest and Staff.
To manage user group settings (screenshots from PHPFox3):
- first log into your AdminCP
- Go to Users -> Manage User Groups (under User Group Manager):
- Click the arrow in front of the user group you want to change AVChat permissions for
- Click on Manage User Settings:
- Click AVChat3
The permissions for AVChat 3 will load up
Pretty neat huh? :)
Change the permissions for that specific user group and click SAVE.
7. Preventing guests from entering the video chat
By default, AVChat3 Module for PHPFox allows your guests to enter in video chat. You can follow the next steps to prevent this.
- First log into AdminCP
- Go to Users -> Manage User Groups (under User Group Manager)
- Click the down arrow in front of the Guest group and then Manage User Settings
- On the left side you will find a list with all modules, click Avchat3 to view the settings
- Check No in Allow user in this usergroup to access the chat.
![]()
8. Changing the looks of AVChat to better fit your PHPFox web site
Changing the design & looks of AVChat is explained in detail in the documentation for the standalone version.
When working with the PHPFox 3.x Module keep in mind that AVChat is installed in [your site]/module/avchat3/include/plugin/ , so all the files you need to edit (like style.css for fonts and colors, avc_settings.php for the background image) are there.
The files that contains the embed code for the AVChat Flash .swf files (the ones you need to edit in order to change the size or background color of AVChat in PHPFox) are:
- module\avchat3\template\controller\index.html.php user interface
- module\avchat3\template\controller\admincp\index.html.php admin interface
9. Displaying who's in the video chat on your web site
We have this great tutorial that shows you how to display on every page of your web site who is in the video chat, their profile picture and a link to their profile:
- Login as admin and go to Admin CP
- Go to Extension -> Module -> Add Component
- Complete the form:
- Product: Select AVChat3 Module for PHPFox 3
- Module: Select AVChat3
- Component: chatters
- Type: Select Block
- Active: Yes
- Press Submit
- Got to CMS >> Blocks >> Add New Block
- Complete the form (see Image 2):
- Product: Select AVChat3 Module for PHPFox 3
- Module: Select AVChat3
- Title: You can choose the title. We choose: Online Chatters
- Type: Select PHP Block File
- Controller: Here you can choose the page to display the Who's chatting module. We wanted to display the module on the member's dashboard: -- core.index-member
- Component: The component we created in Step 1:-- chatters
- Placement: We choose on the right side: Block 1
- Can drag and drop: It's up to you
- Active: Yes
- Allow access: We allowed all user groups.
- Press Submit.
- After completing these steps, go to Your site >> Dashboard. You should see the "Who's chatting" block on the right of your site:
This module uses the external users list generated by AVChat, so you need to login as a user in the video chat trough the front end of PHPFox! before the Who's Chatting Module will start showing who's online.
10. Allow users to login with their Facebook account
To enable Facebook Login you will need to create an Facebook Application from where you will get an App ID. You cand follow the next steps to accomplish this.
- Go and Register as a Developer at: http://developers.facebook.com
- Click + Create New App
- Insert your application name (App Name), select the category and pres Continue
- After presing the Continue button you will be redirected to the application page where you will find the App ID. Don't forget to enter your website URL in Website with Facebook Login
![]()
![]()
- Now that you have your Facebook App ID, in your website, go to your AdminCP -> Settings -> Manage Settings and click Facebook Connect
- Insert your Facebook App ID in Application ID option and press Submit
![]()
- Go to AdminCP -> Settings -> Manage Settings and click General AVChat 3 Settings
![]()
- Set the option Allow Facebook/Twitter Connection to true
![]()
- Press Submit!
11. Allow users to login with their Twitter account
To enable Twitter Login for your video chat you will need to create a Twitter Application that will provide you with a Consumer Key and an Consumer Secret. You can follow the next steps to accomplish this.
- Go to https://dev.twitter.com/apps and click on the Create a new applcation button
- Complete the form:
- Name - enter the name of your application
- Description - insert the description
- Website - enter your website URL
- Press Create your Twitter application!
![]()
- After completed the form you will be redirected to the application page, there you will find your Consumer key and Consumer secret
![]()
- Now that you have your Consumer key and Consumer Secret, in your website, go to your AdminCP -> Settings -> Manage Settings
![]()
- Click on General AVChat 3 Settings
- Set the option Allow Facebook/Twitter Connection to true
- Insert your Consumer key in Twitter Consumer Key option and Consumer secret in Twitter Consumer Secret
![]()
- Press Submit!
Get personalized help
Customers with an active support & updates plan can submit support requests through their private client area.
Support forums
Ask other customers for advice on features, customization and running a community in our peer-to-peer support forums.
Installation service
Should you need help installing the softare we can help you install both AVChat and the media server through our installation services.