Project

General

Profile

Bug #1560 » README-NEW-INSTALL.txt

proposed for cb 1.2.2 - nant, 01 March 2010 21:46

 
+-------------------------------------------------------------------------+
| |
| New Installation Readme file for the Community Builder Suite, CB 1.2.2 |
| This file contains instructions that should be followed for new |
| (first-time) CB installations. |
| |
| 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.

SUMMARY OVERVIEW
----------------
1) Install com_comprofiler component
2) Install mod_cblogin module
3) Install mod_comprofilerModerator module
4) Install mod_comprofilerOnline module
5) Enable CB Login, CB Workflows and CB Online modules
6) Select Name Style parameter from Community Builder Configuration and Save.
Run Community Builder Synchronize Users tool.
7) Disable Joomla/Mambo login modules
8) Add new Public menu item to Community Builder component
9) Add new User List menu item
10) Run Load Sample Data tool (optional)
11) Adjust Community Builder and Joomla/Mambo CMS settings to allow registrations
only through Community Builder
12) 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/



DETAILED INSTRUCTIONS
---------------------

1) Install com_comprofiler.zip as a component. (see notes below first)
NOTE: Please be patient. comprofiler.zip is large (1.7 MB) and takes
time to upload and install (sometimes over 5 minutes on large sites !).
The installation of CB will be done automatically
in 2 pages (2 step process), which will load automatically.
Please wait for the green message saying that installation is finished.
In case o problems, see troubleshooting section further down in this
file.

NOTE: In Joomla 1.5, starting with CB 1.2 RC, legacy mode is not
required but doesn't interfer with native components, like CB 1.2.2.
So legacy plugin (page 2 of Joomla 1.5 system plugins) doesn't have
to be enabled for this CB 1.2.2 installation and operation, but
might be required depending on the CB plugins you are using, most
CB 1.1 plugins will require it.

NOTE: PHP Safe mode must be off for component and plugins installation
in Joomla! 1.0.x and Mambo.

NOTE: Mambo 4.6.0 - 4.6.5 don't handle multiple xml files properly, so:
a) you need to first unzip com_comprofiler.zip, remove the file ending
with j.xml and re-zip before installing on these Mambo versions.
b) For each module used below, you need to unzip the package, replace
the XML file which is inside the "files" folder by the one which is
outside that folder, and then rezip the "files" folder for Mambo 4.6.

IMPORTANT: if install fails, see "In case of failed install section"
below.

2) Install mod_cblogin.zip as a module.

IMPORTANT if you use the core Joomla or Mambo login module the
users will become out of sync with community builder.

NOTE: Go to Joomla/Mambo Admin->Components->Community Builder->Tools
And use the synchronize users tool to synchronize your user
database if this happens.

3) Install mod_comprofilerModerator.zip as a module
(Optional Module, only needed if using moderator features).

4) Install mod_comprofilerOnline.zip as a module
(Optional Module, displays list of online users).

5) Enable the cblogin login module (CB Login), and other CB modules
from the administration backend (go to modules->site modules then
click on publish red cross or click on module name to set params).

6) Go to Joomla/Mambo Admin->Components->Community Builder->Configuration
and at least choose the user name type (first/lastname mode choice)
corresponding to how you want to split or not split the existing users'
name during existing users synchronization of the next installation step.
Make sure to click "Save" on the configuration page.

6b)Go to Joomla/Mambo Admin->Components->Community Builder->Tools
And use the "Synchronize users" tool to synchronize CB with Joomla.
or Mambo.

7) Disable the Standard Joomla/Mambo Login Module. To do that, go to the
administration backend then:
- in Mambo/joomla 1.0 go to modules->site modules then click on the
green publish checkmark of "Login form" (mod_login) so that it
becomes a red cross.
- in Joomla 1.5 go to Extensions->modules then click on the green
"Enabled" checkmark of "Login form" (mod_login) so that it becomes
a red cross.

