Skip to content

Latest commit

 

History

History
218 lines (143 loc) · 9.27 KB

xenforo.md

File metadata and controls

218 lines (143 loc) · 9.27 KB
Raw
layout title description isHome hide
default
AVChat xenForo Add-on
Documentation covering the AVChat add-on for xenForo
false
true

Overview

The AVChat Video Chat Add-on for xenForo handles the integration between your xenForo community and our AVChat software:

  • username and gender integration
  • profile url integration
  • profile picture integration
  • Facebook and Twitter integration
  • placement of video chat within the web site (user and admin interface)
  • control what features each user group from xenForo has access to
  • control AVChat 3 general settings from the xenForo admin area

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](https://nusofthq.com/c/) to your computer:
  1. AVChat 3.0.zip contains AVChat
  2. avchat3_video_chat_xenforo_addon.zip contains the xenForo add-on

Extract the 2 archives somewhere on your computer.

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:

{% include media-server-app.md %}

xenForo add-on & AVChat installation

Upload files to your website

Connect using an FTP client to your website and:

  1. upload the library and videochat folders from the xenForo's archive to your forum's root folder
2. upload the contents of the `Files to upload to your web site` folder (except `admin.html` and `index.html` ) from the AVChat archive to `/videochat/`

Edit .htaccess

If you use the xenForo's `.htaccess` (for [SEO friendly URLs](https://xenforo.com/help/friendly-urls/) or any other reason) you'll also have to prevent it from redirecting AVChat paths by editing the `.htaccess`in your forum's root folder and replacing the following line:

{% highlight PHP %} RewriteRule ^(data/|js/|styles/|install/|favicon.ico|crossdomain.xml|robots.txt) - [NC,L] {% endhighlight %}

with:

{% highlight PHP %} RewriteRule ^(data/|js/|styles/|install/|favicon.ico|crossdomain.xml|robots.txt|videochat/|index_popup.php) - [NC,L] {% endhighlight %}

Folder permissions

If your website's hosted on a Linux server CHMOD the `/videochat/uploadedFiles` and `/videochat/tokens` folders to 777.

Complete installation

Install the add-on

In the xenForos's Admin CP area:

  1. click on Install Add-on in the left side menu.
  2. on the Install New Add-on page click on Choose File
  3. select the addon-AVChat3VideoChat.xml from the xenForo add-on archive.
  4. click Install Add-on

Connect AVChat to the media server app

In the Admin CP:

  1. go to Home and click on Options in the left sidemenu
  2. select AVChat 3 Video Chat Options from the list (should be 1st)
  3. 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_ )
  4. scroll to the bottom and click Save Changes

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

Allow access to the chat

From the Admin CP:

  1. Go to Users -> Group Permissions
  2. Click the group you want to have access to AVChat
  3. Scroll down to the AVChat 3 Video Chat - User Permissions section and click Allow (green box)
  4. Scroll to the end and click Update Permissions

Repeat 2-4 for each group you want to have access to the chat. Make sure you allow access to the Administrative user group since you're part of it.

Enter the chat and insert the license key

  1. Go to the forum's front end. There's a new Video Chat link in xenForo's main menu, click on it.

  2. The page with AVChat on it will load and AVChat's login screen will show up. Your username will be automatically filled.

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

  4. Enter the key (It's in your private client/trial area) and press Submit.

Add-on 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 no xenForo user group has access to the video chat as admin. You will need to configure this permission for each group.

While logged in the Admin CP do the following:

  • Click on Users in the top menu
  • Click on the user group you want to give AVChat admin access to
  • On the following page search for AVChat 3 Video Chat - User Permissions and you will see AVChat's permissions list
  • Check Allow (the green box) for Can access chat as admin
  • Scroll to the bottom and click on Update Permissions

Now, whenever a user belonging to that user group will access the chat, the AVChat admin interface will now load, instead of the one for regular members.

Open AVChat in a pop up

By default AVChat 3 is embedded in your xenForo page but 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 Admin CP go to Home -> Options
  2. Search for AVChat 3 Video Chat Options and click on it
  3. Select Popup for Display Mode
  4. Scroll to the bottom and click Save Changes

Limiting features to certain user groups

xenForo user groups

xenForo ships with 4 user groups:

  • Administrative
  • Moderating
  • Registered
  • Unregistered / Unconfirmed

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 and the click on User Group Permissions in the left sidebar.
  2. click on the user group you want to edit and then search for AVChat 3 Video Chat - User Permissions
  3. change the AVChat permissions for that user group and click Update Permissions at the bottom.

Allowing visitors access to the video chat

The xenForo addon does not allow any user group to access the chat by default. Every group (including Unregistered / Unconfirmed which covers visitors) need to be given permission from the group's permissions page.

From the Admin CP:

  1. go to Users -> Group Permissions
  2. click on the Unregistered / Unconfirmed
  3. Scroll down to AVChat 3 Video Chat - User Permissions and select Allow (the green box) for Can access chat
  4. Scroll down and click Update Permissions

When a user group doesn't have permission to access the chat they still see the `Video Chat` link in the menu but on the chat page they're asked to register or sign in.

Location of AVChat & add-on files

All the AVChat files including:
  • all the add-on files
  • index.swf and admin.swf
  • language files
  • themes
  • audio/video quality profile files
  • avc_settings.xml
  • integration.php

are located in /videochat/.