Friday, March 28

PmWiki | PmWiki / InitialSetupTasks

PmWiki | PmWiki / InitialSetupTasks: "Don't modify or rename pmwiki.php

PmWiki has been designed so that all customizations can be made without changing the distribution files -- one of its design goals is to provide seamless upgrades. PmWiki never writes to files in the local/ or cookbook/ directories, so placing your customizations here makes it easier to track the changes and upgrade PmWiki without losing the changes.

When changing the configuration of your site, always change the local/config.php file or add files to the cookbook/ or pub directories. Do not change pmwiki.php or the files in the scripts/ directory because the files are supposed to be overwritten upon upgrading.

You shouldn't rename pmwiki.php either. If you rename the file it will not be overwritten during an upgrade of the software and there will be a version mismatch. Many administrators add an index.php 'wrapper script' in the pmwiki directory that contains the following single line:
<?php include('pmwiki.php');"

Failure to heed this advice cost me a month or two of broken wiki when I upgraded and got too busy to troubleshoot.

No comments: