phpBB :: Knowledge base - Viewing article Installing a MOD in a safe way

Installing a mod, whatever size it is and whatever your skills in HTML/PHP/phpBB are is always a very risky operation. Doing it live, even if the mod has no bugs and even if you use easyMOD to be sure to make no errors while applying a mod sounds so like a little crazy.

How to proceed :
o first smart move is to read the header of the mod description : a numerous informations stands there, and they have to be considered,

o read the tutorials about installing a mod, using phpMyadmin, and so. They can be found at quite all the localized support sites, or at phpBB.com :
[Tutorial] How to install a mod
[Tutorial] How to use phpMyadmin
Before each modifications :
Save ! This is a necessary step : never work live without having a save of all what you are going to modify,
Test and local environnement :
The best way to proceed is to never work live while installing mods and testing your board. There are numerous free tools over the net allowing to run under windows ie Apache environnement with mysql, php lib, etc. Have a look ie to http://easyphp.org (other similar products can be found).

Now your mod is installed on your local environnement, you are getting numerous error : what to do ?

SQL requests and/or copy forgot : those are the most usual errors, especially using easyMOD : be sure you didn't forget to run the SQL requests required by the mod, and that you have correctly copied all files in their good target location. Till it is explicitely mentioned in the mod install description, you have no CHMOD to apply to files,
Parse error on php files : also a very common error : this means you have a syntax error in the file, usualy having inserted at the wrong spot the added code, or forget a semi column or a quote.
Parse error eval()'d :
More difficult to track as the file mentioned in error (template.php) is not the one being really screw, this error is due most of the time to an error in a tpl file. Most often, this is due to a cross between switches :

Code:

correct :




Code:

wrong :
Feature not functioning :
This can be a bug of the mod, but most of the time, this will come from an error in your installation of the mod. When a modified files pack is provided, use it to compare with your installation before reporting this malfunction. Also when reporting, be precise : "this doesn't work !" is absolutly of no use. A good way to report is to describe the manipulation you are doing that issue to the error (ie : "ACP/forum management/Edit a forum/input title/hit submit : no changes showned on the forum management, and no changes shown on index"). If it is a real error, being able to reproduce it is the key to solve it quickly.

All your tests are ok, you want now to transfer to your live board

Save !
Before each modification, perform a save of the files, even if you have done it before : it is much more easy to delete a save when all is running than to have to step back without a save,
Start with SQL requests :
You have to re-run the SQL requests you have precedently ran on your local environnement,
Upload :
Upload your phpBB local dir, except the file config.php (rename it ie config.php.local on your local environnement). Doing so, you will be sure your live environnement is at the same level of your dev. environnement. If you are many allowed to work on the dev., think before starting any mod to remake your test environnement on your local machine by downloading the phpBB online environnement, and mentioned to your co-workers you are at this time making changes to the board.