PhpBB component

v1.2.4

Adam van Dongen

[email protected]
http://www.tim-online.nl/redirect.php?forum

1
Index
1. Before installing............................................................................................................ 3
2. Installing the phpBB component...................................................................................... 4
2.1.Unzip package......................................................................................................... 4
2.2.Upload phpBB component......................................................................................... 4
2.3.Install phpBB component.......................................................................................... 5
2.3.1.Unpack zip package........................................................................................... 5
2.3.2.Create database................................................................................................ 5
2.3.3.Create basic configuration.................................................................................. 6
2.3.4.Installation succesfull......................................................................................... 6
2.4.Install phpBB login module........................................................................................ 7
2.5.Publish phpBB login module....................................................................................... 7
2.6.Create menu item.................................................................................................... 8
3. Importing an existing phpBB forum.................................................................................. 9
3.1.Unzip package......................................................................................................... 9
3.2.Upload phpBB component......................................................................................... 9
3.3.Install phpBB component......................................................................................... 10
3.3.1.Unpack zip package......................................................................................... 10
3.3.2.Create database.............................................................................................. 10
3.3.3.Create basic configuration................................................................................. 10
3.4.Installation succesfull.......................................................................................... 11
3.5.Install phpBB login module...................................................................................... 11
3.6.Publish phpBB login module..................................................................................... 12
3.7.Create menu item.................................................................................................. 12
3.8.Upgrade database to component version.................................................................... 13
3.9.Import phpbb users................................................................................................ 13
4. Upgrading................................................................................................................... 15
4.1.Upgrade from phpBB component 1.2.4 RC1 to 1.2.4 RC2............................................. 15
4.2.Upgrade from phpBB component 1.2.3 to 1.2.4.......................................................... 15
4.3.Upgrade from phpBB component 1.x to 1.2.3............................................................. 15
5. Common questions....................................................................................................... 16
5.1. Installing new templates........................................................................................ 16
5.2. Adding a language................................................................................................. 18
5.3. Running this component outside mambo................................................................... 19
5.4. Installed mods...................................................................................................... 19
5.5. How can i stay updated?......................................................................................... 20
5.6. Internal server errors............................................................................................. 20
5.7. Support............................................................................................................... 20

2
1. Before installing

Always make a backup of all of your mambo tables

This component will add a phpBB forum to your mambo site. Users will have to register through
the phpBB forum, and will be inserted into mambo as well.
Within mambo you will be able to change userrights as you were used to, but the add users
function in mambo can't be used. If you wish to add users, you'll have to register them though the
phpBB registration form.

This component version will only work with mambo 4.5.2

3
2. Installing the phpBB component

2.1.Unzip package

Unzip the phpbbb_component1.2.4 package locally so you can see which files are in it.

The login modules are in the modules directory. The SQL directory provides the update sql queries
when you are upgrading from a previous version of this component.

2.2.Upload phpBB component

Go into the mambo admin panel.

Proceed to the install component
screen.
Select the com_forum_install.zip
package and click upload.

When mambo finishes the upload, it's

tell you upload has been succesfull

If you are unable to use this function due to server limits or safe_mode issues. Please use the
install from directory option. You can read more about this in the mambo manual.

4
2.3.Install phpBB component

Choose the option install phpBB for mambo to start

the installation.

2.3.1.Unpack zip package

The first step in the installation wizard is the step where mambo tries to extract the zip file that
contains all forum files.
You will need the Zlib library for this, but since you were able to install this component, your
shouldn't be too concerned about this.

Click the button to start extraction.

2.3.2.Create database

When extraction succeeded, mambo will present the following screen:

Here you'll have the choice to create a new phpBB database, or to import an existing phpBB
database.
Alter the table prefix if you want to run more than one phpbb installation in one table.

Since this part of the manual is for a new installation, choose the “Create Database” button.

5
Confirm that you are creating a new database.

2.3.3.Create basic configuration

When mambo finishes creating the tables, it will export all existing mambo users to phpBB so that
the merge will be complete.

Leave the box checked if you wish to run phpBB inside mambo (with the mambo template around
it) or uncheck the box if you want it to open in a new window.

Click the create configuration button.

2.3.4.Installation succesfull

At this moment, the component installation is finished. The phpBB configuration mentioned in the
popup is the phpBB configuration in the admin panel. You can find a link to the admin area on the
bottom of every forum page when you are signed in with a user that has administrator rights.

