Please read this document completely before proceeding with installation or updating.

This document will walk you through the basics on installing, updating and converting the forum software.

Before proceeding be sure to use of a reliable FTP software to avoid corrupted or partially uploaded files. If you're using Firefox install the Add-On FireFTP, otherwise I recommend WS_FTP for reliable FTP transfers.

Install


1. Quick install

If you have basic knowledge of using FTP and are sure your hosting service or server will run phpBB3 Portal XL you can use these steps to quickly get started.

  1. Have a phpBB 3.0.10 installed, or a 3.0.9 upgraded to 3.0.10 already (you can get it @ phpbb.com)!
  2. Decompress the Portal_XL50_Premod-3.0.10.rar archive to a local directory on your system.
  3. Upload all the files contained in directory \phpbb3\ of this archive (retaining the directory structure) to a web accessible directory on your server or hosting account.
  4. Check if file config.php in your forum main directory is write able by all (777/755).
  5. Change the permissions on the following directories to be write able by all (777/755 or -rwxrwxrwx within your FTP Client): /cache, /store, /files, /images/avatars/upload, /dl_mod/thumbs and all their subfolders, /dl_mod/downloads and all their subfolders, /gallery/images and all their subfolders, /phpbb_seo/cache, /gym_sitemaps/cache, /arcade, /arcade/gamedata, /arcade/games, /arcade/install, /images/att_thumbs, /images/img_thumbs and at least /images/counter/ip.txt.
  6. Using your web browser visit the location you placed phpBB3 Portal XL with the addition of install_portal/ or browsing directly to install_portal/index.php, e.g. http://www.mydomain.com/phpBB3/install_portal/index.php etc.
  7. Click tab "Install Basic" to install the basic portal first following the given steps. Do not log in through the portal before all steps heve been done! The installation script will guide you through all needed steps.
  8. phpBB3 Portal XL should now be available.

Now it's time to set permissions for all modifications. Log into your ACP, go to the permissions tab, left side then under Admin roles / USER roles / Moderator roles / Forum roles... Pick one to define the permission rules.

If you experienced problems or do not know how to proceed with any of the steps above please read the rest of this document or see refresh cache.


2. Requirements

phpBB3 Portal XL has a few requirements which must be met before you are able to install and use it.

  • A web server or web hosting account running on any major Operating System with support for PHP
  • A SQL database system:
    • MySQL 3.23 or above (MySQLi supported)
  • PHP 5.x.x, >6.0-dev (compatible)) with support for the database you intend to use.
  • getimagesize() function need to be enabled.
  • These optional presence of the following modules within PHP will provide access to additional features.
    • zlib Compression support
    • Remote FTP support
    • XML support
    • GD Support
    • Exif Support
    • Curl Support

If your server or hosting account does not meet the requirements above we are afraid phpBB3 Portal XL is not for you.


3. New installation of phpBB3 Portal XL 5.0

You would have downloaded one of two packages and your choice determines what you need to do, in this case Portal XL5.0 Premod. Please Note: That before updating we heavily recommend you do a full backup of your database and existing phpBB3 files! If you are unsure how to achieve this please ask your hosting provider for advice. ATTENTION! If your former phpBB3 or Portal XL setup was modified by mods other than those who come with Portal XL 5.0 ~ Premod, you will loose all those changes!

3. Portal XL 5.0 Premod package

Note: before proceeding and if you are using any other language than listed below, copy file \language\en\mods\portal_xl_install.php to the corresponding directory of your installed language to have the text (in English) available if under \languages\xx\ no corresponding file is available.

Supported languages in this package:
English (en)
English US en_us)

Steps to do:
- Get your own recent copy of phpBB 3.0.x from phpbb.com if not installed already. If installed proceed here
- Unpack phpBB 3.0.x to a temporary directory
- Upload folder \phpBB3\ to your forum root
- Browse to e.g. http://your-domain/install/ and the installer will activate
- Remove folder /install/ when installation is ready

The next steps will creating your XL 5.0 Premod.

  • Have a phpBB 3.0.10 installed, or a 3.0.9 upgraded to 3.0.10 already (you can get it @ phpbb.com)!
  • Decompress the Portal_XL50_Premod-3.0.10.rar archive to a local directory on your system.
  • Upload all the files contained in directory \phpbb3\ of this archive (retaining the directory structure) to a web accessible directory on your server or hosting account.
  • Check if file config.php in your forum main directory is write able by all (777/755).
  • Change the permissions on the following directories to be write able by all (777/755 or -rwxrwxrwx within your FTP Client): /cache, /store, /files, /images/avatars/upload, /dl_mod/thumbs and all their subfolders, /dl_mod/downloads and all their subfolders, /gallery/images and all their subfolders, /phpbb_seo/cache, /gym_sitemaps/cache, /arcade, /arcade/gamedata, /arcade/games, /arcade/install, /images/att_thumbs, /images/img_thumbs and at least /images/counter/ip.txt.
  • Using your web browser visit the location you placed phpBB3 Portal XL with the addition of install_portal/ or browsing directly to install_portal/index.php, e.g. http://www.mydomain.com/phpBB3/install_portal/index.php etc.
  • Click tab "Install Basic" to install the basic portal first following the given steps. Do not log in through the portal before all steps heve been done! The installation script will guide you through all needed steps.
  • phpBB3 Portal XL should now be available.

