1 5127fd58 2021-12-17 jrmu <?php if (!defined('PmWiki')) exit();
2 5127fd58 2021-12-17 jrmu ## This is a sample config.php file. To use this file, copy it to
3 5127fd58 2021-12-17 jrmu ## local/config.php, then edit it for whatever customizations you want.
4 5127fd58 2021-12-17 jrmu ## Also, be sure to take a look at https://www.pmwiki.org/wiki/Cookbook
5 5127fd58 2021-12-17 jrmu ## for more details on the customizations that can be added to PmWiki.
7 5127fd58 2021-12-17 jrmu ## $WikiTitle is the name that appears in the browser's title bar.
8 5127fd58 2021-12-17 jrmu $WikiTitle = 'PmWiki';
10 5127fd58 2021-12-17 jrmu ## $ScriptUrl is the URL for accessing wiki pages with a browser.
11 5127fd58 2021-12-17 jrmu ## $PubDirUrl is the URL for the pub directory.
12 5127fd58 2021-12-17 jrmu # $ScriptUrl = 'https://www.mydomain.com/path/to/pmwiki.php';
13 5127fd58 2021-12-17 jrmu # $PubDirUrl = 'https://www.mydomain.com/path/to/pub';
15 5127fd58 2021-12-17 jrmu ## If you want to use URLs of the form .../pmwiki.php/Group/PageName
16 5127fd58 2021-12-17 jrmu ## instead of .../pmwiki.php?p=Group.PageName, try setting
17 5127fd58 2021-12-17 jrmu ## $EnablePathInfo below. Note that this doesn't work in all environments,
18 5127fd58 2021-12-17 jrmu ## it depends on your webserver and PHP configuration. You might also
19 5127fd58 2021-12-17 jrmu ## want to check https://www.pmwiki.org/wiki/Cookbook/CleanUrls more
20 5127fd58 2021-12-17 jrmu ## details about this setting and other ways to create nicer-looking urls.
21 5127fd58 2021-12-17 jrmu # $EnablePathInfo = 1;
23 fc91d0f1 2023-03-07 jrmu ## $PageLogoUrl is the URL for a logo image -- you can change this
24 fc91d0f1 2023-03-07 jrmu ## to your own logo if you wish.
25 5127fd58 2021-12-17 jrmu # $PageLogoUrl = "$PubDirUrl/skins/pmwiki/pmwiki-32.gif";
27 fc91d0f1 2023-03-07 jrmu ## If you want to have a custom skin, then set $Skin to the name
28 fc91d0f1 2023-03-07 jrmu ## of the directory (in pub/skins/) that contains your skin files.
29 fc91d0f1 2023-03-07 jrmu ## See PmWiki.Skins and Cookbook.Skins.
30 fc91d0f1 2023-03-07 jrmu $Skin = 'pmwiki-responsive';
32 fc91d0f1 2023-03-07 jrmu ## You'll probably want to set an administrative password that you
33 fc91d0f1 2023-03-07 jrmu ## can use to get into password-protected pages. Also, by default
34 fc91d0f1 2023-03-07 jrmu ## the "attr" passwords for the PmWiki and Main groups are locked, so
35 fc91d0f1 2023-03-07 jrmu ## an admin password is a good way to unlock those. See PmWiki.Passwords
36 fc91d0f1 2023-03-07 jrmu ## and PmWiki.PasswordsAdmin.
37 5127fd58 2021-12-17 jrmu # $DefaultPasswords['admin'] = pmcrypt('secret');
39 fc91d0f1 2023-03-07 jrmu ## Unicode (UTF-8) allows the display of all languages and all alphabets.
40 fc91d0f1 2023-03-07 jrmu ## Highly recommended for new wikis.
41 5127fd58 2021-12-17 jrmu include_once("scripts/xlpage-utf-8.php");
43 fc91d0f1 2023-03-07 jrmu ## If you're running a publicly available site and allow anyone to
44 fc91d0f1 2023-03-07 jrmu ## edit without requiring a password, you probably want to put some
45 fc91d0f1 2023-03-07 jrmu ## blocklists in place to avoid wikispam. See PmWiki.Blocklist.
46 5127fd58 2021-12-17 jrmu # $EnableBlocklist = 1; # enable manual blocklists
47 5127fd58 2021-12-17 jrmu # $EnableBlocklist = 10; # enable automatic blocklists
49 5127fd58 2021-12-17 jrmu ## PmWiki comes with graphical user interface buttons for editing;
50 5127fd58 2021-12-17 jrmu ## to enable these buttons, set $EnableGUIButtons to 1.
51 5127fd58 2021-12-17 jrmu # $EnableGUIButtons = 1;
53 fc91d0f1 2023-03-07 jrmu ## This enables a message if editors have modified a page but try to
54 fc91d0f1 2023-03-07 jrmu ## move away from the edit form before saving the text.
55 fc91d0f1 2023-03-07 jrmu $EnableNotSavedWarning = 1; # 1: warn editors; 0: disable warning
57 fc91d0f1 2023-03-07 jrmu ## You can enable syntax highlighting for the documentation and/or
58 fc91d0f1 2023-03-07 jrmu ## for the edit form.
59 fc91d0f1 2023-03-07 jrmu # $EnablePmSyntax = 1; # or 2, see documentation
61 fc91d0f1 2023-03-07 jrmu ## For a basic table of contents, see page PmWiki/TableOfContents
62 fc91d0f1 2023-03-07 jrmu # $PmTOC['Enable'] = 1;
64 5127fd58 2021-12-17 jrmu ## To enable markup syntax from the Creole common wiki markup language
65 5127fd58 2021-12-17 jrmu ## (http://www.wikicreole.org/), include it here:
66 5127fd58 2021-12-17 jrmu # include_once("scripts/creole.php");
68 5127fd58 2021-12-17 jrmu ## Some sites may want leading spaces on markup lines to indicate
69 5127fd58 2021-12-17 jrmu ## "preformatted text blocks", set $EnableWSPre=1 if you want to do
70 5127fd58 2021-12-17 jrmu ## this. Setting it to a higher number increases the number of
71 5127fd58 2021-12-17 jrmu ## space characters required on a line to count as "preformatted text".
72 5127fd58 2021-12-17 jrmu # $EnableWSPre = 1; # lines beginning with space are preformatted (default)
73 5127fd58 2021-12-17 jrmu # $EnableWSPre = 4; # lines with 4 or more spaces are preformatted
74 5127fd58 2021-12-17 jrmu # $EnableWSPre = 0; # disabled
76 5127fd58 2021-12-17 jrmu ## If you want uploads enabled on your system, set $EnableUpload=1.
77 5127fd58 2021-12-17 jrmu ## You'll also need to set a default upload password, or else set
78 5127fd58 2021-12-17 jrmu ## passwords on individual groups and pages. For more information
79 5127fd58 2021-12-17 jrmu ## see PmWiki.UploadsAdmin.
80 5127fd58 2021-12-17 jrmu # $EnableUpload = 1;
81 5127fd58 2021-12-17 jrmu # $DefaultPasswords['upload'] = pmcrypt('secret');
82 5127fd58 2021-12-17 jrmu $UploadPermAdd = 0; # Recommended for most new installations
84 5127fd58 2021-12-17 jrmu ## Setting $EnableDiag turns on the ?action=diag and ?action=phpinfo
85 5127fd58 2021-12-17 jrmu ## actions, which often helps others to remotely troubleshoot
86 5127fd58 2021-12-17 jrmu ## various configuration and execution problems.
87 5127fd58 2021-12-17 jrmu # $EnableDiag = 1; # enable remote diagnostics
89 5127fd58 2021-12-17 jrmu ## By default, PmWiki doesn't allow browsers to cache pages. Setting
90 5127fd58 2021-12-17 jrmu ## $EnableIMSCaching=1; will re-enable browser caches in a somewhat
91 5127fd58 2021-12-17 jrmu ## smart manner. Note that you may want to have caching disabled while
92 5127fd58 2021-12-17 jrmu ## adjusting configuration files or layout templates.
93 5127fd58 2021-12-17 jrmu # $EnableIMSCaching = 1; # allow browser caching
95 5127fd58 2021-12-17 jrmu ## Set $SpaceWikiWords if you want WikiWords to automatically
96 5127fd58 2021-12-17 jrmu ## have spaces before each sequence of capital letters.
97 5127fd58 2021-12-17 jrmu # $SpaceWikiWords = 1; # turn on WikiWord spacing
99 5127fd58 2021-12-17 jrmu ## Set $EnableWikiWords if you want to allow WikiWord links.
100 5127fd58 2021-12-17 jrmu ## For more options with WikiWords, see scripts/wikiwords.php .
101 5127fd58 2021-12-17 jrmu # $EnableWikiWords = 1; # enable WikiWord links
103 5127fd58 2021-12-17 jrmu ## $DiffKeepDays specifies the minimum number of days to keep a page's
104 5127fd58 2021-12-17 jrmu ## revision history. The default is 3650 (approximately 10 years).
105 5127fd58 2021-12-17 jrmu # $DiffKeepDays=30; # keep page history at least 30 days
107 fc91d0f1 2023-03-07 jrmu ## By default, viewers are prevented from seeing the existence
108 fc91d0f1 2023-03-07 jrmu ## of read-protected pages in search results and page listings,
109 fc91d0f1 2023-03-07 jrmu ## but this can be slow as PmWiki has to check the permissions
110 fc91d0f1 2023-03-07 jrmu ## of each page. Setting $EnablePageListProtect to zero will
111 fc91d0f1 2023-03-07 jrmu ## speed things up considerably, but it will also mean that
112 fc91d0f1 2023-03-07 jrmu ## viewers may learn of the existence of read-protected pages.
113 fc91d0f1 2023-03-07 jrmu ## (It does not enable them to access the contents of the pages.)
114 5127fd58 2021-12-17 jrmu # $EnablePageListProtect = 0;
116 5127fd58 2021-12-17 jrmu ## The refcount.php script enables ?action=refcount, which helps to
117 5127fd58 2021-12-17 jrmu ## find missing and orphaned pages. See PmWiki.RefCount.
118 5127fd58 2021-12-17 jrmu # if ($action == 'refcount') include_once("scripts/refcount.php");
120 5127fd58 2021-12-17 jrmu ## The feeds.php script enables ?action=rss, ?action=atom, ?action=rdf,
121 5127fd58 2021-12-17 jrmu ## and ?action=dc, for generation of syndication feeds in various formats.
122 5127fd58 2021-12-17 jrmu # if ($action == 'rss') include_once("scripts/feeds.php"); # RSS 2.0
123 5127fd58 2021-12-17 jrmu # if ($action == 'atom') include_once("scripts/feeds.php"); # Atom 1.0
124 5127fd58 2021-12-17 jrmu # if ($action == 'dc') include_once("scripts/feeds.php"); # Dublin Core
125 5127fd58 2021-12-17 jrmu # if ($action == 'rdf') include_once("scripts/feeds.php"); # RSS 1.0
127 5127fd58 2021-12-17 jrmu ## By default, pages in the Category group are manually created.
128 5127fd58 2021-12-17 jrmu ## Uncomment the following line to have blank category pages
129 5127fd58 2021-12-17 jrmu ## automatically created whenever a link to a non-existent
130 5127fd58 2021-12-17 jrmu ## category page is saved. (The page is created only if
131 5127fd58 2021-12-17 jrmu ## the author has edit permissions to the Category group.)
132 5127fd58 2021-12-17 jrmu # $AutoCreate['/^Category\\./'] = array('ctime' => $Now);
134 5127fd58 2021-12-17 jrmu ## PmWiki allows a great deal of flexibility for creating custom markup.
135 5127fd58 2021-12-17 jrmu ## To add support for '*bold*' and '~italic~' markup (the single quotes
136 5127fd58 2021-12-17 jrmu ## are part of the markup), uncomment the following lines.
137 5127fd58 2021-12-17 jrmu ## (See PmWiki.CustomMarkup and the Cookbook for details and examples.)
138 5127fd58 2021-12-17 jrmu # Markup("'~", "<'''''", "/'~(.*?)~'/", "<i>$1</i>"); # '~italic~'
139 5127fd58 2021-12-17 jrmu # Markup("'*", "<'''''", "/'\\*(.*?)\\*'/", "<b>$1</b>"); # '*bold*'
141 5127fd58 2021-12-17 jrmu ## If you want to have to approve links to external sites before they
142 5127fd58 2021-12-17 jrmu ## are turned into links, uncomment the line below. See PmWiki.UrlApprovals.
143 5127fd58 2021-12-17 jrmu ## Also, setting $UnapprovedLinkCountMax limits the number of unapproved
144 5127fd58 2021-12-17 jrmu ## links that are allowed in a page (useful to control wikispam).
145 5127fd58 2021-12-17 jrmu # $UnapprovedLinkCountMax = 10;
146 5127fd58 2021-12-17 jrmu # include_once("scripts/urlapprove.php");
148 5127fd58 2021-12-17 jrmu ## The following lines make additional editing buttons appear in the
149 5127fd58 2021-12-17 jrmu ## edit page for subheadings, lists, tables, etc.
150 5127fd58 2021-12-17 jrmu # $GUIButtons['h2'] = array(400, '\\n!! ', '\\n', '$[Heading]',
151 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/h2.gif"$[Heading]"');
152 5127fd58 2021-12-17 jrmu # $GUIButtons['h3'] = array(402, '\\n!!! ', '\\n', '$[Subheading]',
153 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/h3.gif"$[Subheading]"');
154 5127fd58 2021-12-17 jrmu # $GUIButtons['indent'] = array(500, '\\n->', '\\n', '$[Indented text]',
155 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/indent.gif"$[Indented text]"');
156 5127fd58 2021-12-17 jrmu # $GUIButtons['outdent'] = array(510, '\\n-<', '\\n', '$[Hanging indent]',
157 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/outdent.gif"$[Hanging indent]"');
158 5127fd58 2021-12-17 jrmu # $GUIButtons['ol'] = array(520, '\\n# ', '\\n', '$[Ordered list]',
159 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/ol.gif"$[Ordered (numbered) list]"');
160 5127fd58 2021-12-17 jrmu # $GUIButtons['ul'] = array(530, '\\n* ', '\\n', '$[Unordered list]',
161 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/ul.gif"$[Unordered (bullet) list]"');
162 5127fd58 2021-12-17 jrmu # $GUIButtons['hr'] = array(540, '\\n----\\n', '', '',
163 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/hr.gif"$[Horizontal rule]"');
164 5127fd58 2021-12-17 jrmu # $GUIButtons['table'] = array(600,
165 5127fd58 2021-12-17 jrmu # '||border=1 width=80%\\n||!Hdr ||!Hdr ||!Hdr ||\\n|| || || ||\\n|| || || ||\\n', '', '',
166 5127fd58 2021-12-17 jrmu # '$GUIButtonDirUrlFmt/table.gif"$[Table]"');