6
2.4.Install phpBB login module

Go to the module installation screen.

If you've chosen to run phpBB inside mambo select the phpbb_login.zip, if you want to run phpbb
outside phpbb then choose the phpbb_login_nw.zip

Click upload file

2.5.Publish phpBB login module

Go into the "Manage Modules" option, and unpublish the default login module. Publish the phpbb
login module.

You can alter the name of the module if you wish.

7
2.6.Create menu item

Now head into the menu manager, and create a new menu item.
If you've chosen to run phpBB inside mambo, create a MOS Component link, if you wish to run it
outside mambo, create a URL link menu item. The url to link to will have to be
http://www.mysite.ext/index2.php?option=com_forum

Select the Component

menu type.

Select the phpBB Component, give it a name.

Accesslevel MUST be public if you want other people to be able to register at your site.

Don't forget to
publish the menu
item when you're
done.

8
3. Importing an existing phpBB forum
It's important that no database related mods have been installed. I won't be able to give support
when you have mods installed.
Make sure your phpBB and mambo tables are in the same database.
Always make a backup before doing this!

3.1.Unzip package

Unzip the phpbbb_component1.2.4 package locally so you can see which files are in it.

The login modules are in the modules directory. The SQL directory provides the update sql queries
when you are upgrading from a previous version of this component.

3.2.Upload phpBB component

Go into the mambo admin panel.

Proceed to the install component
screen.
Select the com_forum_install.zip
package and click upload.

When mambo finishes the upload, it tells you upload has been succesfull

If you are unable to use this function due to server limits or safe_mode issues. Please use the
install from directory option. You can read more about this in the mambo manual.

9
3.3.Install phpBB component

After clicking the install link from the previous screen you will enter the installation wizard.

3.3.1.Unpack zip package

The first step in the installation wizard is the step where mambo tries to extract the zip file that
contains all forum files.
You will need the Zlib library for this, but since you were able to install this component, your
shouldn't be too concerned about this.

Click the button to start extraction.

3.3.2.Create database

When extraction succeeded, mambo will present the following screen:

Here you'll have the choice to create a new phpBB database, or to import an existing phpBB
database.

Since this part of the manual is about importing an existing database, choose the “Import phpbb
posts and users” button.

3.3.3.Create basic configuration

10
When mambo finishes creating the tables, it will export all existing mambo users to phpBB so that
the merge will be complete.

Leave the box checked if you wish to run phpBB inside mambo (with the mambo template around
it) or uncheck the box if you want it to open in a new window.

Click the create configuration button.

3.4.Installation succesfull

At this moment, the component installation is finished. The phpBB configuration mentioned in the
popup is the phpBB configuration in the admin panel. You can find a link to the admin area on the
bottom of every forum page when you are signed in with a user that has administrator rights.

3.5.Install phpBB login module

Go to the module installation screen.

If you've chosen to run phpBB inside mambo select the phpbb_login.zip, if you want to run phpbb
outside phpbb then choose the phpbb_login_nw.zip

Click upload file

11
3.6.Publish phpBB login module

Go into the "Manage modules" item, and unpublish the default login menu. Publish the phpbb
module.

You can rename the module if you wish.

3.7.Create menu item

Now head into the menu manager, and create a new menu item.
If you've chosen to run phpBB inside mambo, create a MOS Component menu item, if you wish to
run it outside mambo, create a URL link menu item. The url to link to will have to be
http://www.mysite.ext/index2.php?option=com_forum

Select the Component menu type.

12
Select the phpBB Component, give it a name.
Accesslevel MUST be public if you want other people to be able to register at your site.

Don't forget to publish the menu item when you're done.

3.8.Upgrade database to component version.

If you allready have the attachment_mod installed, remove everything between line 65 and 178
from the "upgrade_phpbb2.0.x_to_component1.2.3.sql".

Run the file "upgrade_phpbb2.0.x_to_component1.2.3.sql" that came with the package though
phpMyAdmin or any other mySQL tool.

(and no, this is not a type, there were no database changes between 1.2.3. and 1.2.4)

3.9.Import phpbb users

Choose the import users option from the phpBB menu.

This will lead you to the next screen;

13
Read it carefully and if you want to continue, click “Click here to continue” to continue.

The script will begin importing all users and will create a list of all users that have been imported
with the userlevel behind it.

