| 1 |
Installation
|
| 2 |
------------------------------------------------------------------------------
|
| 3 |
|
| 4 |
Your phpBB forum should be installed in subdirectory of Drupal installation directory
|
| 5 |
in order to run inside Drupal page.
|
| 6 |
For example, it is /phpBB3. But you may use your own name, but not /phpbbforum.
|
| 7 |
|
| 8 |
I. Download the phpBBforum module from http://drupal.org/project/phpbbforum
|
| 9 |
|
| 10 |
Unpack the archive.
|
| 11 |
The unpacked archive contains directories and files as shown in the left side of the table below.
|
| 12 |
|
| 13 |
Module -------------------------> Your site paths
|
| 14 |
|
| 15 |
(Drupal base path: /home/vb/www/example.com/public_html)
|
| 16 |
+/phpbbforum ----------------------> +/sites/all/modules/phpbbforum
|
| 17 |
(phpBB root path: /home/vb/www/example.com/public_html/phpBB3/)
|
| 18 |
+/includes (Path to phpBB api file: sites/all/modules/phpbbforum/includes/)
|
| 19 |
+/phpbbvbridge
|
| 20 |
phpbb_api.php phpBB api file name: phpbb_api.php
|
| 21 |
|
| 22 |
+/contrib
|
| 23 |
+/phpbbdrupal (Drupal base path: /home/vb/www/example.com/public_html)
|
| 24 |
+/images -------------------> +/images
|
| 25 |
+/root ---------------------> +(phpBB root path: /home/vb/www/example.com/public_html/phpBB3/)
|
| 26 |
phpBB-embed-3.0.5.patch -----------------> +/phpBB3/phpBB-embed-3.0.5.patch
|
| 27 |
+/includes -----------------> +/includes
|
| 28 |
functions_user.php ----------> functions_user.php (replace or patch)
|
| 29 |
+/styles -------------------> +/styles
|
| 30 |
+/prosilver-embed ----------> +/prosilver-embed
|
| 31 |
+/subsilver2-embed ---------> +/subsilver2-embed
|
| 32 |
|
| 33 |
II. Copy phpbbforum and phpBB directories and files
|
| 34 |
|
| 35 |
1) Copy phpbbforum directory to your modules directory.
|
| 36 |
|
| 37 |
sites/all/modules/phpbbforum
|
| 38 |
|
| 39 |
You do not need to copy .../phpbbforum/contrib subdirectory.
|
| 40 |
|
| 41 |
2) Copy content of .../phpbbforum/contrib/phpbbdrupal/styles subdirectory to your /phpBB3/styles subdirectory
|
| 42 |
|
| 43 |
3) Copy .../phpbbforum/contrib/phpbbdrupal/images directory to Drupal directory.
|
| 44 |
|
| 45 |
If you do not want it, you will have to edit phpBB file editor.js for your phpBB theme
|
| 46 |
(/phpBB3/styles/prosilver-embed/template/editor.js) and enter the url,
|
| 47 |
where the file spacer.gif resides.
|
| 48 |
|
| 49 |
(function colorPalette(dir, width, height) line 335)
|
| 50 |
|
| 51 |
The relative path img src="/images/spacer.gif" provides access to spacer.gif both in standalone an inside Drupal mode
|
| 52 |
only if you copy /images directory to Drupal directory.
|
| 53 |
|
| 54 |
Do not forget to add a line
|
| 55 |
|
| 56 |
Disallow: /images/
|
| 57 |
|
| 58 |
to your robots.txt file.
|
| 59 |
|
| 60 |
III. Apply patch to phpBB
|
| 61 |
|
| 62 |
The patch is made from clean phpBB3-3.05.
|
| 63 |
|
| 64 |
If you do not want to use embedded mode, you may simple
|
| 65 |
copy .../phpbbforum/contrib/phpbbdrupal/includes/functions_user.php to your /phpBB3/includes/functions_user.php
|
| 66 |
|
| 67 |
If you do not want to use embedded mode and you are upgrading from previous 1.0 version of the module, restore original functions_user.php.
|
| 68 |
The new patch contains these changes.
|
| 69 |
|
| 70 |
All changes made by the patch do not affect the standalone behavior of phpBB3.
|
| 71 |
|
| 72 |
Go to phpBB directory.
|
| 73 |
|
| 74 |
cd ./phpBB3
|
| 75 |
|
| 76 |
If you are upgrading from previous version of the module, you may restore the original
|
| 77 |
phpBB source files from previous patch.
|
| 78 |
|
| 79 |
patch -p0 -R < phpBB-embed-3.0.5.patch
|
| 80 |
|
| 81 |
Patch phpBB. Choose appropriate filename for your version of phpBB.
|
| 82 |
|
| 83 |
patch -p0 < phpBB-embed-3.0.5.patch
|
| 84 |
|
| 85 |
See http://drupal.org/patch/apply for details or if something is wrong.
|
| 86 |
|
| 87 |
IV. Install and setup phpbbforum module
|
| 88 |
|
| 89 |
1) To test how you will be authenticated, login to your phpBB forum as admin.
|
| 90 |
|
| 91 |
2) Install phpbbforum module as usual.
|
| 92 |
Open new window in browser with your Drupal site, login as admin,
|
| 93 |
navigate to Administer >> modules and enable the phpBBforum and profile module.
|
| 94 |
|
| 95 |
3) Run update.php if you are upgrading from previous version of the module.
|
| 96 |
See http://drupal.org/upgrade/running-update-php for details.
|
| 97 |
|
| 98 |
4) Go to Administer >> Site configuration >> phpBBforum settings.
|
| 99 |
|
| 100 |
Navigate to phpBBforum settings and enter the path to
|
| 101 |
phpBB root (path to forum's config.php file).
|
| 102 |
(phpBB root path: /home/vb/www/example.com/public_html/phpBB3/)
|
| 103 |
|
| 104 |
Save settings and ensure that phpBBforum successfully connected
|
| 105 |
to the phpBB database and you are authenticated.
|
| 106 |
|
| 107 |
Your path settings should look like this
|
| 108 |
|
| 109 |
phpBB forum root path:
|
| 110 |
/home/vb/www/example.com/public_html/phpBB3/
|
| 111 |
Path to forum directory. Enter the full directory path where phpBB is installed.
|
| 112 |
|
| 113 |
Path to phpBB api file:
|
| 114 |
sites/all/modules/phpbbforum/includes/
|
| 115 |
Enter the full directory path where phpBB api file is located.
|
| 116 |
|
| 117 |
phpBB api file name:
|
| 118 |
phpbb_api.php
|
| 119 |
Enter phpBB api file name.
|
| 120 |
|
| 121 |
5) In order to run phpBB inside of drupal page select appropriate mode:
|
| 122 |
|
| 123 |
phpBB display way:
|
| 124 |
In the window
|
| 125 |
In frame inside Drupal page
|
| 126 |
X In the Drupal page
|
| 127 |
|
| 128 |
Set other settings and Save configuration.
|
| 129 |
|
| 130 |
6) Ensure that corresponding profile.module fields exist.
|
| 131 |
If necessary create profile.module fields that match with
|
| 132 |
phpBB profile fields.
|
| 133 |
|
| 134 |
7) Navigate to Blocks.
|
| 135 |
Enable phpBBforum: Hidden authentication block.
|
| 136 |
Configure its visibility settings
|
| 137 |
|
| 138 |
Show block on specific pages:
|
| 139 |
* Show on every page except the listed pages.
|
| 140 |
Pages:
|
| 141 |
user/reset/*
|
| 142 |
user/password
|
| 143 |
|
| 144 |
Do not disable it in the future if you want advanced synchronization.
|
| 145 |
Enable the phpBBforum blocks you want to use (optional).
|
| 146 |
|
| 147 |
8) Setup link to phpbbforum page.
|
| 148 |
|
| 149 |
1. Try link http://example.com/phpbbforum
|
| 150 |
|
| 151 |
2. If page phpbbforum is not found, Go to Administer >> Site configuration > Performance
|
| 152 |
|
| 153 |
Clear cached data
|
| 154 |
|
| 155 |
3. Go to Administer >> Site building > Menus > Navigation
|
| 156 |
See Menu item with blank title in state (Disabled)
|
| 157 |
You may enable it if you do not want phpbbforum in Primary links
|
| 158 |
|
| 159 |
If you enable it your forum page will be with title.
|
| 160 |
Reset will help to remove the page title if you disable it back.
|
| 161 |
|
| 162 |
4. Go to Administer >> Site building >> Menus >> Primary links
|
| 163 |
Enter Menu item phpbbforum.
|
| 164 |
|
| 165 |
Main page and link to phpBB in page is
|
| 166 |
|
| 167 |
phpbbforum
|
| 168 |
|
| 169 |
To change this name you may add URL aliases (core module Path must be enabled).
|
| 170 |
|
| 171 |
Add next URL aliases (System path -> URL Alias)
|
| 172 |
|
| 173 |
For the path 'forums'
|
| 174 |
|
| 175 |
phpbbforum -> forums
|
| 176 |
phpbbforum/index.php -> forums/index.php
|
| 177 |
phpbbforum/viewtopic.php -> forums/viewtopic.php
|
| 178 |
phpbbforum/viewforum.php -> forums/viewforum.php
|
| 179 |
phpbbforum/viewonline.php -> forums/viewonline.php
|
| 180 |
phpbbforum/memberlist.php -> forums/memberlist.php
|
| 181 |
phpbbforum/posting.php -> forums/posting.php
|
| 182 |
phpbbforum/search.php -> forums/search.php
|
| 183 |
phpbbforum/ucp.php -> forums/ucp.php
|
| 184 |
phpbbforum/mcp.php -> forums/mcp.php
|
| 185 |
phpbbforum/faq.php -> forums/faq.php
|
| 186 |
phpbbforum/report.php -> forums/report.php
|
| 187 |
phpbbforum/adm/index.php -> forums/adm/index.php
|
| 188 |
|
| 189 |
Administer >> Site building >> URL aliases >> Add alias
|
| 190 |
|
| 191 |
Existing system path: http://example.com/phpbbforum
|
| 192 |
|
| 193 |
Specify the existing path you wish to alias. For example: node/28, forum/1, taxonomy/term/1+2.
|
| 194 |
|
| 195 |
http://example.com/forums
|
| 196 |
|
| 197 |
Specify an alternative path by which this data can be accessed.
|
| 198 |
For example, type "about" when writing an about page.
|
| 199 |
Use a relative path and don't add a trailing slash or the URL alias won't work.
|
| 200 |
|
| 201 |
All links from blocks will have that path 'forums' instead of system phpbbforum.
|
| 202 |
|
| 203 |
It works with or without Clean URLs enabled.
|
| 204 |
|
| 205 |
9) To setup content submission to phpBB forum
|
| 206 |
|
| 207 |
1. Go to Content types > Edit your content type
|
| 208 |
|
| 209 |
Set in section phpBBforum submission settings
|
| 210 |
|
| 211 |
Drupal to phpBB submission:
|
| 212 |
( ) Disabled
|
| 213 |
(*) Enabled
|
| 214 |
|
| 215 |
Drupal to phpBB submission:
|
| 216 |
( ) Disabled
|
| 217 |
(*) Enabled
|
| 218 |
|
| 219 |
2. To enable phpBB comments in the node, set Display below the post in the setting:
|
| 220 |
|
| 221 |
Location of phpBB topic comments:
|
| 222 |
( ) Display only on the phpBBforum page
|
| 223 |
(*) Display below the post
|
| 224 |
|
| 225 |
If you want to display both Drupal and phpBB comments, you should change the setting:
|
| 226 |
|
| 227 |
Display Drupal comments:
|
| 228 |
(*) Display only phpBB comments
|
| 229 |
( ) Display both Drupal and phpBB comments
|
| 230 |
|
| 231 |
3. To display the phpBB topic comments in the node,
|
| 232 |
you should insert in your theme in node-your_content_type.tpl.php these lines
|
| 233 |
|
| 234 |
<?php if ($phpbbforum_comments): ?>
|
| 235 |
<div id="phpbbforum-node-comments"><?php print $phpbbforum_comments; ?></div>
|
| 236 |
<?php endif; ?>
|
| 237 |
|
| 238 |
For the Garland theme you can use the example file garland.node-story.tpl.php.
|
| 239 |
Rename it to node-story.tpl.php and copy to the themes/garland directory.
|
| 240 |
|
| 241 |
V. Setup phpBB forum
|
| 242 |
|
| 243 |
Pay attention to phpBB Settings:
|
| 244 |
|
| 245 |
1) Go to phpBB Administration Control Panel > General > Server URL settings
|
| 246 |
|
| 247 |
Server URL settings
|
| 248 |
Domain name:
|
| 249 |
The domain name this board runs from (for example: www.example.com).
|
| 250 |
|
| 251 |
In drupal settings.php variable $base_url and Domain name must be both with or without www.
|
| 252 |
|
| 253 |
Domain name: www.example.com
|
| 254 |
$base_url = 'http://www.example.com';
|
| 255 |
or
|
| 256 |
Domain name: example.com
|
| 257 |
$base_url = 'http://example.com';
|
| 258 |
|
| 259 |
Script path: /phpBB3
|
| 260 |
The path where phpBB is located relative to the domain
|
| 261 |
name, e.g. /phpBB3.
|
| 262 |
|
| 263 |
Force server URL settings.
|
| 264 |
|
| 265 |
Force server URL settings: (*) Yes () No.
|
| 266 |
|
| 267 |
2) Cookie settings.
|
| 268 |
|
| 269 |
Cookie domain: .example.com
|
| 270 |
Cookie name: [random name]
|
| 271 |
Cookie path: /
|
| 272 |
|
| 273 |
Note: your domain name .example.com with leading dot.
|
| 274 |
|
| 275 |
3) User registration settings.
|
| 276 |
|
| 277 |
Account activation: () Disable (*) None () By User () By Admin
|
| 278 |
|
| 279 |
Choose () None or () By User
|
| 280 |
If you set By User, user must to login first to phpBB and after that you will see that he is registered.
|
| 281 |
Set to None for test purposes.
|
| 282 |
|
| 283 |
Username length:
|
| 284 |
Minimum and maximum number of characters in usernames. [1] [30]
|
| 285 |
|
| 286 |
Password length:
|
| 287 |
Minimum and maximum number of characters in passwords. [5] [30]
|
| 288 |
|
| 289 |
4) Security settings.
|
| 290 |
|
| 291 |
Check IP against DNS Blackhole List: () Yes (*) No
|
| 292 |
|
| 293 |
You may switch off
|
| 294 |
Check e-mail domain for valid MX record: () Yes (*) No
|
| 295 |
If enabled, the e-mail domain provided on registration and profile changes is checked for a valid MX record.
|
| 296 |
|
| 297 |
5) Go to phpBB Administration Control Panel > General > Load settings
|
| 298 |
|
| 299 |
Session length: 86400
|
| 300 |
Sessions will expire after this time, in seconds.
|
| 301 |
Set this value according your needs.
|
| 302 |
|
| 303 |
6) Go to phpBB Administration Control Panel > Styles and install needed embed styles
|
| 304 |
|
| 305 |
prosilver-embed
|
| 306 |
Copyright: © phpBB Group, 2007 Install
|
| 307 |
or/and
|
| 308 |
subsilver2-embed
|
| 309 |
Copyright: © 2005 phpBB Group Install
|
| 310 |
|
| 311 |
In the Install style make shure that the style is active. Do not make it default. Save.
|
| 312 |
|
| 313 |
You should revise all settings that may affect the behavior of the module.
|
| 314 |
|
| 315 |
VI. Theming
|
| 316 |
|
| 317 |
You should realize that on phpbbforum page there will be css conflicts
|
| 318 |
between Drupal and phpBB css files.
|
| 319 |
The module is not responsible for that. You will have to resolve them yourself.
|
| 320 |
|
| 321 |
For the theming of the phpbbforum page the module provides:
|
| 322 |
|
| 323 |
1) two starter phpBB styles:
|
| 324 |
|
| 325 |
prosilver-embed
|
| 326 |
subsilver2-embed
|
| 327 |
|
| 328 |
2) file phpbbforum.css
|
| 329 |
|
| 330 |
3) default starter css files for your drupal theme for phpBB styles:
|
| 331 |
|
| 332 |
garland-phpbbforum-prosilver.css
|
| 333 |
garland-phpbbforum-subsilver2.css
|
| 334 |
|
| 335 |
phpbbforum-prosilver.css
|
| 336 |
phpbbforum-subsilver2.css
|
| 337 |
|
| 338 |
You can copy this files in each used drupal theme directory and customize them individually for this theme.
|
| 339 |
In this case these default css files is not used.
|
| 340 |
|
| 341 |
4) file phpbbforum.theme.custom-sample.inc and two functions in it
|
| 342 |
|
| 343 |
phpbbforum_set_style_example_embed
|
| 344 |
phpbbforum_style_example_embed
|
| 345 |
|
| 346 |
If you use your own phpBB style then:
|
| 347 |
|
| 348 |
a) rename phpbbforum.theme.custom-sample.inc to phpbbforum.theme.custom.inc
|
| 349 |
|
| 350 |
b) Replace 'example' with the name of your phpBB theme
|
| 351 |
|
| 352 |
c) uncomment the suggested lines according your theme origin (prosilver or subsilver2)
|
| 353 |
or write your own code.
|
| 354 |
|
| 355 |
If you do not provide these function the module analyzes style name.
|
| 356 |
If your phpBB style is created from prosilver and its name contains string "prosilver"
|
| 357 |
or starts with "pro" the module treats this style as prosilver.
|
| 358 |
In other cases the module treats this style as subsilver2.
|
| 359 |
In these cases you do not need to create and edit these functions.
|
| 360 |
|
| 361 |
The styles prosilver-embed and subsilver2-embed are used only running phpBB inside Drupal page.
|
| 362 |
The phpBB administrators or phpBB users should select only original styles prosilver or subsilver2.
|
| 363 |
If you have your own custom style example, you should provide the style example-embed (or example_embed)
|
| 364 |
and it should be active in order to run inside Drupal.
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
VII. Hints
|
| 369 |
|
| 370 |
Do not think that the embedded inside Drupal phpBB will work for your themes right out of the box.
|
| 371 |
Install first locally and ensure that with your settings it works as you expect.
|
| 372 |
Setting up the module for the first time use Garland in Drupal and prosilver or subsilver2 in phpBB themes
|
| 373 |
instead of your custom themes.
|
| 374 |
Do not use exotic layout you will never use on the production site just to test the module.
|
| 375 |
Do not use domain name with localhost http://localhost.example.com.
|
| 376 |
Start learning and testing the module with layout that is similiar to your layout on production site.
|
Parent Directory
| 
Revision Log
| 
Revision Graph