Now it's time to set permissions for all modifications. Log into your ACP, go to the permissions tab, left side then under Admin roles / USER roles / Moderator roles / Forum roles... Pick one to define the permission rules.

Optional:

  • - Install predefined bbcodes into database, choose tab "CUSTOM BBCODE"

- After installation enter the ACP and do all the steps below:

- Tab Styles -> Style components -> Templates -> prosilver -> Refresh
- Tab Styles -> Style components -> Themes -> prosilver -> Refresh
- Tab Styles -> Style components -> Imagesets -> prosilver -> Refresh
- General Tab -> In main screen -> Purge the cache
- Refresh your browsers cache

Ready!

Have fun with Portal XL 5.0 ~ Premod ~ Your insane crazy portal system for phpBB 3.0.x


4. Updating a former release of phpBB3 Portal XL 5.0

If you are currently using a stable release of phpBB3 Portal XL updating to this version is straightforward. You would have downloaded one of two packages and your choice determines what you need to do, in this case Portal XL 5.0 Premod.

Please Note: That before updating we heavily recommend you do a full backup of your database and existing phpBB3 Portal XL files! If you are unsure how to achieve this please ask your hosting provider for advice.

ATTENTION! If your former phpBB3 or Portal XL setup was modified by mods other than those who come with Portal XL 5.0 ~ Premod, you will loose all those changes!

4. Portal XL 5.0 Premod package

Note: before proceeding and if you are using any other language than listed below, copy file \language\en\mods\portal_xl_install.php to the corresponding directory of your installed language to have the text (in English) available if under \languages\xx\ no corresponding file is available.

Supported languages in this package:
English (en)
English US en_us)

Steps to do:
Only needed if not already using a recent phpBB 3.0.10. If installed proceed here for the Plain version, or here for the Premod version

  • Have a phpBB 3.0.10 installed, or a 3.0.9 upgraded to 3.0.10 already (you can get it @ phpbb.com)! If not proceed one row below.
  • Unpack phpBB 3.0.10 to a temporary directory.
  • Remove file config.php in directory \phpBB3\.
  • Upload/overwrite all the files contained in directory \phpBB3\ of this archive (retaining the directory structure) to the place where your forum is located (portal is lost).
  • Browse to e.g.. http://your-domain/install/database_update.php and run the phpBB3 update script.
  • Remove folder /install/.
  • Check if file config.php in your forum main directory have write access by all (777/755).

    ATTENTION! Valid for both procedures.
  • You have attachments: do NOT remove directory \files\!
  • You have custom avatars: do NOT remove directory \images\avatar\gallery\!
  • You have uploaded avatars: do NOT remove directory \images\avatar\upload\!
  • You have custom banners: do NOT remove directory \portal\images\banners\!
  • You have custom blocks: do NOT remove those file(s) in \portal\blocks\ and the appropriate style directories!
  • On your personal set-up there might be more to imagine, check on this!

The next steps will re-creating your portal.



ATTENTION! For use with a existing Portal XL 5.0 Plain 0.2 only!
To have the latest core code working properly some essential steps are needed to follow up at your running site first.

  1. REMOVE directory \portal\ and all directories below in your forum main directory.
  2. REMOVE in directory \language\en\mods\ all files named portal_xl*.php and acp_portal_xl*.php, in directory \adm\style\portal_xl\ all files named acp_portal*.html.
  3. REMOVE (temporary if problems arise) \language\xx\ if other languages than \en\ are installed. Language packs for Portal XL 5.0 Plain will possible not function with the Premod version, however the basics are identical

Applying the portal:
  1. Unpack archive Portal_XL50_Premod-3.0.10.rar to a temporary directory
  2. Copy/upload/overwrite all content (retaining the directory structure) from the package directory \phpbb3\ to your forum root eg. \public_html\ and be sure all is in place.
  3. Change the permissions on the following directories to be write able by all (777/755 or -rwxrwxrwx within your FTP Client): /cache, /store, /files, /images/avatars/upload, /dl_mod/thumbs and all their subfolders, /dl_mod/downloads and all their subfolders, /gallery/images and all their subfolders, /phpbb_seo/cache, /gym_sitemaps/cache, /arcade, /arcade/gamedata, /arcade/games, /arcade/install, /images/att_thumbs, /images/img_thumbs and at least /images/counter/ip.txt.
  4. Browse to install_portal/index.php to start the installation script and choose tab "Upgrade to Premod" following the given steps. Do not log in through the portal before all steps heve been done! The installation script will guide you through all needed steps.
  5. Remove or rename directories install_arcade, install_gallery, install_shoutbox and install_portal.
  6. Ready! It is save now to visit the Administration Controle Panel.


