+-------------------------------------------------------------------------+ | | | New UPGRADE Readme file for the Community Builder Suite, CB 1.2.2 | | This file contains instructions that should be followed when upgrading | | from a previous CB installation. | | | | Copyright 2004-2010 Beat, MamboJoe/JoomlaJoe and CB team on | | joomlapolis.com. | | This component is released under the GNU/GPL version 2 License and | | parts under Community Builder Free License. | | All copyright statements must be kept and derivate work must | | prominently acknowledge original work on web interface and on website | | where downloaded. | | | | Joomla/Mambo Community Builder 1.2.2 Stable | | native for Joomla! 1.0.0 - 1.0.15, 1.5.3 - 1.5.15 and | | Mambo 4.5.0 - 4.6.5. | +-------------------------------------------------------------------------+ IMPORTANT - This component does not work with any other registration or login modules or hacks. It is recommended that you uninstall all such modifications as the effects of using them with this component are unknown. IMPORTANT As for any installation: BACKUP FIRST your database and files. IMPORTANT - If you are not on a Joomla 1.5 environment, you should have all Community Builder plugin installers that you installed before at hand, or use the expert installation procedure below. DO NOT uninstall plugins that you want to keep after upgrade. UPGRADES: DIRECTORY/FILE OWNERSHIP/PERMISSIONS (common Joomla/Mambo problem): If you have uploaded Community Builder by ftp to the web server without changing directory permissions or ownership, you should either: - ask your hoster to do so first, so that the webserver process running Joomla/Mambo is able to delete old files on uninstall in step 3 below and create and write new directories and files. - or for Mambo and Joomla 1.0 only consider the expert upgrade (instructions below) Alternatively for upgrading only, if you have ftp, take a look at alternative 5-steps EXPERT upgrade instructions at end, otherwise read on. IMPORTANT - This component does not work with any other registration or login modules or hacks. It is recommended that you uninstall all such modifications as the effects of using them with this component are unknown. =================================================================== This section describes normal upgrade process for those that are upgrading on a Joomla 1.5 site ------------------------------------------------------------------- FOLLOWING APPLIES FOR UPGRADES FROM CB 1.2 releases on Joomla 1.5: SUMMARY OVERVIEW OF CB UPGRADE ON JOOMLA 1.5 ENVIRONMENT -------------------------------------------------------- 1) Save your ue_config.php file (to be able to restore later): it is located in administrator/components/com_comprofiler/ue_config.php 2) Install new CB component from your CB 1.2.2 distribution package. There is no need to previously unistall component - code will upgrade automatically. Restore your saved ue_config.php file from step 1. 3) Install new CB Login module from your CB 1.2.2 distribution package. 4) Install new CB Workflow module from your CB 1.2.2 distibution package. 5) Install new CB Online module from your CB 1.2.2 distribution package. 6) Run CB Tool checks on CB database. 7) Done! =================================================================== This section describes normal upgrade process for those that cannot use ftp expert upgrade process explained below to upgrade: ------------------------------------------------------------------- FOLLOWING APPLIES FOR UPGRADES FROM CB 1.1 and CB 1.2 RC releases: SEE FIRST EXTRA INFO FOR UPGRADES FROM CB 1.0 AT BOTTOM OF THIS DOCUMENT: SUMMARY OVERVIEW OF NORMAL UPGRADE ---------------------------------- 1) Save your ue_config.php file (to be able to restore later): it is located in administrator/components/com_comprofiler/ue_config.php 2) Make sure you have all extra CB plugin packages used on your site (you will need these these later in the process). Unistall CB component. 3) Install new CB component from your CB 1.2.2 distribution package. Restore your saved ue_config.php file. 4) Take notes regarding your existing parameter settings for the existing CB Login module (you will need to reconfigure these parameters manually later on). Unistall your existing CB Login module and install the new one contained in the CB 1.2.2 distribution package. After installations, publish and configure parameters (check notes you kept earlier). 5) Follow previous step 4 for existing CB Workflow - Moderation module. 6) Follow previous step 4 for existing CB Online module. 7) Remove existing CB related menu items and create new ones. Verify that the removed menu items are also removed from trash. 8) Reinstall any additional plugins you had (see step 2). 9) Inspect existing user lists and make needed changes. 10) Run CB Tool checks on CB databases. 11) Done! You can also download from http://www.joomlapolis.com/ in Downloads/Documentation the free "Including a free "Install_Pages_from_CB_1.2_STABLE_v1-2.pdf" Document, which includes first configuration steps, or consider supporting CB team by ubscribing for full documentation at http://www.joomlapolis.com/ DETAILS OF NORMAL UPGRADE ------------------------- 1) If upgrading from any previous version you may want to make a copy of your configuration file: administrator/components/com_comprofiler/ue_config.php and of your language file and/or cb template if you modified them, off-server, or at very least outside the com_comprofiler directories. IMPORTANT As for any installation: BACKUP FIRST your database and files. 2) Check in joomla/mambo installer that the directories and directory contents are writable first: - components ( and components/com_comprofiler ) - administrator/components (and administrator/components/com_comprofiler) - modules ( and modules/mod_cblogin ) Then uninstall Community Builder (comprofiler). NOTE: Don't uninstall CB plugins (this will keep their parameters). This WILL NOT DELETE: - any data in the database - any parameters for fields, tabs, plugins, user data; But IT WILL DELETE additional CB plugin program files only (not their parameters). That's why you will need the CB plugin installers. IMPORTANT: You will need to REINSTALL these CB plugins later at last step. WARNING: Some third-party CB plugins come with modules and/or mambots which do not test for the CB plugin being installed, which can result in errors or blank screens. If you don't reinstall the corresponding CB plugin you may need to unpublish or uninstall the corresponding modules and/or mambots. 3) Follow step 1 from the README-NEW-INSTALL.txt file (Install com_comprofiler.zip as a component) 3b) You can now replace the default ue_config.php file by the ue_config.php that you saved in step 1) above. IMPORTANT: once you have restored your ue_config.php file, you need to go to CB configuration and SAVE the configuration, so that core names fields publishing is updated correctly. NOTE: In CB 1.2.2, in users-lists, the "public frontend" and the "public backend" "User Groups to Include in List" are not expanded anymore to all the corresponding frontend, respectively backend user levels, so you need to select them individually. 4) You need to uninstall mod_comprofilerlogin or mod_cblogin452 or mod_cbloginRC2 or mod_cblogin (depending on the CB version you have installed) and install the new mod_cblogin, as it contains added security needed by CB. Before you unistall the login module, you should take a note of the module parameter settings you have configured, since you will need to redo these after reinstalling. After reinstallation make sure you enable/publish the module and reconfigure and parameter settings you need. (see step 2 of the README-NEW-INSTALL.txt file for more detailed instructions of login module install process) 5) You need to uninstall and reinstall mod_comprofilerModerator. Before you unistall the mod_comprofilerModerator module, you should take a note of the module parameter settings you have configured, since you will need to redo these after reinstalling. After reinstallation make sure you enable/publish the module and reconfigure and parameter settings you need. (see step 3 of the README-NEW-INSTALL.txt file for more detailed instructions of mod_comprofilerModerator module install process) 6) You need to uninstall and reinstall mod_comprofilerOnline. Before you unistall the mod_comprofilerOnline module, you should take a note of the module parameter settings you have configured, since you will need to redo these after reinstalling. After reinstallation make sure you enable/publish the module and reconfigure and parameter settings you need. (see step 4 of the README-NEW-INSTALL.txt file for more detailed instructions of mod_comprofilerOnline module install process) 7) Remove your existing CB menu items, and create new ones following steps 8 and 9 of the README-NEW-INSTALL.txt file 8) If you had additional CB plugins installed (see step 2 above), you will need to reinstall them. Install additional plugins that you had before upgrading or check out additional plugins available at http://www.joomlapolis.com NOTE: plugins which have their parameters memorized by CB, but have missing program files are displayed in plugin list without clickable title-name, and with a barred plugin name. These will be displayed normally and usable again once plugin is installed again. If you don't wish to do so, you can delete the plugin parameters by selecting delete. 9) If you have existing CB user lists, check that the fields that you want to see in users-list are also on profile. That was also the case earlier, except for username, name and formatted name, now it's also the case for those ones as well. You can do this in CB Fields manager. 10) This is a good time to check the CB database in Components->Community Builder->Tools->Check Community Builder Database Also after reinstalling any extra plugins you had (see step 8) check db of plugins and of fields (extra options in Tools menu). 11) Done ! You can also download from http://www.joomlapolis.com/ in Downloads/Documentation the free "Including a free "Install_Pages_from_CB_1.2_STABLE_v1-2.pdf" Document, which includes first configuration steps, or consider supporting CB team by ubscribing for full documentation at http://www.joomlapolis.com/ =================================================================== This section is for EXPERT users only, for alternative upgrade: WARNING: no support provided for these alternate methods ! ------------------------------------------------------------------- Expert Update from CB any version to CB 1.2.2: SUMMARY OVERVIEW OF EXPERT UPGRADE ---------------------------------- a) backup all b) untargzip cb_expert_files_only_YOUR_MAMBO-JOOMLAVERSION.tar.gz directly to your main website folder or untarzip (using 7zip like program) to your local PC/Mac to reveal 3 folders: administrator, components, modules upload 3 folders using any ftp client to your main website root over-writing same folders (don't worry - only CB files will be changed) c) remove tar.gz file (if you untarzip directly), and if joomla 1.5: remove modules/mod_cblogin/*j.xml modules/mod_comprofiler*/*j.xml d) disable joomla registration and activate CB registration if needed e) use CB tools to check all databases and fix (CB, fields, plugins) f) open CB config, check name-display type, and save CB configuration g) check tabs and fields positions (if your first installed CB version was before 1.0.0 stable) h) if upgrading from very old CB 1.0 beta 3 restore avatars You can also download from http://www.joomlapolis.com/ in Downloads/Documentation the free "Including a free "Install_Pages_from_CB_1.2_STABLE_v1-2.pdf" Document, which includes first configuration steps, or consider supporting CB team by ubscribing for full documentation at http://www.joomlapolis.com/ DETAILS OF EXPERT UPGRADE ------------------------- a) backup files and SQL database, including ue_config.php (if upgrading of BEFORE very old CB 1.0 beta 3 check step 3b below). b) untargzip the package: - Mambo/Joomla 1.0: cb_expert_files_only_m_4_j_1.0.tar.gz - Joomla 1.5: cb_expert_files_only_j_1.5.tar.gz and overwrite corresponding CB 1.1 STABLE files in: - administrator/components/com_comprofiler (excluding ue_config.php which should stay from your previous release) - components/com_comprofiler - modules (INCLUDING new mod_cblogin 1.2.2, as 1.2.2 contains improvements) This can be done by putting this cb_expert_files_only... file in joomla or mambo main folder and typing: tar -xvzf cb_expert_files_only_m_4_j_1.0.tar.gz or depending on version: tar -xvzf cb_expert_files_only_j_1.5.tar.gz You can also unzip - untar locally using 7zip program and upload 3 folders (administrator, components, modules) to your website root using any ftp client. c) remove this tar.gz file: rm cb_expert_files_only_*.tar.gz (in case you used the tar method) If you installed any CB 1.2 RC release in Joomla 1.5 ONLY: delete following 3 files: modules/mod_cblogin/mod_cbloij.xml modules/mod_comprofilermoderator/mod_comprofilermoderatoj.xml modules/mod_comprofileronline/mod_comprofileronlij.xml d) follow step 11 of README-NEW-INSTALL.txt file if needed. e) go to Components -> Community Builder -> Tools and click "Click here to Check Community Builder Database" you should see some output in red, like (this example is for upgrade from CB 1.1, but it also works for any previous version): Database structure differences: ... Table #__comprofiler_fields Column tablecolumns does not exist Table #__comprofiler_fields Rows fieldid = 41 : Field tablecolumns = "" instead of 'name' Table #__comprofiler_fields Rows fieldid = 26 : Field name = NA instead of 'onlinestatus', Field tablecolumns = NA instead of '' ... Table #__comprofiler_lists Column params does not exist Table #__comprofiler_sessions does not exist ... Click on the link at bottom "Click here to Fix all database differences listed above", and you should see in green: "Database fix has been performed successfully" Check again database to make sure all is now green. Repeat same for CB fields and for CB plugins database checks and fixes. f) do steps 6 of the README-NEW-INSTALL.txt file (at least the save part). g) if your first installed version of CB was BEFORE CB 1.0.0 STABLE: check and adjust if needed fields and tabs-positions. The upgrader will do best efforts remappings, but if you have edited tables manually, you might have to re-arrange manually fields and tabs. h) if upgrading of BEFORE very old CB 1.0 beta 3 check step 7b below. You can also download from http://www.joomlapolis.com/ in Downloads/Documentation the free "Including a free "Install_Pages_from_CB_1.2_STABLE_v1-2.pdf" Document, which includes first configuration steps, or consider supporting CB team by ubscribing for full documentation at http://www.joomlapolis.com/ EXTRA INFO FOR UPGRADES FROM BEFORE CB 1.1: NORMAL WAY: ------------------------------------------------------- 0) If upgrading from a version BEFORE very old CB 1.0 beta 3, backup the components/com_comprofiler/avatars directory. They will be deleted when you uninstall Community Builder. This first step is NOT needed for upgrade from CB beta 4, RC1, RC2, 1.0 or later 3b)IMPORTANT: Check your registration page: the ordering of tabs is now better respected for registrations too, so tabs may have moved to previous versions. Typically, username is not anymore mandatorily the first field on the registration page. The new ordering is now: a) registration ordering of tab (new: can be set in "edit tab") b) position of tab on user profile (top-down, left-right) c) ordering of tab on position of user profile d) ordering of field within tab position of user profile. 7b)If upgrading from a version prior to 1.0 beta 3 place all the images that were once in components/com_comprofiler/avatars into images/comprofiler/ directory (this is related with actions taken in step 0 above) 11b) if upgrading from BEFORE CB 1.0.0 STABLE, check and adjust if needed fields and tabs-positions. The upgrader will do best efforts remappings, but if you have edited tables manually, you might have to re-arrange manually fields and tabs. ----------------------------------------------------------------------- KNOWN PROBLEMS: - none, check www.joomlapolis.com forum "Identified Issues" for latest. NOTE: Community Builder includes a version checker that accesses joomlapolis website to query for the latest version of CB and, if available, latest information displayed together with the latest version number in backend. This query doesn't disclose any private information. Only information needed for this standard http query are version number and referrer (site address). If you don't have Internet access, after a timeout of 20 to 90 seconds an error message will be displayed instead of latest version when showing your config or "about CB" from the backend. You can switch this check to "manual" in CB configuration: "integration" tab (Not recommended). FOR DOCUMENTATION, SUPPORT AND LATEST NEWS VISIT: http://www.joomlapolis.com Including a free "Install_Pages_from_CB_1.2_STABLE_v1-2.pdf" Document, under "Downloads"/"Documents". FOR BUG REPORTS AND FEATURE REQUESTS VISIT: http://www.joomlapolis.com/ LICENCE: Community Builder is licenced under GNU/GPL version 2 as a whole, provided that some parts used are subject to other licences for which CB Team has rights of use for Community Builder. TRADEMARK: Community Builder is a trademark of the authors of Community Builder at www.joomlapolis.com . You are welcome to use the "Community Builder" trademark to refer to this software or manuals provided that you make clear that you are not the Community Builder project, that you do not represent it, and do not incorpore the trademark or logo into your own trademarks. If you have any questions regarding the use of our trademarks, please contact us using the contact form of www.joomlapolis.com .