Initial setup tasks
Most Pm wiki configuration is performed in files called local/config.php and pub/css/local.css.
The local configuration file (local/config.php)
When you first install Pm wiki, the local/config.php file does not exist. Copy the sample-config.php file (in the docs/ directory) to local/config.php and use it as a starting point. You could create local/config.php from scratch, but sample-config.php is already populated with many of the options you might want to adjust.
Here is a simple config.php file:
<?php if (!defined('PmWiki')) exit(); $WikiTitle = "My New Wiki"; $PageLogoUrl = "http://example.com/mylogo.gif"; # Uncomment these if needed #$ScriptUrl = 'http://example.com/pmwiki/pmwiki.php'; #$PubDirUrl = 'http://example.com/pmwiki/pub'; $DefaultPasswords['admin'] = crypt('onesecret'); $EnableUpload = 1; $DefaultPasswords['upload'] = crypt('secrettwo'); # Uncomment and change these if needed # putenv("TZ=EST5EDT"); # if you run PHP 5.0 or older # date_default_timezone_set('America/New_York'); # if you run PHP 5.1 or newer $TimeFmt = '%B %d, %Y, at %I:%M %p EST';
Note that config.php begins with
The config.php file above sets the value of PHP variables used by Pm wiki:
By setting these (and other) variables in local/config.php, you can change the look and feel of Pm wiki from its default, sometimes substantially so. See PmWiki.Variables for a list of variables that Pm wiki uses, and see PmWiki:PmWikiUsers for examples of sites that use Pm wiki in customized ways.
Other common setup tasks
The following variables are often requested when preparing a new wiki
These common Cookbook recipes are also often installed immediately
If you prepare an international wiki, potentially with characters in different alphabets (Cyrillic, Greek, Chinese) or many diacritical symbols (Czech + French), please look at PmWiki.UTF-8 and Cookbook:UTF-8.
Review and set up any security required.
Setting an administrative password
The pages in the Site group (except the Site.Side bar) are locked by default. In order to edit pages in this group you need to create a site-wide admin password in local/config.php. To set the site-wide admin password to "
You must use the
Pm wiki 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. Pm wiki 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:
Just make an text-file. Paste <?php include('pmwiki.php'); into it.
By default Pmwiki uses an upload directory for each group
Page store directories
By default Pmwiki uses a single page store directory (wiki.d).
After setting up local/config.php file, you may wish to make other local customizations. See the PmWiki Cookbook for a large number of customizations that have been contributed. And don't fear Cookbook recipes - they're well prepared, so that most of them require only to download a single file, add a one-line include command to
If you (or others sharing your server) want to maintain more than one wiki on the same server, see Wiki Farms.
Don't forget to join a PmWiki mailing list, where you can email other wiki administrators for help on customizing Pm wiki and participate in discussions about Pm wiki improvements. Once you have your site operational, be sure to add it to PmWiki:PmWikiUsers so others will know about it!