Now it's time to set permissions for all modifications. Log into your ACP, go to the permissions tab, left side then under Admin roles / USER roles / Moderator roles / Forum roles... Pick one to define the permission rules.




ATTENTION! For use with a existing Portal XL 5.0 Premod 0.3 only!
To have the latest core code working properly some essential steps are needed to follow up at your running site first.

  1. REMOVE directory \portal\ and all directories below in your forum main directory.
  2. REMOVE in directory \language\en\mods\ all files named portal_xl*.php and acp_portal_xl*.php, in directory \adm\style\portal_xl\ all files named acp_portal*.html.
  3. REMOVE all content in directory \styles\prosilver\template\portal\*.*
  4. REMOVE all content in directory \styles\subsilver2\template\portal\*.*

Applying the portal:
  1. Unpack archive Portal_XL50_Premod-3.0.10.rar to a temporary directory
  2. Copy/upload/overwrite all content (retaining the directory structure) from the package directory \phpbb3\ to your forum root eg.\public_html\ and be sure all is in place.
  3. Change the permissions on the following directories to be write able by all (777/755 or -rwxrwxrwx within your FTP Client): /cache, /store, /files, /images/avatars/upload, /dl_mod/thumbs and all their subfolders, /dl_mod/downloads and all their subfolders, /gallery/images and all their subfolders, /phpbb_seo/cache, /gym_sitemaps/cache, /arcade, /arcade/gamedata, /arcade/games, /arcade/install, /images/att_thumbs, /images/img_thumbs and at least /images/counter/ip.txt.
  4. Log in to your forum as administrator.
  5. Browse to install_portal/index.php to start the installation script and choose tab "Update to latest" to update portal's database, do NOT go to ACP.
  6. Browse to install_arcade/index.php to start the Arcade installation, do NOT go to ACP.
  7. Browse to install_gallery/index.php to start/update the Gallery installation (not needed for Premod 0.3), do NOT go to ACP.
  8. Remove or rename directoriesinstall_arcade, install_gallery, install_shoutbox and install_portal.
  9. Ready! It is save now to visit the Administration Controle Panel.

ATTENTION! If phpBB3 SEO is active on your site:
  • - In directory /phpbb_seo/cache/, backup your existing SEO setup file phpbb_cache.php or remove that file from package folder /root/phpbb_seo/cache/ before uploading anything.
  • - In directory /root/ of your forum, backup your existing file .htaccess or remove that file from package folder /root/ before uploading anything.
  • - In directory /root/ of your forum, backup your existing file config.php before uploading anything.

Now it's time to set permissions for all modifications. Log into your ACP, go to the permissions tab, left side then under Admin roles / USER roles / Moderator roles / Forum roles... Pick one to define the permission rules.



- After installation enter the ACP and do all the steps below:

- Tab Styles -> Style components -> Templates -> prosilver -> Refresh
- Tab Styles -> Style components -> Themes -> prosilver -> Refresh
- Tab Styles -> Style components -> Imagesets -> prosilver -> Refresh
- General Tab -> In main screen -> Purge the cache
- Refresh your browsers cache

Ready!

Have fun with Portal XL 5.0 ~ Premod ~ Your insane crazy portal system for phpBB 3.0.x


5. Remove Portal XL 5.0

To remove Portal XL 5.0 Premod completely without leaving any remnant:

  • Start the installation script and choose tab "REMOVE PORTAL".

    This action will remove all Portal XL Premod related and Download mod database entries including changes made to phpBB3's default tables such as modules, groups, custom bbcodes, users etc. After this procedure you will have a plain phpBB 3.0.x database including database tables and entries of Gallery and Arcade (this database entries will never been touched by portal's installation script). To remove those tables use the installation scripts of these mods please.

    Next step will be to remove all files within your forum main directory, EXCEPT file config.php (this file is very important to connect to your database). If you have attachments leave directory /files/ untouched. If you have other extras placed such as icons, smiles, avatars, rank images etc. check on this. Have a fresh phpBB 3.0.x distribution on hand, remove file config.php and folder \install\ from that package. Upload the fresh package to your forum space, ready.

6. Copyright and disclaimer

This application is open source software released under the GPL. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2007, 2009 Portal XL Group. All Rights Reserved. Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license