Configuration

The documentation in this chapter contains the information that is relevant for you, if you are want to configure the plugin on your vBulletin.

vBSSO Settings Page

  1. Log in as Administrator to vBulletin Admin Panel > vBSSO section.

vBSSO Settings page includes the following components: Required, Connect a Platform, Connection Settings, Link Custom Page, Profile Fields, Acess Settinngs, Logging&Notifications, Warnings and Backup&Restore.

_images/vbssomenu.jpg

Required

_images/vbssorequired.jpg

This menu allows you to configure the Footer Link on vBulletin side.

Set the setting to ‘Show’ if you want to display the footer link, and ‘Don’t show’ if you don’t want to display this link. It also covers settings for Authorization by email. If you want allow to log in by ‘email’ instead of user name you can do it by setting the checked attribute with a ‘Yes’ value, or ‘No’ otherwise.

Connect a Platform

_images/vbssoconnectplatform.jpg

Allows you to connect a platform. Admin will be asked to enter the following information:

  1. Platform Address: REQUIRED field, Url taken from vBSSO Settings Page (you can find it on the settings page of your Slave platform).
  2. Support www. alias: If enabled, you can connect websites with www in their address.
  3. Platform Shared Key: Unique string taken from vBSSO Settings Page (you can change it on the settings page of your Slave platform).
  4. Username and Password: OPTIONAL, you should specify those fields if your platform is protected by Basic Access Authentication.

Connected Platforms box - will show you a list of all your connected platforms (you can see two colors in the list: green color means the platform is connected and is involved in the synchronization process; red color means the platform is connected but is not involved in the synchronization process).

Connection Settings

_images/vbssoconsett.jpg

Provides the information about your vBulletin platform (in case you want to connect your forum as a Slave platform). There are next fields: Platform Shared Key and Platform Address.

Use this information to connect vBulletin platform to other vBulletin platform.

Profile Fields

_images/vbssoproffields.jpg

When users register to be members of your vBulletin site they enter default profile information. If user changes profile information on vBulletin side vBSSO plugin will transfer those changes to connected Slave platform automatically.

First Name: Specify custom profile field identity to interpret it as First Name.

Last Name: Specify custom profile field identity to interpret it as Last Name.

Country: Specify custom profile field identity to interpret it as Country.

City: Specify custom profile field identity to interpret it as City.

Phone: Specify custom profile field identity to interpret it as Phone.

Birth date: Specify custom profile field identity to interpret it as Birthday.

Access Settings

_images/vbssoaccesssettings.jpg

Allowed User Groups: means groups id that will have permission to be authenticated in all platforms via vBSSO. Those users who are not in this groups will be authenticated ONLY in vBulletin but not in connected platforms.

Allowed platform_name User Groups: means groups id that will have permission to be authenticated in platform_name platform. You can ignore this option, in case you are already inserted groups id in Allowed User Groups option. But if you will have two platforms you can separately set up groups id for the each connected platform.

Associated platform_name User Groups: means that those users who had registered or logged in from connected platform site will be added to those user groups.

Login Access Settings: points the platform on which user will be authenticated (depends on the platform on which the login event is invoked).

Logging & Notifications

An important feature of network security is to gather messages from your system, to examine those records frequently, and to keep them in an archive for future reference. This plugin uses log files to store information about the system activity. This information includes authentication errors, challenge and response mismatches, other errors.

The log file is stored on vBulletin side and is available at vBSSO > vBSSO Logging & Notifications.

ENABLE LOGGING:

  1. Log in to your forum’s /admincp/ control panel as administrator.
  2. Navigate to vBSSO section.
  3. Expand section and click on the Logging & Notifications link.
  4. Set ‘Logging Level’ to ‘All’ and specify your email address to receive the debug information.
  5. If you don’t need to receive debug messages, clean up your email address field and switch ‘Logging Level’ to ‘Warn’.

Warnings

Warnings serve as a method to remind user’s of your forum’s rules and encourage them to be followed.

Backup and Restore

Backup and Restore — creates safety copies of your most important personal files, so you’re always prepared for the worst.

How to connect the platforms?

CONFIGURATION, CASE 1

  • Log in to your Slave platform as administrator.
  • Navigate to vBSSO Settings page.
  • Modify your default Platform Shared Key by setting it to more secure unreadable phrase to encrypt exchanged data.
  • Save Changes.

CONFIGURATION, CASE 2

  • Log in to your vBulletin control panel as administrator.
  • Navigate to vBSSO section.
  • Expand section and click on the Connect Platform link.
_images/SettingsPage2.jpg
  1. Copy Platform Url link and Shared Key field from Slave installation to vBulletin.
  2. Enter BAA credentials (only in case if your platform is protected with BAA).
  3. Click on Connect button to connect your new platform.
  • This will connect the Slave platform with the Master platform. You should see the name of this platform in ‘Connected Platforms’ list below the main window.
_images/4.jpg
  1. Back to Slave vBSSO Settings page and verify that API Connections fields are filled out.

Note

You can connect as many Slave platforms as needed!

depth:6