8) Add a new user menu item to the "User Menu" for Community Builder:
(this will be the link to the user's profile page).
For this, go to "Menus" -> "User Menu", click New, then:
- in Mambo/joomla 1.0 select "component", "Community Builder
(comprofiler)", leaving access public for the item,
give a name and save.
- in Joomla 1.5 click in internal links "Community Builder",
then "User Profile",
leave access public for the item, give a title and alias and save.
NOTE: This is not a security issue, CB checkes access.
As you don't want this menu item to appear publically,
you can put it in the User Menu as explained in this step,
or another menu with Registered access level at least.

9) Add a list menu item:
(this will be the link to the searchable users-listing).
For this, go to "Menus" -> "User Menu" (for non-public lists) or
"Menus" -> "Main Menu" (for public lists), click New, then:
- in Mambo/Joomla 1.0 select Link-URL / External-URL and point it to
index.php?option=com_comprofiler&task=usersList
(no 'http://domain' name) and save.
- in Joomla 1.5 click internal links "Community Builder",
then "Users-list", leave parameters as is, and save
NOTE: if you want the list to be accessible publically, make this
menu entry public (and make also public the one under point 8)
NOTE: if you make the menu being the first of the main menu it will
become the site's homepage.

10) Go to Joomla/Mambo Admin->Components->Community Builder->Tools
And use the "Load Sample Data" tool to pre-populate fields with
standard user contact fields (address, phone, etc), and also create a
default users list.
NOTE: To edit this default users list/add other users lists: Go to
Joomla/Mambo Admin->Components->Community Builder->List management
and change/add list(s) with the corresponding access level.
Make sure they are published.

11) If you want to allow registrations only through Community Builder
(recommended):
- in Admin->Components->Community Builder->Configuration->Registration:
set "Allow User Registration" to
"yes, independently of global site setting"
- in Admin->Site->Global Configuration->Site(Joomla 1.0/Mambo)
or ->Users (Joomla1.5):
set "Allow User Registration" to "No".

12) Done !
Since CB 1.2, re-optimized connection paths allow to turn them on
in CB config now.

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/

=====================================================================
TROUBLESHOOTING section

IN CASE OF FAILED COMPONENT INSTALL:
- Blank screen: check error logs of your webserver, or enable PHP errors
display.
Or try both fixes below blindly.

- Maximum Execution time reached:
On very slow servers, IF installation timeouts (not seen yet): you
can fix that as follows: Open file:
- joomla 1.0/mambo: administrator/index2.php
- joomla 1.5: administrator/index.php
and add line
set_time_limit( 240 );
right after the <? line, remove directories components/com_comprofiler
and administrator/components/com_comprofiler and re-install.

- Memory exhausted error (sometimes Error 500):
Joomla 1.5 with legacy ON and FTP layer ON on PHP 4.x may give error
Memory exhausted if memory limit is 8 Megabytes. In that case, simply
switch legacy plugin to OFF just for the CB 1.2.2 installation, then
you can switch it back to ON if needed. Or add line (similarly as above):
ini_set( 'memory_limit', '16M' ); @ini_set( 'memory_limit', '32M' );

- If component installation step 2 failed: Do not panic ! :

Just access CB component from backend, it's safe.

In all backend tasks there is a test if step 1 has been completed or not.

- If you don't see any warnings at top of screen then installation
completed successfully.

- if you see a warning like:

"Warning: file 'components/com_comprofiler/pluginsfiles.tgz' still
exists.
This is probably due to the fact that first installation step did not
complete, or second installation step did not take place. If you are
sure that first step has been performed, you need to execute second
installation step before using CB. You can do this now by clicking here:
(link: please click here to continue next and last installation step)."

Then you can just click on the link to complete the second step.
This step simply uncompresses that 'pluginsfiles.tgz' file into the
same place and then deletes the file. The second step can be safely
redone.

In case it still doesn't work, it's probably a permissions problem
either on the folder 'components/com_comprofiler', not allowing the
webserver to write into (or in case of joomla 1.5 ftp installer active,
the credentials not being correct).

You can fix that by fixing the permissions of that folder,
and retry step 2.

At last resort you can uncompress pluginsfiles.tgz, and rename the
resulting directory 'pluginsfiles' to 'plugin' at the same place.
You need to make sure that the plugin and all directories inside
plugin (user, templates, language) are also writable, otherwise you
won't be able to install CB plugins at a later stage.


UNINSTALLING CB

To uninstall CB, simply uninstall CB Component and CB modules from your CMS.
User data will be preserved in MySQL tables starting with jos_comprofiler.
Main CB Configuration is deleted on uninstall of CB component as it is
stored in file administrator/components/com_comprofiler/ue_config.php .
CB module configurations are deleted on module uninstall, per CMS methods.
CB plugins, tabs and field configurations, as well as user data is preserved
for reinstallation (see README-UPGRADE.txt for details upgrading/reinstalling).
To remove all database records, delete tables starting with jos_comprofiler
in a MySQL tool like PhpMyAdmin.

-----------------------------------------------------------------------

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".
(need to register for additional downloads and forum posting).

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 .


(2-2/3)