addons:bridge:vbulletin

Differences

This shows you the differences between two versions of the page.

--- addons:bridge:vbulletin [2009/09/28 21:47]
jonyo
+++ addons:bridge:vbulletin [2015/01/13 23:27] (current)
geomatt
@@ Line 1: / Line 1: @@
 ====== VBulletin Bridge ======
-This //bridge type// is available on Enterprise editions, and also if you have purchased the addon for "all bridge types".
+This //bridge type// allows you to bridge users with vBulletin software.
 ====== Steps inside vBulletin Admin ======
-Since this bridge is //one-way//, changes made to user details((Such as when a new user registers, an existing user edits the user information, or a user changes the password.)) in the Geo software are also made inside vBulletin by the vBulletin bridge.  However, changes made in vBulletin are **not transfered** back to the Geo installation, so if a user changes the password or a new user registers, that information will be "out of sync".
+Since this bridge is //one-way//, changes made to user details((Such as when a new user registers, an existing user edits the user information, or a user changes the password.)) in the Geo software are also made inside vBulletin by the vBulletin bridge.  However, changes made in vBulletin are **not transfered** back to the Geo installation.  This means that if a user changes the password in vBulletin, or if a new user registers within vBulletin, that information will be "out of sync".
-The solution to this, is to disable user registrations, user info editing, and password changing, from inside vBulletin itself.  Instead they make those changes in the Geo software and the changes get copied over.  To accomplish this, follow the steps below.
+The solution to this, is to disable user registrations, user info editing, and password changing, from inside vBulletin itself.  Instead your users will make those changes in the Geo software, and the changes get copied over.  To accomplish this, follow the steps below.
-<tip c n>**Note:**  These instructions were created for vBulletin **3.8.4**, things may be different in newer (or older) versions of vBulletin.  When that is the case you may need to consult the vBulletin documentation to accomplish each task.</tip>
+<tip c n>**Note:**  These instructions were created for vBulletin **3.8.4**, how things are accomplished may be different in newer (or older) versions of vBulletin.  When that is the case you may need to consult the vBulletin documentation to accomplish a task.
+Also note that the current bridge has been tested on newer vBulletin versions, and is known to work on **4.0** versions, including the newer vBulletin CMS.  If you do experience any problems with a newer released version of vBulletin, please contact support.  From time to time minor adjustments may be needed for the bridge to make it compatible with newer released versions of vBulletin.</tip>
 ===== Disable Registrations =====
 Follow the steps below to disable user registrations.
   - Within the VBulletin admin, go to **vBulletin Options > vBulletin Options**, and select **User Registration Options**. <
   - For the setting **Allow New User Registrations** select **no**. <
   - In the admin, go to **Languages & Phrases > Search in Phrases**. <
   - Use the tool to search for "noregister" (without the quotes), and select the option for "Phrase Variable Name Only" <