If no errors appear, user conversion has been successfull. If you get any errors in this step. Please
report them at my forum.

14
4. Upgrading

4.1.Upgrade from phpBB component 1.2.4 RC1 to 1.2.4 RC2

– Unzip com_forum_install.zip locally

– Unzip com_forum.zip locally
– Upload all files in the com_forum directory that is created to /components/com_forum
– Run /sql/upgrade_1.2.4RC1_to_1.2.4RC2.sql against your database

4.2.Upgrade from phpBB component 1.2.3 to 1.2.4

– Unzip com_forum_install.zip locally

– Unzip com_forum.zip locally
– Upload all files in the com_forum directory that is created to /components/com_forum

4.3.Upgrade from phpBB component 1.x to 1.2.3

– Unzip com_forum_install.zip locally

– Unzip com_forum.zip locally
– Upload all files in the com_forum directory that is created to /components/com_forum
– run upgrade_1.2.2_to_1.2.3.sql agains your database with phpMyAdmin or any other tool

15
5. Common questions

5.1. Installing new templates

I can't really tell which files i've edited since it was quite a while ago.
I can provide a list of edited and added files. With a program like Winmerge you'll be able to
compare those files agains the original.

Added files:

16
Changed files:

You will also have to remove the <html> and <body> tags from overall_header.tpl and
overall_footer.tpl. If you don't do this, you will have them double in your page, 1 time from
mambo, one time from phpbb.

If you managed to convert a template, you could post your package at the section dedicated to
this:
http://www.tim-online.nl/redirect.php?custom_mt

17
5.2. Adding a language
If you want to add a language to this component, you'll have to change the files a bit.

Added files:

Changed files:

Translate and add the following to the languagefile:

lang_admin.php:

// FLAGHACK-start
$lang['Flags'] = 'Flags';
// FLAGHACK-end

// FLAGHACK-start
//
// Flags admin
//
$lang['Flags_title'] = 'Flag Administration';
$lang['Flags_explain'] = 'Using this form you can add, edit, view and delete flags. You can also
create custom flags which can be applied to a user via the user management facility';

$lang['Add_new_flag'] = 'Add new flag';

$lang['Flag_name'] = 'Flag Name';

$lang['Flag_pic'] = 'Image';
$lang['Flag_image'] = 'Flag Image (in the images/flags/ directory)';
$lang['Flag_image_explain'] = 'Use this to define a small image associated with the flag';

$lang['Must_select_flag'] = 'You must select a flag';

$lang['Flag_updated'] = 'The flag was successfully updated';
$lang['Flag_added'] = 'The flag was successfully added';
$lang['Flag_removed'] = 'The flag was successfully deleted';
$lang['No_update_flags'] = 'The flag was successfully deleted. However, user accounts using this
flag were not updated. You will need to manually reset the flag on these accounts';

$lang['Flag_confirm'] = 'Delete Flag' ;

$lang['Confirm_delete_flag'] = 'Are you sure you want to remove the selected flag?' ;

18
$lang['Click_return_flagadmin'] = 'Click %sHere%s to return to Flag Administration';
// FLAGHACK-end

lang_main.php

// FLAGHACK-start
$lang['Country_Flag'] = 'Country Flag';
$lang['Select_Country'] = 'SELECT COUNTRY' ;
// FLAGHACK-end

5.3. Running this component outside mambo

If you want to change the way phpBB is related to mambo (inside the layout or outside) you can
change this value in /components/com_forum/config.php

at line 23 you see a variable $run_as_component = true;

if you change this into $run_as_component = false; phpbb will open in a new window.

5.4. Installed mods

At this moment these mods have been added:

– attachment mod
– global announcement mod
– country flags mod

19
5.5. How can i stay updated?

There's a newsletter available at our test site:

http://www.tim-online.nl/redirect.php?phpbb_mailing

5.6. Internal server errors

In some cases you might be getting an internal server error when you're trying to access the
phpbb admin panel.
In most cases this will be fixed when you follow the next steps:
– unzip com_forum_install locally
– unzip com_forum locally
– upload the com_forum folder to the /components/ directory overwriting all existing files

if this doesn't fix your problems, try CHMOD-ing the /components/com_forum/admin/ directory to
755.

5.7. Support
You can get support by posting at our forum. In this way, your question will also help others with
the same question.
Our forum can be found at:
http://www.tim-online.nl/redirect.php?forum

20