====== Invision Power Board integration ====== ===== Description ===== This plug-in provides user integration between Vivvo CMS and Invision Power Board forum. After integration, IPB takes over managing users and comments and this integration allows a single log-in feature which means that users will be logged-in to both sytems at the same time. Users will have to register only once and they will have only one profile and one user account. The article's corresponding thread in IPB forum is created automatically when someone posts the first comment to any Vivvo article and comments from IPB forum are displayed within an article's page. ===== Requirements ===== * Vivvo **v4.1+** * Invision Power Board **v3.0.x** Both scripts have to be installed on the **same domain**. ===== Pre-installation Steps ===== IPB bridge works properly only if **Invision Power Board forum is set to UTF-8** (ADMIN CP -> System -> Tools & Settings -> System Settings -> Server Environment -> Document Character Set -> UTF-8). In case your forum is installed in Vivvo subdirectory, it is necessary to place .htaccess into this folder in order to make forum functional. .htaccess content: RewriteEngine Off After you have completed this pre-installation step, you can install the plug-in. ===== How to Install? ===== You need to access the Plug-ins section. Click on Plug-ins link which is located in Main menu at the top of your administration panel. {{:user_manual:plugin-manual:admin_menu.jpg|Admin menu}} A list of all plug-ins currently registered to the system is displayed on the right hand side of the screen on **Downloaded plug-ins** tab. To install IPB integration plug-in you need to click on the install icon on the right side of the plug-ins name. {{:user_manual:plugin-manual:ipb_install.jpg|IPB install}} This will take you to the page with the following fields. Just fill-in the values of corresponding parameters: {{:user_manual:plugin-manual:ipb_install_step_1.jpg|IPB install step 1}} * **IPB url** -> You should enter the full URL address of your website, %%http://www.example.com/forum%% (%%http://%% prefix and slash are mandatory) * **IPB FS root** -> In this box you should placed a local path on your server where IPB is installed If you are unsure about the path you should do the following: - open index.php file located in your forums' folder - put the following line right after echo dirname(__FILE__); - save the file and reupload to your server - open forums' index page in your browser - the path should be displayed on the top of page When you got your forums path you should revert all changes to index.php file. Do not go any further in the installation until you have both url and root added. After you enter these required fields, press the **Next** button to proceed with the installation. On the next step, all you need to do is add some parameters in the form shown bellow: {{:user_manual:plugin-manual:ipb_install_step_2.jpg|IPB install step 2}} * **IPB User ID** -> The option is used for ArticleBot to generate comments thread for respective articles * **IPB Forum ID** -> This indicates forum that will store auto-generated threads **Example:** After you have created a Forum that will store threads from your Vivvo site open it in your favorite browser and look at the URL. {{:user_manual:plugin-manual:ipb_forum_id.jpg|Forum ID}} As you may see, in our case, forums ID is 2. The similar way you can get user ID. Just click on the username that will act like a bot (thread creator) and look at the URL: {{:user_manual:plugin-manual:ipb_user_id.jpg|User ID}} Next, you will be informed that the plug-in was successfully installed and configured. Also the important notice will appear: {{:user_manual:plugin-manual:ipb_install_step_3.jpg|IPB install step 3}} Choosing the finish task will log you out and provide you to administration log-in page. Now you should log-in using IPB administrator account. If you enter the correct credentials you'll be logged in to both systems. {{:user_manual:plugin-manual:ipb_login.jpg}} ===== Post-installation ===== After the IPB bridge installation, it is necessary to set '**Enable Vivvo comments**' option in **Vivvo administration - Preferences - Modules** to '**No**' Now you should include IPB template for comments in your article template instead of current Vivvo comments template. Open **/xhtml/article/default.tpl** file and instead of this code line (around line **47**): place the following: ===== How to Uninstall? ===== To uninstall IPB integration plug-in you need to click on the uninstall icon on the right side of the plug-in name. {{:user_manual:plugin-manual:ipb_uninstall.jpg|IPB uninstall}} This will take you to the page with the link for uninstall: Click here to Uninstall the plug-in {{:user_manual:plugin-manual:ipb_uninstall_step_1.jpg|IPB uninstall step 1}} You will be informed that the plug-in was successfully uninstalled. After clicking on a logout link Click here to logout, you will be taken back to the main login screen. From this point on you can login into Vivvo only by using your Vivvo credentials. {{:user_manual:plugin-manual:ipb_uninstall_step_2.jpg|IPB uninstall step 2}} After the deinstallation return the Vivvo comment template (**comments.tpl** instead of **ipb_comments.tpl**) and set '**Enable Vivvo comments**' option in **Vivvo administration - Preferences - Modules** to '**Yes**' ===== Actions ===== After IPB bridge installation Vivvo will inherit forums users and usergroups. You should set them Vivvo permissions in Users section in Vivvo administration panel as explained in [[../groups_edit|Add/edit usergroup]] chapter of this User manual. Users need to log in via Log-in form using IPB username and password. If the user credentials are right, they will pass validation and will be logged to both systems. If the validation fails user will be redirected to the IPB login page. To log out from the system through the frontend/backend use the Log out link. This will take effect on the site as well as on the forums.