-  - Click **edit** for the phrase found, and change the text to reflect a more appropriate message regarding the location of the registration within the Geo installation.
+  - Click **edit** for the phrase found, and change the text to reflect a more appropriate message regarding the location of the registration within the Geo installation. <
-  - Save the changes.
+  - Save the changes. <
-We will be working to update the rest of the documentation, until then you can reference the legacy documentation found below.
-===== Legacy Documentation =====
+===== Convert Logout Links =====
-Below are the //old// integration instructions specific for vBulletin.  They are provided "as is" for now, but we will be going through the instructions and updating as needed.
+Within the vBulletin text, you will need to change all the log-out links to "point" to your geo installation's logout page, the URL would end in((Note that **index.php** might be different if you use a different setting for your main file name for the site.  This is not typical however, most sites do use index.php.))
+  index.php?a=17
-<code>
+You would search for "logout", "log out", and "log_out" in all languages & phrases, and convert any link to point to the Geo logout page, then do the same within the templates in vBulletin, altering the logout links to point to the Geo installation as mentioned above.  To help get you started, below are specific instructions for each link found as of the last time this document was last updated.
-BASIC SETUP
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+Logout link in language/phrase text:
+  - In admin panel at **Languages & Phrases > Search in Phrases**, for the text **log out**, then click //find//. <
+  - Click **edit** next to the entry that is found for **logout_error**. <
+  - Find the part of the text that is linking to the log out, it will be something like: <code html><a href="login.php?{1}do=logout&amp;logouthash={2}">Click here to log out.</a></code>
+Change the URL logout link to point to the logout page in the Geo software, so it looks something like this((change **example.php/listings/** to match your Geo installation location)):
+<code html><a href="http://example.com/listings/index.php?a=17">Click here to logout.</a></code>
+  - Save the changes.
+<
+  - In admin panel at **Languages & Phrases > Search in Phrases**, for the text **log out**, then click //find//. <
+  - Click **edit** next to the entry that is found for **nopermission_loggedin**. <
+  - Find the part of the text that is linking to the log out, it will be something like: <code html><a href="login.php?{3}do=logout&amp;logouthash={4}">Log Out</a></code>
+Change the URL logout link to point to the logout page in the Geo software, so it looks something like this((change **example.php/listings/** to match your Geo installation location)):
+<code html><a href="http://example.com/listings/index.php?a=17">Log Out</a></code>
+<
+  - Save the changes. <
+  - Repeat for any other phrases that are found, that contain links to log out.  This does not include any entries that just contain the "log out" text but no <a ...> tag that links to log out. <
-- Within the VBulletin options within the admin select User Registration Options.
+Logout link in templates:
+  - In admin panel at **Styles & Templates > Search in Templates**, for the text **log_out**.
+  - Double-click on the first found template **FORUMHOME**. <
+  - In that template, find the logout link, it will be something like this: <code html><a href="login.php?$session[sessionurl]do=logout&amp;logouthash=$bbuserinfo[logouthash]"  onclick="return log_out('$vbphrase[sure_you_want_to_log_out]')"><phrase 1="$bbuserinfo[username]">$vbphrase[log_out_x]</phrase></a></code>
+Change the URL logout link, so it looks something like this((change **example.php/listings/** to match your Geo installation location)):
+<code html><a href="http://example.com/listings/index.php?a=17"  onclick="return log_out('$vbphrase[sure_you_want_to_log_out]')"><phrase 1="$bbuserinfo[username]">$vbphrase[log_out_x]</phrase></a></code>
+Then save the changes.
+<
+  - In admin panel at **Styles & Templates > Search in Templates**, for the text **log_out**.
+  - Double-click on the found template **navbar**. <
+  - In that template, find the logout link, it will be something like this: <code html><a href="login.php?$session[sessionurl]do=logout&amp;logouthash=$bbuserinfo[logouthash]" onclick="return log_out('$vbphrase[sure_you_want_to_log_out]')">$vbphrase[log_out]</a></code>
+Change the URL logout link, so it looks something like this((change **example.php/listings/** to match your Geo installation location)):
+<code html><a href="http://example.com/listings/index.php?a=17" onclick="return log_out('$vbphrase[sure_you_want_to_log_out]')">$vbphrase[log_out]</a></code>
+Then save the changes.
+<
+  - Repeat for any other places that found a link to log out, to replace the **href value** with a link to the logout page within the Geo software. <
-- Select No for allowing new registration.
+We will be working to update the rest of the documentation, until then you can reference the legacy documentation found below.
-- Within Languages & Phrases, search for
+===== Convert Registration Links =====
-        registration has been disabled by the administrator
+You can leave all the registration links as-is in vBulletin, and the changes made described in the [[#Disable Registrations]] section will point them to the Geo installation.
-- Change this to reflect a more appropriate message regarding the location of the
-        registration within the Geo installation.
-- This is all that is required to force registrations to take place within the
-Geo installation.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+If you would prefer a 1-click solution where all registration links point to Geo installation however, you can change all the registration links to "point" to your geo installation's registration page at **register.php**, assuming that file has not been re-named.
+You would search for "register" in all languages & phrases, and convert any link to point to the Geo register page, then do the same within the templates in vBulletin, altering the register links to point to the Geo installation as mentioned above.  You would use the same methods as we described in [[#Convert Logout Links]] to find the registration links (you would just be searching for register instead of log out).
-ADVANCED SETUP
+===== Convert Log-in Links =====
+Within the vBulletin text, you will need to change all the log-in links to "point" to your geo installation's login page, the URL would end in((Note that **index.php** might be different if you use a different setting for your main file name for the site.  This is not typical however, most sites do use index.php.))
+  index.php?a=10
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+You would search for "login", "log in", and "log_in" in all languages & phrases, and convert any link to point to the Geo login page, then do the same within the templates in vBulletin, altering the login links to point to the Geo installation as mentioned above.  You would use the same methods as we described in [[#Convert Logout Links]] to find the registration links (you would just be searching for log in instead of log out).
-- There is no way to consistently keep modifications that will work within the
+===== Troubleshooting, Caveats, and "Known Issues" =====
-Vbulletin code.  If you wish to only use the Geodesic Solutions installations to
+The following are things to note with the vBulletin bridge functionality.  These are not necessarily due to any "bugs" or "problem" with the bridge, but are just the nature of how the vBulletin bridge works since it is a **one-way bridge**.
-login, update user info, register and logout users.  If you wish to do this you
-will have to make a few text(phrase) and template changes to point login, logout
-and register links back to the Geodesic Solutions installation.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+  - If you see an error to the effect of "config.php file could not be found" keep looking for that file.  Yes you may have found one but in a version update vBulletin has started using another one somewhere else in their software.  Yes that means there could be two of these files in their installation.  Look for that other config.php and insert the path to that file and test the bridge again.
+  - There is currently no way to modify Vbulletin profile information settings
+through the bridge or current Geodesic Solutions installations. <
+  - No password history support. <
+  - No ban email support through Vbulletin.  At Registration and user info update Emails are checked against the Geodesic Solutions installation for duplication.  Depends on
+the version and edition of Geodesic Solutions Software you have for any email banning facility that can be used. <
+  - Only the Geodesic Solutions installation email verification system can be used. <
+  - Only the Geodesic Solutions installation lost password facility can be used.  <
+  - The username for a user cannot be changed within Geodesic Solutions installations and recommend that you not allow this in any other installations.  The admin can do this within the Geodesic Solutions installation admin panel and will have to be done for each individual installation connected by the bridge. <
+  - User removal in Geodesic software will not remove the user in vBulletin as a precaution, as any time a user is removed from a Geo installation, NONE of the bridges will be affected, the user must be removed from each installation separately. <
+  - If the "registration", "change email", or "change user password" facilities are left intact inside vBulletin, that can lead to user information being out of sync.  When this happens, it will need to manually be updated by the admin user. <
+  - When a user is registered (or user info changes), if there is already a matching username OR e-mail in vBulletin, that user **cannot be created or synced** in vBulletin. <
+  - If the password in Geo software and vBulletin get //out of sync//, **changes will not be synced for that user** as a security precaution, if the user pass doesn't match up that might mean the users are not actually the same person.  To fix you will need to manually update the password in both installations to ensure it is the same in both. <
-Search for "log out" within "Search in Phrases" of the "Languages & Phrases"
+====== Important Configuration for vBulletin 4.2.x ======
-section of the vbulletin admin.  Change the link in the following:
-- logout_missing_userid
-- nopermission_loggedin
-        ###############################################
+If using vBulletin version 4.2 (confirmed on 4.2.1 and 4.2.2 (all patch levels) as of this writing), you must make a small change to the vBulletin PHP code in order for the bridge to work correctly. If you need assistance making this change, open a Support Ticket with us.
-        For logout_missing_userid the text will be something similar to:
-        An error occurred while attempting to log you out. <a href="login.php?$session[sessionurl]
+Open the file **includes/functions.php** in the vBulletin install. Near the top, you should see:
-        do=logout&amp;u=$bbuserinfo[userid]">Click here to log out.</a>
-        A sample change would be:
+<code php>
+/* Navbar stuff
+Dont use DIR here, the Dev scripts dont like it */
+require_once('./includes/functions_navigation.php');
+</code>
-        For Auctions and root file of auctions.php:
+Replace the above code with this:
-        An error occurred while attempting to log you out. <a href="http://www.yoursite.com/auctions.php?a=1017">
-        Click here to logout.</a>
-        For Classifieds and root file of classifieds.php:
+<code php>
-        An error occurred while attempting to log you out. <a href="http://www.yoursite.com/classifieds.php?a=17">
+/* Navbar stuff
-        Click here to logout.</a>
+Dont use DIR here, the Dev scripts dont like it */
+//GEO EDIT: add DIR here, so that it works with the bridge
+require_once(DIR.'/includes/functions_navigation.php');
+</code>
-        NOTE: If the root file is index.php or something else that you have set change the links above accordingly.
+and then save the file. This corrects a file include path that cannot otherwise be accounted for from the GeoCore side of things, and will allow the bridge to function normally.
-        ###############################################
-        ###############################################
-        For nopermission_loggedin the text will be something similar to:
-        <p><strong>$bbuserinfo[username]</strong>, you do not have permission to access this page. This could be due to one of several reasons:</p>
-        <ol> <li>Your user account may not have sufficient privileges to access this page. Are you trying to edit someone else's post, access administrative
-        features or some other privileged system?</li> <li>If you are trying to post, the administrator may have disabled your account, or it may be awaiting
-        activation.</li> </ol> <div align="$stylevar[right]"> <a href="login.php?$session[sessionurl]do=logout&amp;u=$bbuserinfo[userid]">Log Out</a>
-        <a href="$vboptions[forumhome].php?$session[sessionurl]">Home</a> </div>
-        For Auctions and root file of auctions.php:
-        <p><strong>$bbuserinfo[username]</strong>, you do not have permission to access this page. This could be due to one of several reasons:</p>
-        <ol> <li>Your user account may not have sufficient privileges to access this page. Are you trying to edit someone else's post, access administrative
-        features or some other privileged system?</li> <li>If you are trying to post, the administrator may have disabled your account, or it may be awaiting
-        activation.</li> </ol> <div align="$stylevar[right]"> <a href="http://www.yoursite.com/auctions.php?a=1017">Log Out</a>
-        <a href="$vboptions[forumhome].php?$session[sessionurl]">Home</a> </div>
-        For Classifieds and root file of classifieds.php:
-        <p><strong>$bbuserinfo[username]</strong>, you do not have permission to access this page. This could be due to one of several reasons:</p>
-        <ol> <li>Your user account may not have sufficient privileges to access this page. Are you trying to edit someone else's post, access administrative
-        features or some other privileged system?</li> <li>If you are trying to post, the administrator may have disabled your account, or it may be awaiting
-        activation.</li> </ol> <div align="$stylevar[right]"> <a href="http://www.yoursite.com/classifieds.php?a=17">Log Out</a>
-        <a href="$vboptions[forumhome].php?$session[sessionurl]">Home</a> </div>
-        NOTE: If the root file is index.php or something else that you have set change the links above accordingly.
-        ###############################################
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Search in Templates for:log_out
-There will be three parts to Customize: FORUMHOME, navbar, and username_loggedin
-        ###############################################
-        - For FORUMHOME click [Customize]
-        - Within the text area look for the following code:
-                        <!-- member logout -->
-                        <td align="$stylevar[right]"><a href="login.php?$session[sessionurl]do=logout&amp;u=$bbuserinfo[userid]"  onclick="return log_out()">
-                        <phrase 1="$bbuserinfo[username]">$vbphrase[log_out_x]</phrase></a></td>
-                        <!-- end member logout -->
-        - Change it accordingly (Below is only a sample for auctions so apply necessary root file names per your product):
-                        <!-- member logout -->
-                        <td align="$stylevar[right]"><a href="http://www.yoursite.com/auctions.php?a=1017">
-                        <phrase 1="$bbuserinfo[username]">$vbphrase[log_out_x]</phrase></a></td>
-                        <!-- end member logout -->
-        ###############################################
-        ###############################################
-        - For navbar click [Customize]
-        - Within the text area look for the following code:
-                        <!--<span style="float:$stylevar[right]">[<a href="login.php?$session[sessionurl]do=logout&amp;u=$bbuserinfo[userid]"
-                        onclick="return log_out()">$vbphrase[log_out]</a>]</span>-->
-        - Change it accordingly (Below is only a sample for auctions so apply necessary root file names per your product):
-                        <!--<span style="float:$stylevar[right]">[<a href="http://www.yoursite.com/auctions.php?a=1017">$vbphrase[log_out]</a>]</span>-->
-        - Within the same text area look for the following code:
-                        <if condition="$bbuserinfo['userid']">
-                                <td class="vbmenu_control"><a href="login.php?$session[sessionurl]do=logout&amp;u=$bbuserinfo[userid]" onclick="return log_out()">$vbphrase[log_out]</a></td>
-                        </if>
-        - Change it accordingly (Below is only a sample for auctions so apply necessary root file names per your product):
-                        <if condition="$bbuserinfo['userid']">
-                                <td class="vbmenu_control"><a href="http://www.yoursite.com/auctions.php?a=1017">$vbphrase[log_out]</a></td>
-                        </if>
-        ###############################################
-        ###############################################
-        - For username_loggedin click [Customize]
-        - Within the text area look for the following code:
-                        <span class="smallfont"><a href="login.php?$session[sessionurl]do=logout&amp;u=$bbuserinfo[userid]">$vbphrase[log_out]</a></span>
-        - Change it accordingly (Below is only a sample for auctions so apply necessary root file names per your product):
-                        <span class="smallfont"><a href="http://www.yoursite.com/auctions.php?a=1017">$vbphrase[log_out]</a></span>
-        ###############################################
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-***Apply the same exact steps as above for log in and register.***
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-- The advanced scenario would be to only use one Geodesic Solutions software
-installation as the lead or dominant installation.  You would use the login,
-register, user info update and logout from this one installation.  Removing links
-to these facilities within the other installations or redirecting them to the
-lead or dominant installation would insure the most reliable relationship
-between all installations connected by the bridge. However, most seem to want registration
-to be centralized and logging in and out to be independent. This is also,
-a much simpler set up.
-- There is currently no way to modify Vbulletin profile information settings
-through the bridge or current Geodesic Solutions installations.
-- No password history support.
-- No ban email support through Vbulletin.  At Registration and user info update Emails are
-checked against the Geodesic Solutions installation for duplication.  Depends on
-the version of Geodesic Solutions Software you have will that versions email
-banning facility be used.
-- Only the Geodesic Solutions installation email verification system can be used.
-- Only the Geodesic Solutions installation lost password facility can be used.
-- The username for a user cannot be changed within Geodesic Solutions installations
-and recommend that you not allow this in any other installations.  The admin can do
-this within the Geodesic Solutions installation admin panel and will have to be
-done for each individual installation connected by the bridge.
-</code>

addons/bridge/vbulletin.1254174456.txt.gz · Last modified: 2014/09/25 16:55 (external edit)

Geodesic Solutions Community Wiki

User Tools

Site Tools

Differences

Page Tools