CC setting is now an admin option. Original patch provided by Rouslan Placella. (feature request #0001259)
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <title>Geeklog Documentation - Configuration</title>
5 <link rel="stylesheet" type="text/css" href="../docstyle.css" title="Dev Stylesheet">
9 <p><a href="http://www.geeklog.net/" style="background:transparent"><img src="../images/newlogo.gif" alt="Geeklog" width="243" height="90"></a></p>
10 <div class="menu"><a href="index.html">Geeklog Documentation</a> - Configuration</div>
12 <h1>Geeklog Configuration</h1>
14 <h2>Configuration files</h2>
16 <p>Previous versions of Geeklog used one huge file called <tt>config.php</tt>
17 that held all the core configuration options. As of Geeklog 1.5.0, most of
18 the configuration options have been moved to the database and can now be
19 reached from the <b>Configuration</b> admin panel within Geeklog.</p>
21 <p>For technical reasons, some configuration options still have to be
22 stored in files. There are two such configuration files now:
24 <li><a href="#db-config.php">db-config.php</a></li>
25 <li><a href="#siteconfig.php">siteconfig.php</a></li>
27 <p>These files are updated
28 when you install Geeklog and you will not normally have to edit them
31 <h1>Configuration options</h1>
33 <p>Geeklog's configuration options are grouped like this:</p>
36 <li><a href="#site">Site</a></li>
37 <li><a href="#stories">Stories and Trackback</a></li>
38 <li><a href="#theme">Theme</a></li>
39 <li><a href="#blocks">Blocks</a></li>
40 <li><a href="#users">Users and Submissions</a></li>
41 <li><a href="#images">Images</a></li>
42 <li><a href="#languages">Languages and Locale</a></li>
43 <li><a href="#misc">Miscellaneous</a></li>
46 <h2><a name="site">Site</a></h2>
48 <h3><a name="site_site">Site: Site</a></h3>
50 <table border="1" width="100%">
51 <tr><th style="width:8%">Variable</th>
52 <th style="width:29%">Default Value</th>
53 <th style="width:63%">Description</th></tr>
55 <td valign="top"><a name="desc_site_url">site_url</a></td>
56 <td valign="top">http://www.example.com</td>
57 <td valign="top">Base URL for your site (no trailing slash)</td></tr>
59 <td valign="top"><a name="desc_site_admin_url">site_admin_url</a></td>
60 <td valign="top">http://www.example.com/admin</td>
61 <td valign="top">Base URL of the admin area of your site (no trailing slash).
62 You won't have to change this normally, but some hosting services use a
63 predefined "admin" directory for other purposes. In this case, you can
64 rename Geeklog's <tt>admin</tt> directory and adjust the URL accordingly to
65 avoid conflicts.</td></tr>
67 <td valign="top"><a name="desc_site_name">site_name</a></td>
68 <td valign="top">Geeklog Site</td>
69 <td valign="top">Name of your site</td></tr>
71 <td valign="top"><a name="desc_site_slogan">site_slogan</a></td>
72 <td valign="top">Another Nifty Geeklog Site</td>
73 <td valign="top">Slogan for your site. This is added to the HTML title field.</td></tr>
75 <td valign="top"><a name="desc_microsummary_short">microsummary_short</a></td>
76 <td valign="top">GL:</td>
77 <td valign="top">Prefix to use for a <a href="http://wiki.mozilla.org/Microsummaries">microsummary</a>.</td></tr>
79 <td valign="top"><a name="desc_site_disabled_msg">site_disabled_msg</a></td>
80 <td valign="top">'Geeklog Site is down. Please come back soon.'</td>
81 <td valign="top">This contains the message to display when a Geeklog site is
82 disabled. If the text begins with "http:" then visitors are redirected to
84 <strong>Note:</strong> The option actually disable the site can be found
85 in the <tt>siteconfig.php</tt> file.</td></tr>
87 <td valign="top"><a name="desc_owner_name">owner_name</a></td>
88 <td valign="top"></td>
89 <td valign="top">The name of the owner of the site. This is used in the copyright notice if set, else the site name is used.</td></tr>
91 <td valign="top"><a name="desc_copyrightyear">copyrightyear</a></td>
92 <td valign="top"><i>(disabled)</i></td>
93 <td valign="top">Set this to the year you want to appear in the copyright notice of your
94 site's footer. If not set, Geeklog will use the current year.</td></tr>
96 <td valign="top"><a name="desc_url_rewrite">url_rewrite</a></td>
97 <td valign="top">false</td>
98 <td valign="top">Enable (true) or disable (false) URL rewriting.<br>
99 Also see the section on <a href="#url-rewrite">URL Rewriting</a> below.</td></tr>
101 <td valign="top"><a name="desc_cdn_hosted">cdn_hosted</a></td>
102 <td valign="top">false</td>
103 <td valign="top">Enable (true) or disable (false) Google CDN-hosted source for jQuery
104 and jQuery UI.</td></tr>
106 <td valign="top"><a name="desc_meta_tags">meta_tags</a></td>
107 <td valign="top">disabled</td>
108 <td valign="top">Enabled - The meta tags for stories and topics will be displayed. If none are found, then the default will be used. The default will also be used for any page that doesn't have meta tags.<br>
109 Enabled (Default for Homepage only) - The same as Enabled except, the defaults are used only for the Homepage.<br>
110 Disabled - Meta tags are not used.</td></tr>
112 <td valign="top"><a name="desc_meta_description">meta_description</a></td>
113 <td valign="top">'Geeklog, the open source content management system designed with security in mind.'</td>
114 <td valign="top">The default meta description for your site.</td></tr>
116 <td valign="top"><a name="desc_meta_keywords">meta_keywords</a></td>
117 <td valign="top">'Geeklog, Blog, Content Management System, CMS, Open Source, Security'</td>
118 <td valign="top">The default meta keywords for your site.</td></tr>
121 <h3><a name="site_mail">Site: Mail</a></h3>
123 <table border="1" width="100%">
124 <tr><th style="width:8%">Variable</th>
125 <th style="width:29%">Default Value</th>
126 <th style="width:63%">Description</th></tr>
128 <td valign="top"><a name="desc_site_mail">site_mail</a></td>
129 <td valign="top">admin@example.com</td>
130 <td valign="top">E-mail address for all admin mail</td></tr>
132 <td valign="top"><a name="desc_noreply_mail">noreply_mail</a></td>
133 <td valign="top">noreply@example.com</td>
134 <td valign="top">This is the sender's address of emails sent by the system when users register etc.
135 This should be either the same as $_CONF['site_mail'] or a bouncing address
136 to prevent spammers from getting your email address by registering on the site.
137 If this is NOT the same as above, there will be a message in sent messages
138 that replying to those emails is recommended.</td></tr>
139 <tr><td valign="top"><a name="desc_mail_settings_backend">backend</a></td>
140 <td valign="top">mail</td>
141 <td valign="top">Used to select how to send email. Can be one of 'smtp',
142 'sendmail', or 'mail'.</td></tr>
143 <tr><td valign="top"><a name="desc_mail_settings_sendmail_path">sendmail_path</a></td>
144 <td valign="top"><tt>/usr/bin/sendmail</tt></td>
145 <td valign="top">If you chose 'sendmail' for the backend setting, this
146 specifies the complete path to the sendmail binary.</td></tr>
147 <tr><td valign="top"><a name="desc_mail_settings_sendmail_args">sendmail_args</a></td>
148 <td valign="top"><tt>''</tt> <i>(empty)</i></td>
149 <td valign="top">If you chose 'sendmail' for the backend setting, this
150 variable can be used to pass additional parameters to the sendmail
152 <tr><td valign="top"><a name="desc_mail_settings_host">host</a></td>
153 <td valign="top">smtp.example.com</td>
154 <td valign="top">If you chose 'smtp' for the backend setting, this is the
155 SMTP server to use.</td></tr>
156 <tr><td valign="top"><a name="desc_mail_settings_port">port</a></td>
157 <td valign="top">25</td>
158 <td valign="top">If you chose 'smtp' for the backend setting, this is the
159 port number to talk to on the SMTP server.</td></tr>
160 <tr><td valign="top"><a name="desc_mail_settings_auth">auth</a></td>
161 <td valign="top">0</td>
162 <td valign="top">If you chose 'smtp' for the backend setting, set this to
163 <code>1</code> if your SMTP server requires authorization, and
164 <code>0</code> (or leave the field empty) if it doesn't.</td></tr>
165 <tr><td valign="top"><a name="desc_mail_settings_username">username</a></td>
166 <td valign="top">smtp-username</td>
167 <td valign="top">If you chose 'smtp' for the backend setting, this is the
168 name of your SMTP account.</td></tr>
169 <tr><td valign="top"><a name="desc_mail_settings_password">password</a></td>
170 <td valign="top">smtp-password</td>
171 <td valign="top">If you chose 'smtp' for the backend setting, this is the
172 password for your SMTP account.</td></tr>
173 <tr><td valign="top"><a name="desc_mail_cc_enabled">cc_enabled</a></td>
174 <td valign="top">True</td>
175 <td valign="top">Whether to allow users to send a copy of an email to themselves.</td></tr>
176 <tr><td valign="top"><a name="desc_mail_cc_default">cc_default</a></td>
177 <td valign="top">False</td>
178 <td valign="top">Whether the carbon copy checkbox in the email form is ticked by default.</td></tr>
181 <h3><a name="site_syndication">Site: Syndication</a></h3>
183 <p>Geeklog can export its headlines to a news feed in various formats (RSS, RDF, and Atom). This will let you share your news with other sites (Hint: Create a Portal block from Geeklog's Block menu to import news feeds from other sites).</p>
185 <p>Starting with Geeklog 1.3.9, feeds can be created and configured from
186 Geeklog's Admin menu ("Content Syndication"). The following settings will only
187 be used as the <em>default settings</em> for any new feeds that you create from
190 <table border="1" width="100%">
191 <tr><th style="width:8%">Variable</th>
192 <th style="width:29%">Default Value</th>
193 <th style="width:63%">Description</th></tr>
194 <tr><td valign="top"><a name="desc_backend">backend</a></td>
195 <td valign="top">1</td>
196 <td valign="top">Create a feed file for the stories in rdf_file (0=no, 1=yes)</td></tr>
197 <tr><td valign="top"><a name="desc_rdf_file">rdf_file</a></td>
198 <td valign="top">HTML path with "/backend/geeklog.rss" suffix</td>
199 <td valign="top">File system path for the feed file. This file allows you to share your site's headlines with others</td></tr>
200 <tr><td valign="top"><a name="desc_rdf_limit">rdf_limit</a></td>
201 <td valign="top">10</td>
202 <td valign="top">Limit the number of stories to export to the news feed. If the value for this setting is a number, the feed will hold this many stories. If the number is followed by a lower-case 'h' (e.g. 24h) it denotes the number of hours from which to chose the stories.</td></tr>
203 <tr><td valign="top"><a name="desc_rdf_storytext">rdf_storytext</a></td>
204 <td valign="top">0</td>
205 <td valign="top">If this value is 1, then the entire introtext of the stories will be included in the news feed. Any number greater than 1 limits the introtext to that many characters (e.g. a value of 80 would only include the first 80 characters from the introtext in the feed). If set to 0, the introtext is not included in the feed.</td></tr>
206 <tr><td valign="top"><a name="desc_rdf_language">rdf_language</a></td>
207 <td valign="top">en-gb</td>
208 <td valign="top">Value for the feed's language tag. Depending on your site's language and operating system, this may differ from the language setting in the locale (see above).<br><strong>Example:</strong> The PHP locale setting for German is 'de_DE' while the correct language setting for a German RSS feed would be 'de-DE' (note the dash instead of the underscore).</td></tr>
209 <tr><td valign="top"><a name="desc_syndication_max_headlines">syndication_max_headlines</a></td>
210 <td valign="top">0</td>
211 <td valign="top">Upper limit for the max. number of headlines when <em>importing</em> a feed (into a portal block). The limit can also be set for each individual portal block in the block menu.<br>
212 When set to 0, all headlines are imported.</td></tr>
215 <h3><a name="site_paths">Site: Paths</a></h3>
217 <table border="1" width="100%">
218 <tr><th style="width:8%">Variable</th>
219 <th style="width:29%">Default Value</th>
220 <th style="width:63%">Description</th></tr>
221 <tr><td valign="top"><a name="desc_path_html">path_html</a></td>
222 <td valign="top">/path/to/geeklog/public_html/</td>
223 <td valign="top">Path to your web tree directory for your site (trailing slash necessary). This directory holds all the web pages used by Geeklog.</td></tr>
224 <tr><td valign="top"><a name="desc_path_log">path_log</a></td>
225 <td valign="top">/path/to/geeklog/logs/</td>
226 <td valign="top">File system path for the log files</td></tr>
227 <tr><td valign="top"><a name="desc_path_language">path_language</a></td>
228 <td valign="top">/path/to/geeklog/language/</td>
229 <td valign="top">location of the Geeklog language files</td></tr>
230 <tr><td valign="top"><a name="desc_backup_path">backup_path</a></td>
231 <td valign="top">/path/to/geeklog/backups/</td>
232 <td valign="top">location where mysqldump (see above) will store database backups</td></tr>
233 <tr><td valign="top"><a name="desc_path_data">path_data</a></td>
234 <td valign="top">/path/to/geeklog/data/</td>
235 <td valign="top">File system path for the data directory, used e.g. for the user batch add feature</td></tr>
236 <tr><td valign="top"><a name="desc_path_images">path_images</a></td>
237 <td valign="top">/path/to/geeklog/public_html/images/</td>
238 <td valign="top">Path where Geeklog expects to find its images, including
239 user photos and images for stories.</td>
242 <h3><a name="site_pear">Site: PEAR</a></h3>
244 <table border="1" width="100%">
245 <tr><th style="width:8%">Variable</th>
246 <th style="width:29%">Default Value</th>
247 <th style="width:63%">Description</th></tr>
248 <tr><td valign="top"><a name="desc_have_pear">have_pear</a></td>
249 <td valign="top"><code>false</code></td>
250 <td valign="top">Whether you have <a href="http://pear.php.net/">PEAR</a>
251 installed on your server (<code>= true</code>) or not
252 (<code>= false</code>). When set to <code>false</code>, Geeklog will
253 use the PEAR packages installed in <code>$_CONF['path_pear']</code>
254 (see below)</td></tr>
255 <tr><td valign="top"><a name="desc_path_pear">path_pear</a></td>
256 <td valign="top"><tt>/path/to/geeklog/system/pear/</tt></td>
257 <td valign="top">When <code>$_CONF['have_pear']</code> (see above) is set
258 to <code>false</code>, this is the path where Geeklog expects to find
259 the <a href="http://pear.php.net/">PEAR</a> packages it requires (e.g.
260 PEAR::Mail for sending emails).</td></tr>
263 <h3><a name="site_mysql">Site: MySQL</a></h3>
265 <p>As the name implies, these options are only relevant when your site is
266 running on a MySQL database. They are ignored when using MS SQL.</p>
268 <table border="1" width="100%">
269 <tr><th style="width:8%">Variable</th>
270 <th style="width:29%">Default Value</th>
271 <th style="width:63%">Description</th></tr>
272 <tr><td valign="top"><a name="desc_allow_mysqldump">allow_mysqldump</a></td>
273 <td valign="top">1</td>
274 <td valign="top">Enable or disable the backup functionality (1 = on,
276 <tr><td valign="top"><a name="desc_mysqldump_path">_DB_mysqldump_path</a></td>
277 <td valign="top">/usr/bin/mysqldump</td>
278 <td valign="top">Complete path to the <a
279 href="http://www.mysql.com/doc/en/mysqldump.html">mysqldump</a> utility
280 (part of MySQL) for making backups of your Geeklog database.</td></tr>
281 <tr><td valign="top"><a name="desc_mysqldump_options">mysqldump_options</a></td>
282 <td valign="top">-Q</td>
283 <td valign="top">Here you can include additional options for the <a
284 href="http://www.mysql.com/doc/en/mysqldump.html">mysqldump</a> call
285 that Geeklog uses to create a backup from your database.</td></tr>
286 <tr><td valign="top"><a name="desc_mysqldump_filename_mask">mysqldump_filename_mask</a></td>
287 <td valign="top">geeklog_db_backup_%Y_%m_%d_%H_%M_%S.sql</td>
288 <td valign="top">Mask to use for the names of the backup files. See <a
289 href="#date_formats">date formats</a> below for details of the date and
290 time in the file name.</td></tr>
293 <h3><a name="site_search">Site: Search</a></h3>
295 <table border="1" width="100%">
296 <tr><th style="width:8%">Variable</th>
297 <th style="width:29%">Default Value</th>
298 <th style="width:63%">Description</th></tr>
300 <td valign="top"><a name="desc_search_style">search_style</a></td>
301 <td valign="top">'google'</td>
302 <td valign="top">Sets the style of the results page. Can be either 'google' or 'table'</td></tr>
304 <td valign="top"><a name="desc_search_limits">search_limits</a></td>
305 <td valign="top">10,15,25,30</td>
306 <td valign="top">The result limits a user can select. Each value <b>must</b> be separated with a comma.</td></tr>
308 <td valign="top"><a name="desc_num_search_results">num_search_results</a></td>
309 <td valign="top">30</td>
310 <td valign="top">The default number of results per page. Should be a value from 'search_limits' above.</td></tr>
312 <td valign="top"><a name="desc_search_show_limit">search_show_limit</a></td>
313 <td valign="top">true</td>
314 <td valign="top">Shows (= true) or hides (= false) the page limits selection box.</td></tr>
316 <td valign="top"><a name="desc_search_show_sort">search_show_sort</a></td>
317 <td valign="top">true</td>
318 <td valign="top">Shows (= true) or hides (= false) the 'Sort By' selection box. (When using the table style it will enable/disable column sorting)</td></tr>
320 <td valign="top"><a name="desc_search_show_num">search_show_num</a></td>
321 <td valign="top">true</td>
322 <td valign="top">Shows (= true) or hides (= false) the result number.</td></tr>
324 <td valign="top"><a name="desc_search_show_type">search_show_type</a></td>
325 <td valign="top">true</td>
326 <td valign="top">Shows (= true) or hides (= false) the plugin name the result came from.</td></tr>
328 <td valign="top"><a name="desc_search_separator">search_separator</a></td>
329 <td valign="top"> &gt; (Space before and after character)</td>
330 <td valign="top">The character to display between result type sub groups.</td></tr>
332 <td valign="top"><a name="desc_search_def_keytype">search_def_keytype</a></td>
333 <td valign="top">'phrase'</td>
334 <td valign="top">Default to one of these search methods:<ul>
335 <li>'all': results must contain all of the search terms.</li>
336 <li>'any': results may contain any of the search terms.</li>
337 <li>'phrase': search for the exact phrase as entered. (default)</li>
340 <td valign="top"><a name="desc_search_def_sort">search_def_sort</a></td>
341 <td valign="top">'Hits (desc)'</td>
342 <td valign="top">The default sort order for the search results.</td></tr>
346 <h2><a name="stories">Stories and Trackback</a></h2>
348 <h3><a name="stories_story">Stories and Trackback: Story</a></h3>
350 <table border="1" width="100%">
351 <tr><th style="width:8%">Variable</th>
352 <th style="width:29%">Default Value</th>
353 <th style="width:63%">Description</th></tr>
355 <td valign="top"><a name="desc_maximagesperarticle">maximagesperarticle</a></td>
356 <td valign="top">5</td>
357 <td valign="top">max. number of images you can have in a story</td></tr>
359 <td valign="top"><a name="desc_limitnews">limitnews</a></td>
360 <td valign="top">10</td>
361 <td valign="top">Number of stories to limit the index page to, this same number will appear in the older stuff block</td></tr>
363 <td valign="top"><a name="desc_minnews">minnews</a></td>
364 <td valign="top">1</td>
365 <td valign="top">Minimum numbers of stories than can appear on a topic page</td></tr>
368 <td valign="top"><a name="desc_contributedbyline">contributedbyline</a></td>
369 <td valign="top">1</td>
370 <td valign="top">Show author username to public, and enable search by username (0=no, 1=yes)</td></tr>
372 <td valign="top"><a name="desc_hideviewscount">hideviewscount</a></td>
373 <td valign="top">0</td>
374 <td valign="top">Whether to show (= 0) or to hide (= 1) the number of views
375 a story has had.</td></tr>
377 <td valign="top"><a name="desc_hideemailicon">hideemailicon</a></td>
378 <td valign="top">0</td>
379 <td valign="top">When set to 1, this will disable the ability to send a story by email. It
380 will also hide the email icon from stories and the "Email Article To a
381 Friend" from the Story Options block.</td></tr>
383 <td valign="top"><a name="desc_hideprintericon">hideprintericon</a></td>
384 <td valign="top">0</td>
385 <td valign="top">When set to 1, this will disable display of a story in a "printer
386 friendly" format. It will also hide the printer icon from stories and
387 the "View Printable Version" from the Story Options
390 <td valign="top"><a name="desc_allow_page_breaks">allow_page_breaks</a></td>
391 <td valign="top">1</td>
392 <td valign="top">Allow usage of the <code>[page_break]</code> tag in stories (when set to 1), so that stories can spread over multiple pages.</td></tr>
394 <td valign="top"><a name="desc_page_break_comments">page_break_comments</a></td>
395 <td valign="top">last</td>
396 <td valign="top">When the <code>[page_break]</code> tag is allowed in stories (see above), where should the story's comments be displayed: <code>'last'</code> = on the story's last page only, <code>'first'</code> = on the first page only, <code>'all'</code> = on every page.</td></tr>
398 <td valign="top"><a name="desc_article_image_align">article_image_align</a></td>
399 <td valign="top">right</td>
400 <td valign="top">Which side of article the topic image should be shown (right or left)</td></tr>
402 <td valign="top"><a name="desc_show_topic_icon">show_topic_icon</a></td>
403 <td valign="top">1</td>
404 <td valign="top">Default setting for new stories and story submissions: Whether to show the topic icon (1) or not (0).</td></tr>
406 <td valign="top"><a name="desc_draft_flag">draft_flag</a></td>
407 <td valign="top">0</td>
408 <td valign="top">Default setting for new stories created by Story Admins: Whether the story's draft flag should be set (1) or not (0).</td></tr>
410 <td valign="top"><a name="desc_frontpage">frontpage</a></td>
411 <td valign="top">0</td>
412 <td valign="top">Default setting for new stories and story submissions: Whether the story should appear on the site's frontpage (1) or only in its topic's page (0). Please note that for stories submitted to the archive topic, this setting will be ignored and the story will <em>not</em> appear on the frontpage.</td></tr>
414 <td valign="top"><a name="desc_hide_no_news_msg">hide_no_news_msg</a></td>
415 <td valign="top">0</td>
416 <td valign="top">When set to 1, hide the "No News To Display" message on the index page (e.g. when viewing a topic without any stories in it)</td></tr>
418 <td valign="top"><a name="desc_hide_main_page_navigation">hide_main_page_navigation</a></td>
419 <td valign="top">0</td>
420 <td valign="top">When set to 1, this option will hide the "Google paging"
421 navigation from index.php, i.e. from the site's frontpage and all topic
422 pages. This may come in handy for more advanced layouts but will of course
423 prevent people from easily reaching older articles.</td></tr>
425 <td valign="top"><a name="desc_onlyrootfeatures">onlyrootfeatures</a></td>
426 <td valign="top">0</td>
427 <td valign="top">This restricts the featuring of stories to root user(s). If you have several story admins who can create content that is not visible to other story admins,
428 and such a content is featured, another admin might think its ok to feature his own content. To prevent
429 that two admins unknowingly take features from each other away, only a user who can see all content (= root)
430 should be able to feature a story.</td></tr>
432 <td valign="top"><a name="desc_aftersave_story">aftersave_story</a></td>
433 <td valign="top">'list'</td>
434 <td valign="top">Which page to go to after a story has been saved:
436 <li>'item': display the story</li>
437 <li>'list': show admin's list of stories (default)</li>
438 <li>'home': display the site's homepage</li>
439 <li>'admin': go to the "Admin Home" page, i.e. Command & Control</li>
441 <strong>Note:</strong> This option is ignored for story submissions. Editing
442 a story submission will always send you back to the submission queue (i.e.
443 "Admin Home" aka Command & Control).</td></tr>
446 <h3><a name="stories_trackback">Stories and Trackback: Trackback</a></h3>
448 <table border="1" width="100%">
449 <tr><th style="width:8%">Variable</th>
450 <th style="width:29%">Default Value</th>
451 <th style="width:63%">Description</th></tr>
453 <td valign="top"><a name="desc_trackback_enabled">trackback_enabled</a></td>
454 <td valign="top">true</td>
455 <td valign="top">Enable (true) or disable (true) <a href="http://en.wikipedia.org/wiki/Trackback">trackback</a> comments. This applies to both sending and receiving trackback comments.</td></tr>
457 <td valign="top"><a name="desc_trackback_code">trackback_code</a></td>
458 <td valign="top">0</td>
459 <td valign="top">Default value for new stories: Trackback enabled (0) or disabled (-1)</td></tr>
461 <td valign="top"><a name="desc_trackbackspeedlimit">trackbackspeedlimit</a></td>
462 <td valign="top">300</td>
463 <td valign="top">Number of seconds between two trackbacks / pingbacks from the same IP address.</td></tr>
465 <td valign="top"><a name="desc_check_trackback_link">check_trackback_link</a></td>
466 <td valign="top">2</td>
467 <td valign="top">This option can be used to check the validity of a trackback.
468 You can check if the URL in the trackback actually contains a link back to
469 your site (otherwise, it's probably spam). You can also check if the
470 trackback was sent from the proper IP address, i.e. the IP of the site in
471 the trackback URL (again, if they don't match, it's probably spam). Note
472 that you can <strong>add up the values</strong> below to do more than one
473 check (but using option 1 <em>and</em> 2 doesn't make sense and will be
474 treated as if you requested option 2).<br>
475 Options are: 0 = don't perform any checks, 1 = check only for your site's main URL (<code>$_CONF['site_url']</code>), 2 = check for the exact URL of the entry (e.g. an article) on your site, 4 = check IP address of the sender of the trackback against the site referred to in the trackback URL.<br>
476 <b>Example:</b> <code>$_CONF['check_trackback_link'] = 6; // check for the exact URL (2) and proper IP address (4)</code></td></tr>
478 <td valign="top"><a name="desc_multiple_trackbacks">multiple_trackbacks</a></td>
479 <td valign="top">0</td>
480 <td valign="top">How to handle multiple trackbacks and pingbacks from the same source: 0 = keep only the first, reject any further trackbacks / pingbacks; 1 = overwrite, i.e. only keep the latest trackback / pingback; 2 = allow multiple trackbacks / pingbacks, i.e. list them all</td></tr>
483 <h3><a name="stories_pingback">Stories and Trackback: Pingback</a></h3>
485 <table border="1" width="100%">
486 <tr><th style="width:8%">Variable</th>
487 <th style="width:29%">Default Value</th>
488 <th style="width:63%">Description</th></tr>
490 <td valign="top"><a name="desc_pingback_enabled">pingback_enabled</a></td>
491 <td valign="top">true</td>
492 <td valign="top">Enable (true) or disable (true) <a href="http://en.wikipedia.org/wiki/Pingback">pingback</a> support. This applies to both sending and receiving pingbacks.</td></tr>
494 <td valign="top"><a name="desc_pingback_excerpt">pingback_excerpt</a></td>
495 <td valign="top">true</td>
496 <td valign="top">Unlike Trackbacks, Pingback don't include an excerpt of the
497 text from the site linking to us. When this option is enabled, Geeklog will
498 try and create an excerpt by searching the backlink on the site that sent
499 the Pingback, extract a piece of the text near the link, and use that as
500 the excerpt for the Pingback.</td></tr>
502 <td valign="top"><a name="desc_pingback_self">pingback_self</a></td>
503 <td valign="top">0</td>
504 <td valign="top">Pingbacks are sent out automatically to <em>all</em> the
505 URLs linked from a story - which includes stories on your own site that
506 you may have linked in the article. This option lets you specify how these
507 "self pingbacks" are to be handled: 0 = skip them, i.e. don't send pingbacks
508 to stories on your own site; 1 = allow them, but obey the speed limit;
509 2 = allow them and ignore the speed limit.<br>
510 If your article contains more than one link to other stories on your site,
511 then option 1 is probably of limited use, as it would only pingback the
512 first linked story and run into the speed limit for the others.</td></tr>
514 <td valign="top"><a name="desc_ping_enabled">ping_enabled</a></td>
515 <td valign="top">true</td>
516 <td valign="top">Enable (true) or disable (true) the ability to ping weblog directory services like <a href="http://technorati.com/">Technorati</a>.</td></tr>
520 <h2><a name="theme">Theme</a></h2>
522 <h3><a name="theme_theme">Theme: Theme</a></h3>
524 <table border="1" width="100%">
525 <tr><th style="width:8%">Variable</th>
526 <th style="width:29%">Default Value</th>
527 <th style="width:63%">Description</th></tr>
529 <td valign="top"><a name="desc_theme">theme</a></td>
530 <td valign="top">professional</td>
531 <td valign="top">Default theme to use on the site</td></tr>
533 <td valign="top"><a name="desc_doctype">doctype</a></td>
534 <td valign="top">HTML 4.01 Strict</td>
536 href="http://en.wikipedia.org/wiki/Document_Type_Declaration">Document Type
537 Declaration</a> (aka DOCTYPE aka DTD) to use for all the themes on your
538 site, assuming they use the <tt>{doctype}</tt> variable instead of a
539 hard-coded DOCTYPE in their <tt>header.thtml</tt>.</td></tr>
541 <td valign="top"><a name="desc_menu_elements">menu_elements</a></td>
542 <td valign="top"><code>array('contribute', 'search', 'stats', 'directory',
543 'plugins')</code></td>
544 <td valign="top">Specifies which entries are displayed in the site's menu bar
545 (if your theme uses the <code>{menu_elements}</code> variable to display
546 the menu bar). Can be any combination of <tt>'home'</tt>,
547 <tt>'contribute'</tt>, <tt>'search'</tt>, <tt>'stats'</tt>,
548 <tt>'directory'</tt>, <tt>'prefs'</tt>, <tt>'plugins'</tt>, and
549 <tt>'custom'</tt> where <tt>'plugins'</tt> is the same as the
550 <code>{plg_menu_elements}</code> variable, i.e. a list of the menu entries
551 provided by plugins, and <tt>'custom'</tt> displays the entries returned by
552 a custom function <code>CUSTOM_menuEntries</code> (see
553 <tt>lib-custom.php</tt> for details).</td></tr>
555 <td valign="top"><a name="desc_path_themes">path_themes</a></td>
556 <td valign="top">/path/to/geeklog/public_html/layout/</td>
557 <td valign="top">Directory where all themes reside</td></tr>
560 <h3><a name="theme_advanced">Theme: Advanced Settings</a></h3>
562 <table border="1" width="100%">
563 <tr><th style="width:8%">Variable</th>
564 <th style="width:29%">Default Value</th>
565 <th style="width:63%">Description</th></tr>
567 <td valign="top"><a name="desc_show_right_blocks">show_right_blocks</a></td>
568 <td valign="top">false</td>
569 <td valign="top">If set to <tt>true</tt>, the right-side column of blocks
570 will be displayed on <em>all</em> pages (instead of only on the index
573 <td valign="top"><a name="desc_showfirstasfeatured">showfirstasfeatured</a></td>
574 <td valign="top">0</td>
575 <td valign="top">When set to 1, this will render the first story on <em>any</em> page
576 using the templates for a featured story, even if that story is not
577 featured. This will even be applied to the first story on page 2 of a
578 topic page, for example.</td></tr>
582 <h2><a name="blocks">Blocks</a></h2>
584 <h3><a name="blocks_admin">Blocks: Admin Block</a></h3>
586 <table border="1" width="100%">
587 <tr><th style="width:8%">Variable</th>
588 <th style="width:29%">Default Value</th>
589 <th style="width:63%">Description</th></tr>
591 <td valign="top"><a name="desc_sort_admin">sort_admin</a></td>
592 <td valign="top">false</td>
593 <td valign="top">If set to <tt>true</tt> will sort the entries in the Admin's
594 block and the icons on the Submissions page (<tt>moderation.php</tt>)
595 alphabetically.</td></tr>
597 <td valign="top"><a name="desc_link_documentation">link_documentation</a></td>
598 <td valign="top">1</td>
599 <td valign="top">Add a link to Geeklog's documentation to the Admin block.
600 Set this to 0 if you don't want that link to show up.</td></tr>
602 <td valign="top"><a name="desc_link_versionchecker">link_versionchecker</a></td>
603 <td valign="top">1</td>
604 <td valign="top">Add a link "GL Version Test" to the Admin block so that you
605 can easily check if your Geeklog version is up to date. Set this to 0 if
606 you don't want that link to show up.<br>
607 <strong>Note:</strong> The link is only displayed to members of the Root
608 group anyway.</td></tr>
611 <h3><a name="blocks_topics">Blocks: Topics Block</a></h3>
613 <table border="1" width="100%">
614 <tr><th style="width:8%">Variable</th>
615 <th style="width:29%">Default Value</th>
616 <th style="width:63%">Description</th></tr>
618 <td valign="top"><a name="desc_sortmethod">sortmethod</a></td>
619 <td valign="top">alpha</td>
620 <td valign="top">alpha = Sort topics in topic list alphabetically<br>
621 sortnum = Sort topics in topic list by the given sort number</td></tr>
623 <td valign="top"><a name="desc_showstorycount">showstorycount</a></td>
624 <td valign="top">1</td>
625 <td valign="top">Show the number of stories in a topic in the Sections block (0=no, 1=yes)</td></tr>
627 <td valign="top"><a name="desc_showsubmissioncount">showsubmissioncount</a></td>
628 <td valign="top">1</td>
629 <td valign="top">Show the number of story submissions for a topic in the Sections block (0=no, 1=yes)</td></tr>
631 <td valign="top"><a name="desc_hide_home_link">hide_home_link</a></td>
632 <td valign="top">0</td>
633 <td valign="top">Hide the "Home" link from the Sections block (0=no, 1=yes)</td></tr>
636 <h3><a name="blocks_who">Blocks: Who's Online Block</a></h3>
638 <table border="1" width="100%">
639 <tr><th style="width:8%">Variable</th>
640 <th style="width:29%">Default Value</th>
641 <th style="width:63%">Description</th></tr>
643 <td valign="top"><a name="desc_whosonline_threshold">whosonline_threshold</a></td>
644 <td valign="top">300</td>
645 <td valign="top">How long, in seconds, users can be idle before removing them from the whosonline block</td></tr>
647 <td valign="top"><a name="desc_whosonline_anonymous">whosonline_anonymous</a></td>
648 <td valign="top">0</td>
649 <td valign="top">If enabled (i.e. set to 1), anonymous users will only see the number of registered users currently online in the Who's Online block but not their names. Only logged-in users will see the names of other users that are currently online.</td></tr>
651 <td valign="top"><a name="desc_whosonline_photo">whosonline_photo</a></td>
652 <td valign="top">0</td>
653 <td valign="top">If enabled (i.e. set to 1), and a photo exists for the user, a thumbnail of that photo will be displayed. Else, a photo icon will be displayed.</td></tr>
656 <h3><a name="blocks_what">Blocks: What's New Block</a></h3>
658 <table border="1" width="100%">
659 <tr><th style="width:8%">Variable</th>
660 <th style="width:29%">Default Value</th>
661 <th style="width:63%">Description</th></tr>
663 <td valign="top"><a name="desc_newstoriesinterval">newstoriesinterval</a></td>
664 <td valign="top">86400</td>
665 <td valign="top">Stories are "new" if they are this many seconds old.</td></tr>
667 <td valign="top"><a name="desc_newcommentsinterval">newcommentsinterval</a></td>
668 <td valign="top">172800</td>
669 <td valign="top">Comments are "new" if they are this many seconds old.</td></tr>
671 <td valign="top"><a name="desc_newtrackbackinterval">newtrackbackinterval</a></td>
672 <td valign="top">172800</td>
673 <td valign="top">Trackback comments are "new" if they are this many seconds old.</td></tr>
675 <td valign="top"><a name="desc_hidenewstories">hidenewstories</a></td>
676 <td valign="top">0</td>
677 <td valign="top">Set to 1 to hide new stories from the What's New block.</td></tr>
679 <td valign="top"><a name="desc_hidenewcomments">hidenewcomments</a></td>
680 <td valign="top">0</td>
681 <td valign="top">Set to 1 to hide new comments from the What's New block.</td></tr>
683 <td valign="top"><a name="desc_hidenewtrackbacks">hidenewtrackbacks</a></td>
684 <td valign="top">0</td>
685 <td valign="top">Set to 1 to hide new trackback comments from the What's New block.</td></tr>
687 <td valign="top"><a name="desc_hidenewplugins">hidenewplugins</a></td>
688 <td valign="top">0</td>
689 <td valign="top">Set to 1 to hide new entries by plugins from the What's New
692 <td valign="top"><a name="desc_title_trim_length">title_trim_length</a></td>
693 <td valign="top">20</td>
694 <td valign="top">Max. length of the title of items listed in the What's New
699 <h2><a name="users">Users and Submissions</a></h2>
701 <h3><a name="users_users">Users and Submissions: Users</a></h3>
703 <table border="1" width="100%">
704 <tr><th style="width:8%">Variable</th>
705 <th style="width:29%">Default Value</th>
706 <th style="width:63%">Description</th></tr>
708 <td valign="top"><a name="desc_disable_new_user_registration">disable_new_user_registration</a></td>
709 <td valign="top">false</td>
710 <td valign="top">When set to <tt>true</tt> completely disables all options
711 to sign up as a new user.</td></tr>
713 <td valign="top"><a name="desc_allow_user_themes">allow_user_themes</a></td>
714 <td valign="top">Can be 1 or 0</td>
715 <td valign="top">If set to 1, users can set their own theme that the site uses</td></tr>
717 <td valign="top"><a name="desc_allow_user_language">allow_user_language</a></td>
718 <td valign="top">Can be 1 or 0</td>
719 <td valign="top">If set to 1, users can select the language for the site navigation</td></tr>
721 <td valign="top"><a name="desc_allow_user_photo">allow_user_photo</a></td>
722 <td valign="top">Can be 1 or 0</td>
723 <td valign="top">If set to 1, users can upload a photo to their profile</td></tr>
725 <td valign="top"><a name="desc_allow_username_change">allow_username_change</a></td>
726 <td valign="top">0</td>
727 <td valign="top">If set to 1, users will be allowed to change their username
728 (login name). Stories and comments posted under the old username will
729 automatically show the new username.</td></tr>
731 <td valign="top"><a name="desc_allow_account_delete">allow_account_delete</a></td>
732 <td valign="top">0</td>
733 <td valign="top">If set to 1, users will be allowed to delete their accounts. Stories and comments posted under that account will be kept and show up as being posted by "Anonymous".</td></tr>
735 <td valign="top"><a name="desc_hide_author_exclusion">hide_author_exclusion</a></td>
736 <td valign="top">Can be 1 or 0</td>
737 <td valign="top">If set to 1, the option to to exclude certain authors from being seen is hidden from the user's preferences.</td></tr>
739 <td valign="top"><a name="desc_show_fullname">show_fullname</a></td>
740 <td valign="top">0</td>
741 <td valign="top">Whether to display a user's full name (= 1) or only their
742 username (= 0). For users that haven't entered their full name, Geeklog
743 will always display the username.</td></tr>
745 <td valign="top"><a name="desc_show_servicename">show_servicename</a></td>
746 <td valign="top">true</td>
747 <td valign="top">If you allow users to log in with accounts on remote services
748 (like LDAP or LiveJournal), this option will at the service's name to
749 the username to avoid confusion with local users of the same name. Set to
750 <tt>false</tt> to disable.</td></tr>
752 <td valign="top"><a name="desc_custom_registration">custom_registration</a></td>
753 <td valign="top"><code>false</code></td>
754 <td valign="top">When set to <code>true</code>, Geeklog will let you use
755 your own signup form for new user registrations. Please see the file
756 <tt>lib-custom.php</tt> that ships with Geeklog for an example.</td></tr>
758 <td valign="top"><a name="desc_user_login_method_standard">standard</a></td>
759 <td valign="top"><code>true</code></td>
760 <td valign="top">Whether to allow normal logins into the site, i.e. with
761 a user account that only exists in your site's database.</td></tr>
763 <td valign="top"><a name="desc_user_login_method_openid">openid</a></td>
764 <td valign="top"><code>false</code></td>
765 <td valign="top">Whether to allow logins using <a href="http://openid.net/">OpenID</a>. This will display a special OpenID login below the normal login field.<br>
766 <strong>Note:</strong> Currently only OpenID 1.1 is supported.</td></tr>
768 <td valign="top"><a name="desc_user_login_method_3rdparty">3rdparty</a></td>
769 <td valign="top"><code>false</code></td>
770 <td valign="top">Allow (when set to <tt>true</tt>) users who already have
771 an account with some other service to log into your Geeklog site with the
772 login for that service. Currently supported: LDAP and LiveJournal.<br>
773 Please note that to enable login for a specific service, you need an
774 authorization class in <tt>system/classes/authentication</tt>. If you only
775 want to allow LDAP but not LiveJournal users (or vice versa), simply
776 remove the class file for the unwanted service(s).<br>
777 See <a href="http://www.geeklog.net/article.php/remote-authentication">Remote Authentication in Geeklog</a> for more information.</td></tr>
779 <td valign="top"><a name="desc_user_login_method_oauth">oauth</a></td>
780 <td valign="top"><code>false</code></td>
781 <td valign="top">Whether to allow logins using <a href="http://oauth.net/">OAuth</a>. This will display a special OAuth login below the normal login field.<br>
782 <strong>Note:</strong> Currently only OAuth 1.0 is support. Current login methods supported: Facebook, Twitter and LinkedIn.<br>Please note that to enable login for a
783 specific method, you need an authorization class in <tt>system/classes/oauth</tt>. If you only want to allow Facebook but not Twitter users (or vice versa), simply
784 remove the class file for the unwanted service(s). You must also update the class file(s) with the application key ($consumer_key) and application secret
785 ($consumer_secret) values. The PHP extenstion OpenSSL is required to be loaded.<br>
786 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
788 <td valign="top"><a name="desc_facebook_login">facebook_login</a></td>
789 <td valign="top"><code>false</code></td>
790 <td valign="top">Allow (when set to <tt>true</tt>) users who already have
791 an account with Facebook to log into Geeklog with said account using OAuth. You must set the Facebook application ID and secret.</td></tr>
793 <td valign="top"><a name="desc_facebook_consumer_key">facebook_consumer_key</a></td>
794 <td valign="top"><code>''</code></td>
795 <td valign="top">Required to use Facebook OAuth login method. Visit this <a href="http://developers.facebook.com/setup/">Facebook Developers page</a>
796 to create an Applicaiton to recieve your key and secret.<br>
797 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
799 <td valign="top"><a name="desc_facebook_consumer_secret">facebook_consumer_secret</a></td>
800 <td valign="top"><code>''</code></td>
801 <td valign="top">Required to use Facebook OAuth login method. Visit this <a href="http://developers.facebook.com/setup/">Facebook Developers page</a>
802 to create an Applicaiton to recieve your key and secret.<br>
803 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
805 <td valign="top"><a name="desc_linkedin_login">linkedin_login</a></td>
806 <td valign="top"><code>false</code></td>
807 <td valign="top">Allow (when set to <tt>true</tt>) users who already have
808 an account with LinkedIn to log into Geeklog with said account using OAuth. You must set the LinkedIn API and secret key.</td></tr>
810 <td valign="top"><a name="desc_linkedin_consumer_key">linkedin_consumer_key</a></td>
811 <td valign="top"><code>''</code></td>
812 <td valign="top">Required to use LinkedIn OAuth login method. Visit this <a href="https://www.linkedin.com/secure/developer">LinkedIn Developers page</a>
813 to create an Applicaiton to recieve your API and secret key.<br>
814 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
816 <td valign="top"><a name="desc_linkedin_consumer_secret">linkedin_consumer_secret</a></td>
817 <td valign="top"><code>''</code></td>
818 <td valign="top">Required to use LinkedIn OAuth login method. Visit this <a href="https://www.linkedin.com/secure/developer">LinkedIn Developers page</a>
819 to create an Applicaiton to recieve your API and secret key.<br>
820 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
822 <td valign="top"><a name="desc_twitter_login">twitter_login</a></td>
823 <td valign="top"><code>false</code></td>
824 <td valign="top">Allow (when set to <tt>true</tt>) users who already have
825 an account with Twitter to log into Geeklog with said account using OAuth. You must set the Twitter consumer key and secret.</td></tr>
827 <td valign="top"><a name="desc_twitter_consumer_key">twitter_consumer_key</a></td>
828 <td valign="top"><code>''</code></td>
829 <td valign="top">Required to use Twitter OAuth login method. Visit this <a href="https://twitter.com/apps">Twitter Application page</a>
830 to create an Applicaiton to recieve your consumer key and secret.<br>
831 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
833 <td valign="top"><a name="desc_twitter_consumer_secret">twitter_consumer_secret</a></td>
834 <td valign="top"><code>''</code></td>
835 <td valign="top">Required to use Twitter OAuth login method. Visit this <a href="https://twitter.com/apps">Twitter Application page</a>
836 to create an Applicaiton to recieve your consumer key and secret.<br>
837 See our <a href="http://wiki.geeklog.net/index.php/OAuth">Wiki OAuth page</a> for more information.</td></tr>
839 <td valign="top"><a name="desc_aftersave_user">aftersave_user</a></td>
840 <td valign="top"><code>'item'</code></td>
841 <td valign="top">Which page to go to after a user has been saved:
843 <li>'item': display the user's profile</li>
844 <li>'list': show admin's list of users (default)</li>
845 <li>'home': display the site's homepage</li>
846 <li>'admin': go to the "Admin Home" page, i.e. Command & Control</li>
850 <h3><a name="users_spamx">Users and Submissions: Spam-X</a></h3>
852 <table border="1" width="100%">
853 <tr><th style="width:8%">Variable</th>
854 <th style="width:29%">Default Value</th>
855 <th style="width:63%">Description</th></tr>
857 <td valign="top"><a name="desc_spamx">spamx</a></td>
858 <td valign="top">128</td>
859 <td valign="top">Tells Geeklog's <a href="spamx.html" rel="nofollow">Spam-X</a> plugin what to do when a spam post has been detected. The value is the sum
860 of all values that uniquely identify the Spam-X modules that should be
861 executed. E.g. the "delete" action module uses 128, the "email admin"
862 module uses 8, so if both modules should be executed, this option should
863 be set to 128 + 8 = 136.</td></tr>
866 <h3><a name="users_login">Users and Submissions: Login Settings</a></h3>
868 <table border="1" width="100%">
869 <tr><th style="width:8%">Variable</th>
870 <th style="width:29%">Default Value</th>
871 <th style="width:63%">Description</th></tr>
873 <td valign="top"><a name="desc_lastlogin">lastlogin</a></td>
874 <td valign="top"><code>true</code></td>
875 <td valign="top">Whether to keep track of when a user last logged in
876 (<code>= true</code>) or not (<code>= false</code>).</td></tr>
877 <tr><td valign="top"><a name="desc_loginrequired">loginrequired</a></td>
878 <td valign="top">0</td>
879 <td valign="top">Login is required to access <em>any</em> part of the site. When
880 set to 1, this overrides the following settings. When you only want to
881 block access to certain parts of the site, set this to 0 and select
882 from the following settings.</td></tr>
883 <tr><td valign="top"><a name="desc_submitloginrequired">submitloginrequired</a></td>
884 <td valign="top">0</td>
885 <td valign="top">When set to 1, only registered users can submit stories
886 and items handled by plugins, e.g. links and events</td></tr>
887 <tr><td valign="top"><a name="desc_commentsloginrequired">commentsloginrequired</a></td>
888 <td valign="top">0</td>
889 <td valign="top">When set to 1, only registered users can submit comments</td></tr>
890 <tr><td valign="top"><a name="desc_statsloginrequired">statsloginrequired</a></td>
891 <td valign="top">0</td>
892 <td valign="top">When set to 1, only registered users can access the site stats</td></tr>
893 <tr><td valign="top"><a name="desc_searchloginrequired">searchloginrequired</a></td>
894 <td valign="top">0</td>
895 <td valign="top">When set to 1, only registered users can use the advanced search. When
896 set to 2, the simple search is blocked for anonymous users, too.</td></tr>
897 <tr><td valign="top"><a name="desc_profileloginrequired">profileloginrequired</a></td>
898 <td valign="top">0</td>
899 <td valign="top">When set to 1, only registered users can view another user's profile</td></tr>
900 <tr><td valign="top"><a name="desc_emailuserloginrequired">emailuserloginrequired</a></td>
901 <td valign="top">0</td>
902 <td valign="top">When set to 1, only registered users can use the email submission
903 form to send an email to another user</td></tr>
904 <tr><td valign="top"><a name="desc_emailstoryloginrequired">emailstoryloginrequired</a></td>
905 <td valign="top">0</td>
906 <td valign="top">When set to 1, only registered users can email stories</td></tr>
907 <tr><td valign="top"><a name="desc_directoryloginrequired">directoryloginrequired</a></td>
908 <td valign="top">0</td>
909 <td valign="top">When set to 1, only registered users can access the list of past articles</td></tr>
911 <td valign="top"><a name="desc_passwordspeedlimit">passwordspeedlimit</a></td>
912 <td valign="top">300</td>
913 <td valign="top">Minimum delay between two requests for a new password, in seconds.</td></tr>
915 <td valign="top"><a name="desc_login_attempts">login_attempts</a></td>
916 <td valign="top">3</td>
917 <td valign="top">Max. number of login attempts before the speedlimit (see
918 below) kicks in and further logins are blocked for the given amount of
921 <td valign="top"><a name="desc_login_speedlimit">login_speedlimit</a></td>
922 <td valign="top">300</td>
923 <td valign="top">How many seconds have to pass before another login attempt
924 can be made after <code>$_CONF['login_attempts']</code> (see above) login
925 attempts have failed.</td></tr>
928 <h3><a name="users_usersub">Users and Submissions: User Submission</a></h3>
930 <table border="1" width="100%">
931 <tr><th style="width:8%">Variable</th>
932 <th style="width:29%">Default Value</th>
933 <th style="width:63%">Description</th></tr>
935 <td valign="top"><a name="desc_usersubmission">usersubmission</a></td>
936 <td valign="top">0</td>
937 <td valign="top">Enable (1) or disable (0) the user submission queue (i.e.
938 new users must be approved before they receive their password)</td></tr>
940 <td valign="top"><a name="desc_allow_domains">allow_domains</a></td>
941 <td valign="top">''</td>
942 <td valign="top">When the user submission queue is enabled this can contain a
943 comma-separated list of domain names from which user submissions will not
944 be queued (but approved automatically). Regular expressions are also allowed
945 and interpreted.<br><strong>Example:</strong>
946 <tt>'mycompany.com,myothercompany.com'</tt></td></tr>
948 <td valign="top"><a name="desc_disallow_domains">disallow_domains</a></td>
949 <td valign="top">''</td>
950 <td valign="top">This is the opposite of <code>$_CONF['allow_domains']</code>
951 (see above): A list of domain names that are <em>not</em> allowed in email
952 addresses of new users. Note that this list is <em>always</em> used, even
953 when the user submission queue has been switched off. Again, regular
954 expression can be used.<br><strong>Example</strong> disallow email addresses
955 with a certain domain name and from any ".edu" domain:
956 <tt>'somebaddomain.com,\.edu$'</tt></td></tr>
959 <h3><a name="users_submission">Users and Submissions: Submission Settings</a></h3>
961 <table border="1" width="100%">
962 <tr><th style="width:8%">Variable</th>
963 <th style="width:29%">Default Value</th>
964 <th style="width:63%">Description</th></tr>
966 <td valign="top"><a name="desc_storysubmission">storysubmission</a></td>
967 <td valign="top">1</td>
968 <td valign="top">Enable (1) or disable (0) the story submission queue</td></tr>
970 <td valign="top"><a name="desc_listdraftstories">listdraftstories</a></td>
971 <td valign="top">0</td>
972 <td valign="top">When set to 1, this will display an additional block on the
973 submissions page (<tt>moderation.php</tt>) that lists all the stories that
974 have the 'draft' flag set.</td></tr>
976 <td valign="top"><a name="desc_postmode">postmode</a></td>
977 <td valign="top">plaintext</td>
978 <td valign="top">Sets the default submission mode to 'html' or 'plaintext'</td></tr>
980 <td valign="top"><a name="desc_speedlimit">speedlimit</a></td>
981 <td valign="top">45</td>
982 <td valign="top">Minimum delay between submissions in seconds. This helps prevent Denial of Service (DOS) attacks</td></tr>
984 <td valign="top"><a name="desc_skip_preview">skip_preview</a></td>
985 <td valign="top">0</td>
986 <td valign="top">If 1, allows submission of stories and comments without previewing (i.e. the submission form will always have a Preview <em>and</em> a Submit button).</td></tr>
988 <td valign="top"><a name="desc_advanced_editor">advanced_editor</a></td>
989 <td valign="top">false</td>
990 <td valign="top">Enable (if set to <code>true</code>) a WYSIWYG editor for
991 story and comment submissions and static pages. Geeklog ships with <a
992 href="http://www.fckeditor.net/">FCKeditor</a>.</td></tr>
994 <td valign="top"><a name="desc_wikitext_editor">wikitext_editor</a></td>
995 <td valign="top">false</td>
996 <td valign="top">Allow using <a href="http://pear.reversefold.com/dokuwiki/text_wiki:samplepage">wiki syntax</a> in stories. This adds a third option,
997 "Wiki-style format", to the Post Mode dropdown in the story editor
998 (implemented using the <a href="http://pear.php.net/package/Text_Wiki">PEAR::Text_Wiki</a> package).</td></tr>
1001 <h3><a name="users_comments">Users and Submissions: Comments</a></h3>
1003 <table border="1" width="100%">
1004 <tr><th style="width:8%">Variable</th>
1005 <th style="width:29%">Default Value</th>
1006 <th style="width:63%">Description</th></tr>
1008 <td valign="top"><a name="desc_commentspeedlimit">commentspeedlimit</a></td>
1009 <td valign="top">45</td>
1010 <td valign="top">Number of seconds between posting a comment for the user</td></tr>
1012 <td valign="top"><a name="desc_comment_limit">comment_limit</a></td>
1013 <td valign="top">100</td>
1014 <td valign="top">Most number of comments to show at any one time</td></tr>
1016 <td valign="top"><a name="desc_comment_mode">comment_mode</a></td>
1017 <td valign="top">nested</td>
1018 <td valign="top">How to display comments (threaded, nested, flat or nocomments)</td></tr>
1020 <td valign="top"><a name="desc_comment_code">comment_code</a></td>
1021 <td valign="top">0</td>
1022 <td valign="top">Default value for new stories: Comments enabled (0) or disabled (-1)</td></tr>
1024 <td valign="top"><a name="desc_comment_edit">comment_edit</a></td>
1025 <td valign="top">0</td>
1026 <td valign="top">Whether to allow users and admins (i.e. those with
1027 comment.edit permission) to edit comments.</td></tr>
1029 <td valign="top"><a name="desc_commentsubmission">commentsubmission</a></td>
1030 <td valign="top">0</td>
1031 <td valign="top">Enable (1) or disable (0) comment submission queue.</td></tr>
1033 <td valign="top"><a name="desc_comment_edittime">comment_edittime</a></td>
1034 <td valign="top">1800</td>
1035 <td valign="top">How long (in seconds) a comment is editable for the user who
1036 submitted it. Requires that comments are editable (see <a href="#desc_comment_edit">above</a>). Anonymous users (those that did not register an account) can
1037 never edit their comments while admins can always edit comments.</td></tr>
1039 <td valign="top"><a name="desc_article_comment_close_enabled">article_comment_close_enabled</a></td>
1040 <td valign="top">0</td>
1041 <td valign="top">Whether or not stories should be closed for comments after
1042 a certain amount of days (see next option). This is only the default
1043 setting for new stories and can be changed separately for each
1046 <td valign="top"><a name="desc_article_comment_close_days">article_comment_close_days</a></td>
1047 <td valign="top">30</td>
1048 <td valign="top">Number of days after which a story is to be automatically
1049 closed for comments, i.e. no new comments can be posted after that many
1051 Note that this is only the default value to which the "Disable Comments"
1052 option is set when creating a new story. It will not take effect unless it
1053 has also been enabled for the story.</td></tr>
1055 <td valign="top"><a name="desc_comment_close_rec_stories">comment_close_rec_stories</a></td>
1056 <td valign="top">0</td>
1057 <td valign="top">Number of most recent stories for which comment posting is
1058 allowed. Posting a new story will automatically close comments for the
1059 oldest of these stories. Set to 0 to disable this option.</td></tr>
1061 <td valign="top"><a name="desc_allow_reply_notifications">allow_reply_notifications</a></td>
1062 <td valign="top">0</td>
1063 <td valign="top">Allow (1) or disallow (0) subscribing to comment
1064 notifications. Registered users can get an email notifying them of direct
1065 replies to comments they left.</td></tr>
1069 <h2><a name="images">Images</a></h2>
1071 <h3><a name="images_imagelib">Images: Image Library</a></h3>
1073 <table border="1" width="100%">
1074 <tr><th style="width:8%">Variable</th>
1075 <th style="width:29%">Default Value</th>
1076 <th style="width:63%">Description</th></tr>
1078 <td valign="top"><a name="desc_image_lib">image_lib</a></td>
1079 <td valign="top">None</td>
1080 <td valign="top">Set this to either 'imagemagick', 'netpbm', or 'gdlib' if
1081 images should be resized during upload. Leave as 'None' if you don't want
1082 images to be resized or if you don't have those packages available.</td></tr>
1084 <td valign="top"><a name="desc_path_to_mogrify">path_to_mogrify</a></td>
1085 <td valign="top"><i>(disabled)</i></td>
1086 <td valign="top">If you chose 'imagemagick' for
1087 <code>$_CONF['image_lib']</code> above, then this should hold the
1088 <strong>complete path</strong> to the mogrify executable (from the
1089 <a href="http://www.imagemagick.org/">ImageMagick</a> package), e.g.
1090 '<tt>/usr/bin/mogrify</tt>' (ImageMagick 5.4.9 or newer recommended).</td></tr>
1092 <td valign="top"><a name="desc_path_to_netpbm">path_to_netpbm</a></td>
1093 <td valign="top"><i>(disabled)</i></td>
1094 <td valign="top">If you chose 'netpbm' for <code>$_CONF['image_lib']</code>
1095 above, then this should hold the complete path to the <em>directory</em>
1096 where the binaries from the Netpbm package are kept, e.g.
1097 <code>'/usr/bin/netpbm/'</code>. Note that the path must end in a slash.<br>
1098 Precompiled binaries for various platforms can be downloaded from the <a
1099 href="http://netpbm.sourceforge.net/">Netpbm homepage</a>.</td></tr>
1102 <h3><a name="images_upload">Images: Upload</a></h3>
1104 <table border="1" width="100%">
1105 <tr><th style="width:8%">Variable</th>
1106 <th style="width:29%">Default Value</th>
1107 <th style="width:63%">Description</th></tr>
1109 <td valign="top"><a name="desc_keep_unscaled_image">keep_unscaled_image</a></td>
1110 <td valign="top">0</td>
1111 <td valign="top">Set this to 1 if you want Geeklog to keep the original, unscaled images after upload. The smaller image will then be used as a thumbnail and will link to the original image. Note that this may use a lot of disk space (depending on the size of your images).</td></tr>
1113 <td valign="top"><a name="desc_allow_user_scaling">allow_user_scaling</a></td>
1114 <td valign="top">1</td>
1115 <td valign="top">When unscaled images are kept (see above), this option lets
1116 the user chose between using the scaled or unscaled image in the story, i.e.
1117 enables the <code>[unscaled<i>X</i>]</code> image tag (in addition to the
1118 <code>[image<i>X</i>]</code> tag).</td></tr>
1120 <td valign="top"><a name="desc_jpeg_quality">jpeg_quality</a></td>
1121 <td valign="top"><i>(disabled)</i></td>
1122 <td valign="top">Control the image quality when resizing JPEGs. All the image
1123 libraries supported by Geeklog are based on the IJG JPEG library which uses
1124 an arbitrary range of 0-100 to specify the "quality" (note that this is
1125 <em>not</em> a percent value). The default, when not set, is 75 which
1126 provides good quality in most cases. In some cases, higher values may
1127 provide better results.<br>
1128 Rules of thumb: Values above 90 usually don't improve the image quality any
1129 more but only produce larger files. Values below 50 will result in poor
1130 image quality. Values of 25 and below will produce distorted
1133 <td valign="top"><a name="desc_debug_image_upload">debug_image_upload</a></td>
1134 <td valign="top"><code>false</code></td>
1135 <td valign="top">When set to <code>true</code>, this option enables debugging
1136 output to be written into Geeklog's <tt>error.log</tt> file during the
1137 upload of an image. This is useful to track down problems with the image
1138 upload and resizing.</td></tr>
1141 <h3><a name="images_articles">Images: Images in Articles</a></h3>
1143 <table border="1" width="100%">
1144 <tr><th style="width:8%">Variable</th>
1145 <th style="width:29%">Default Value</th>
1146 <th style="width:63%">Description</th></tr>
1148 <td valign="top"><a name="desc_max_image_width">max_image_width</a></td>
1149 <td valign="top">160</td>
1150 <td valign="top">Max. width of an image in pixels. If it exceeds this, it is
1151 either rejected or resized (depending on the setting of
1152 <code>$_CONF['image_lib']</code> above).</td></tr>
1154 <td valign="top"><a name="desc_max_image_height">max_image_height</a></td>
1155 <td valign="top">120</td>
1156 <td valign="top">Max. height of an image in pixels. If it exceeds this, it is
1157 either rejected or resized (depending on the setting of
1158 <code>$_CONF['image_lib']</code> above).</td></tr>
1160 <td valign="top"><a name="desc_max_image_size">max_image_size</a></td>
1161 <td valign="top">1048576 <i>(equals 1 MB)</i></td>
1162 <td valign="top">Max. size of an image in bytes. If it exceeds this, it is
1163 is rejected (even if you're using a graphics package to resize images).</td></tr>
1166 <h3><a name="images_topic">Images: Topic Icons</a></h3>
1168 <table border="1" width="100%">
1169 <tr><th style="width:8%">Variable</th>
1170 <th style="width:29%">Default Value</th>
1171 <th style="width:63%">Description</th></tr>
1173 <td valign="top"><a name="desc_max_topicicon_width">max_topicicon_width</a></td>
1174 <td valign="top">48</td>
1175 <td valign="top">Max. width of a topic icon in pixels. If it exceeds this,
1176 it is either rejected or resized (depending on the setting of
1177 <code>$_CONF['image_lib']</code> above).</td></tr>
1179 <td valign="top"><a name="desc_max_topicicon_height">max_topicicon_height</a></td>
1180 <td valign="top">48</td>
1181 <td valign="top">Max. height of a topic icon in pixels. If it exceeds this,
1182 it is either rejected or resized (depending on the setting of
1183 <code>$_CONF['image_lib']</code> above).</td></tr>
1185 <td valign="top"><a name="desc_max_topicicon_size">max_topicicon_size</a></td>
1186 <td valign="top">65536 <i>(equals 64 KB)</i></td>
1187 <td valign="top">Max. size of a topic icon in bytes. If it exceeds this, it
1188 is rejected (even if you're using a graphics package to resize images).</td>
1191 <h3><a name="images_photos">Images: Photos</a></h3>
1193 <table border="1" width="100%">
1194 <tr><th style="width:8%">Variable</th>
1195 <th style="width:29%">Default Value</th>
1196 <th style="width:63%">Description</th></tr>
1198 <td valign="top"><a name="desc_max_photo_width">max_photo_width</a></td>
1199 <td valign="top">128</td>
1200 <td valign="top">Max. width of a user photo in pixels. If it exceeds this, it
1201 is either rejected or resized (depending on the setting of
1202 <code>$_CONF['image_lib']</code> above).</tr>
1204 <td valign="top"><a name="desc_max_photo_height">max_photo_height</a></td>
1205 <td valign="top">128</td>
1206 <td valign="top">Max. height of a user photo in pixels. If it exceeds this,
1207 it is either rejected or resized (depending on the setting of
1208 <code>$_CONF['image_lib']</code> above).</td></tr>
1210 <td valign="top"><a name="desc_max_photo_size">max_photo_size</a></td>
1211 <td valign="top">65536 <i>(equals 64 KB)</i></td>
1212 <td valign="top">Max. size of a user photo in bytes. If it exceeds this, it
1213 is rejected (even if you're using a graphics package to resize images).</td></tr>
1215 <td valign="top"><a name="desc_force_photo_width">force_photo_width</a></td>
1216 <td valign="top"><i>(disabled)</i></td>
1217 <td valign="top">This option, when enabled, will only apply when
1218 <em>displaying</em> a user photo. The <code><img></code> tag for the
1219 user photo will be emitted with a max. width, as specified by this option.
1220 This means that the actual photo can still be larger, but will only be
1221 displayed smaller. This is useful for cases where you don't want oddly
1222 shaped user photos to break your page's layout (e.g. in a forum).</td></tr>
1224 <td valign="top"><a name="desc_default_photo">default_photo</a></td>
1225 <td valign="top"><i>(disabled)</i></td>
1226 <td valign="top">When enabled, this option should point to an image (full URL
1227 required!) that should be displayed for users without a user photo. When
1228 this option is not set and a user does not have a user photo (or an <a
1229 href="#images_gravatar">avatar</a>) then Geeklog will simply not display
1233 <h3><a name="images_gravatar">Images: Gravatar</a></h3>
1235 <table border="1" width="100%">
1236 <tr><th style="width:8%">Variable</th>
1237 <th style="width:29%">Default Value</th>
1238 <th style="width:63%">Description</th></tr>
1240 <td valign="top"><a name="desc_use_gravatar">use_gravatar</a></td>
1241 <td valign="top">false</td>
1242 <td valign="top">If enabled (set to <tt>true</tt>), a user's avatar image will
1243 be requested from <a href="http://gravatar.com/">gravatar.com</a> if the
1244 user didn't upload a user photo (i.e. an uploaded photo always takes
1246 Please note that this option may slow down your site on pages that display
1247 a lot of userphotos for different users (e.g. forum threads).</td></tr>
1249 <td valign="top"><a name="desc_gravatar_rating">gravatar_rating</a></td>
1250 <td valign="top"><i>(disabled)</i></td>
1251 <td valign="top">Avatars submitted to gravatar.com are rated with the rating
1252 system used for movies (in the U.S.), i.e. the letters G, PG, R, or X. This
1253 option will let you chose the <em>maximum</em> allowed rating for an avatar.
1254 For example, a max. rating of R will make sure that no X-rated avatars will
1255 be displayed on your site (only G, PG, and R).</td></tr>
1259 <h2><a name="languages">Languages and Locale</a></h2>
1261 <h3><a name="languages_language">Languages and Locale: Language</a></h3>
1263 <table border="1" width="100%">
1264 <tr><th style="width:8%">Variable</th>
1265 <th style="width:29%">Default Value</th>
1266 <th style="width:63%">Description</th></tr>
1268 <td valign="top"><a name="desc_language">language</a></td>
1269 <td valign="top">english</td>
1270 <td valign="top">Name of your language file. Additional language files may be
1271 available for download at <a href="http://www.geeklog.net/">http://www.geeklog.net</a>.
1272 If you translate a language file, please send it to us. Also see <a
1273 href="#Localization">Localization</a> below.</td></tr>
1275 <td valign="top"><a name="desc_language_files">language_files</a></td>
1276 <td valign="top"><i>(disabled)</i></td>
1277 <td valign="top">For multi-lingual setups only: A list mapping language
1278 shortcuts ('en', 'de', etc.) to the Geeklog language files to use.</td></tr>
1280 <td valign="top"><a name="desc_languages">languages</a></td>
1281 <td valign="top"><i>(disabled)</i></td>
1282 <td valign="top">For multi-lingual setups only: A list mapping language
1283 shortcuts ('en', 'de', etc.) to the language's native name ("English",
1284 "Deutsch", etc.).</td></tr>
1287 <p>Also see <a href="http://wiki.geeklog.net/wiki/index.php/Multi-Language_Support">Multi-Language Support</a> in the Geeklog Wiki.</p>
1289 <h3><a name="languages_locale">Languages and Locale: Locale</a></h3>
1291 <table border="1" width="100%">
1292 <tr><th style="width:8%">Variable</th>
1293 <th style="width:29%">Default Value</th>
1294 <th style="width:63%">Description</th></tr>
1296 <td valign="top"><a name="desc_locale">locale</a></td>
1297 <td valign="top">en_GB</td>
1298 <td valign="top"><a href="http://en.wikipedia.org/wiki/Locale">Locale</a> for
1299 the system. This defines both the language and the country that PHP
1300 will use when deciding how to display localized information such as
1301 dates (e.g. for the names of months).</td></tr>
1303 <td valign="top"><a name="desc_date">date</a></td>
1304 <td valign="top">%A, %B %d %Y @ %I:%M %p %Z</td>
1305 <td valign="top">Date format used for most of the site, including story displays. See <a
1306 href="#date_formats">date formats</a> below.</td></tr>
1308 <td valign="top"><a name="desc_daytime">daytime</a></td>
1309 <td valign="top">%m/%d %I:%M%p</td>
1310 <td valign="top">Date format used when a shorter date is needed. See <a
1311 href="#date_formats">date formats</a> below.</td></tr>
1313 <td valign="top"><a name="desc_shortdate">shortdate</a></td>
1314 <td valign="top">%x</td>
1315 <td valign="top">Date format this is the shortest date. See <a href="#date_formats">date
1316 formats</a> below.</td></tr>
1318 <td valign="top"><a name="desc_dateonly">dateonly</a></td>
1319 <td valign="top">%d-%b</td>
1320 <td valign="top">Short date format (day and month only), to be used e.g. in the
1321 Upcoming Events and Older Stories blocks. See <a href="#date_formats">date
1322 formats</a> below.</td></tr>
1324 <td valign="top"><a name="desc_timeonly">timeonly</a></td>
1325 <td valign="top">%I:%M %p %Z</td>
1326 <td valign="top">Format string for the time only, to be used e.g. on the Event Details
1327 page. See <a href="#date_formats">date formats</a> below.</td></tr>
1329 <td valign="top"><a name="desc_week_start">week_start</a></td>
1330 <td valign="top">Sun</td>
1331 <td valign="top">First day of the week in the calendar. Can be either <tt>'Sun'</tt> (Sunday) or <tt>'Mon'</tt> (Monday).</td></tr>
1333 <td valign="top"><a name="desc_hour_mode">hour_mode</a></td>
1334 <td valign="top">12</td>
1335 <td valign="top">Which format to use when submitting or editing an object
1336 with a time setting (e.g. the publish time of a story). Can be 12 (for the
1337 12 hour am/pm format) or 24 (for the 24 hour format).</td></tr>
1339 <td valign="top"><a name="desc_thousand_separator">thousand_separator</a></td>
1340 <td valign="top"><code>,</code></td>
1341 <td valign="top">Character to use between every group of thousands.</td></tr>
1343 <td valign="top"><a name="desc_decimal_separator">decimal_separator</a></td>
1344 <td valign="top"><code>.</code></td>
1345 <td valign="top">Character to use before decimals.</td></tr>
1347 <td valign="top"><a name="desc_decimal_count">decimal_count</a></td>
1348 <td valign="top">2</td>
1349 <td valign="top">How many decimal places to display.</td></tr>
1351 <td valign="top"><a name="desc_timezone">timezone</a></td>
1352 <td valign="top"><i>(disabled)</i></td>
1353 <td valign="top">If your server is located in a different timezone, use this
1354 option to set your local (i.e. your own) timezone, so that the time and
1355 date on the site match your own.<br>
1356 This option is known as the "<a href="http://www.geeklog.net/forum/viewtopic.php?showtopic=21232">timezone hack</a>" and may not work on some
1361 <h2><a name="misc">Miscellaneous</a></h2>
1363 <h3><a name="misc_cookies">Miscellaneous: Cookies</a></h3>
1365 <p>These variables define the names of all of Geeklog's cookies. They can easily be changed in case there's a name collision with the cookies used by some other software package that you may use on your site.</p>
1367 <table border="1" width="100%">
1368 <tr><th style="width:8%">Variable</th>
1369 <th style="width:29%">Default Value</th>
1370 <th style="width:63%">Description</th></tr>
1372 <td valign="top"><a name="desc_cookie_session">cookie_session</a></td>
1373 <td valign="top">gl_session</td>
1374 <td valign="top">Name of the cookie that stores the session ID.</td></tr>
1376 <td valign="top"><a name="desc_cookie_name">cookie_name</a></td>
1377 <td valign="top">geeklog</td>
1378 <td valign="top">Name of the permanent cookie.</td></tr>
1380 <td valign="top"><a name="desc_cookie_password">cookie_password</a></td>
1381 <td valign="top">password</td>
1382 <td valign="top">Name of the password cookie.</td></tr>
1384 <td valign="top"><a name="desc_cookie_theme">cookie_theme</a></td>
1385 <td valign="top">theme</td>
1386 <td valign="top">Name of the theme cookie.</td></tr>
1388 <td valign="top"><a name="desc_cookie_language">cookie_language</a></td>
1389 <td valign="top">language</td>
1390 <td valign="top">Name of the language cookie.</td></tr>
1392 <td valign="top"><a name="desc_cookie_tzid">cookie_tzid</a></td>
1393 <td valign="top">timezone</td>
1394 <td valign="top">Name of the timezone cookie.</td></tr>
1396 <td valign="top"><a name="desc_cookie_anon_name">cookie_anon_name</a></td>
1397 <td valign="top">anon_name</td>
1398 <td valign="top">Name of the cookie to store the username of anonymous
1401 <td valign="top"><a name="desc_cookie_ip">cookie_ip</a></td>
1402 <td valign="top">0</td>
1403 <td valign="top">Session ID to contain IP address of user as well as random number. This is more secure but will more than likely require dialed up users to login each and every time. (0=no, 1=yes)</td></tr>
1405 <td valign="top"><a name="desc_default_perm_cookie_timeout">default_perm_cookie_timeout</a></td>
1406 <td valign="top">28800</td>
1407 <td valign="top">Permanent cookie timeout in seconds (28800 = 8 hours).</td></tr>
1409 <td valign="top"><a name="desc_session_cookie_timeout">session_cookie_timeout</a></td>
1410 <td valign="top">7200</td>
1411 <td valign="top">Session cookie timeout in seconds (7200 = 2 hours).</td></tr>
1413 <td valign="top"><a name="desc_cookie_path">cookie_path</a></td>
1414 <td valign="top">/</td>
1415 <td valign="top">Cookie path (see the <a href="http://www.php.net/manual/en/function.setcookie.php">PHP manual</a> for details).</td></tr>
1417 <td valign="top"><a name="desc_cookiedomain">cookiedomain</a></td>
1418 <td valign="top"><i>(empty)</i></td>
1419 <td valign="top">The domain that the cookie is available. Geeklog will attempt to guess the correct value for this setting (based on the 'site_url' variable). See the <a href="http://www.php.net/manual/en/function.setcookie.php">PHP manual</a> for details.</td></tr>
1421 <td valign="top"><a name="desc_cookiesecure">cookiesecure</a></td>
1422 <td valign="top">0</td>
1423 <td valign="top">Only set to 1 if your site uses HTTPS (see the <a href="http://www.php.net/manual/en/function.setcookie.php">PHP manual</a> for details).</td></tr>
1426 <h3><a name="misc_misc">Miscellaneous: Miscellaneous</a></h3>
1428 <table border="1" width="100%">
1429 <tr><th style="width:8%">Variable</th>
1430 <th style="width:29%">Default Value</th>
1431 <th style="width:63%">Description</th></tr>
1433 <td valign="top"><a name="desc_notification">notification</a></td>
1434 <td valign="top">array()</td>
1435 <td valign="top">Send an email notification to <tt>$_CONF['site_email']</tt>
1436 when a new story, comment, trackback or pingback has been submitted
1437 or a new user has registered with the site. The <tt>array()</tt> can hold
1438 any combination of the strings <tt>'story'</tt>, <tt>'comment'</tt>,
1439 <tt>'trackback'</tt>, <tt>'pingback'</tt>, and <tt>'user'</tt> (separated
1440 by commas), depending on which notification(s) you want.<br>
1441 <strong>Example:</strong> <code>array('story','user');</code> would
1442 send notifications when a new story has been submitted or a new user has
1443 registered. No notifications would be sent, for example, for new
1446 <td valign="top"><a name="desc_cron_schedule_interval">cron_schedule_interval</a></td>
1447 <td valign="top">0</td>
1448 <td valign="top">Geeklog can emulate a <a href="http://en.wikipedia.org/wiki/Cronjob">cronjob</a>, i.e. trigger a certain action at a given time. The code
1449 to be executed can be provided by a plugin or through the
1450 <code>CUSTOM_runScheduledTask</code> function in your
1451 <tt>lib-custom.php</tt>. The value given is in seconds and specifies the
1452 interval in which the code should be executed (e.g. 86400 for daily
1454 Please note that to trigger this action, you will need to have someone
1455 visit your site at around the specified time. On a site with few visitors,
1456 the code may only be executed with considerable delay.<br>
1457 Set to 0 to disable.</td></tr>
1459 <td valign="top"><a name="desc_disable_autolinks">disable_autolinks</a></td>
1460 <td valign="top">0</td>
1461 <td valign="top">If set to 1, disables the <a
1462 href="http://www.geeklog.net/article.php/autolinks">autotags</a>. I.e. the
1463 special tags in square brackets (e.g. [story:]) will not be interpreted
1466 <td valign="top"><a name="desc_clickable_links">clickable_links</a></td>
1467 <td valign="top">true</td>
1468 <td valign="top">Whether or not URLs in plain-text posting should
1469 automatically be turned into clickable links.</td></tr>
1471 <td valign="top"><a name="desc_linktext_maxlen">linktext_maxlen</a></td>
1472 <td valign="top">50</td>
1473 <td valign="top">Maximum text length of clickable URLs. If 0 then there is no maximum length.</td></tr>
1475 <td valign="top"><a name="desc_compressed_output">disable_compressed_output</a></td>
1476 <td valign="top">false</td>
1477 <td valign="top">If enabled and supported by both the browser and the
1478 webserver, HTML output will be compressed before sending it to the browser.
1479 This will typically result in much smaller amounts of data to be sent
1480 (usually between 20% and 25%, compared to the uncompressed output). It may,
1481 however, result in slightly more load on the webserver.<br>
1482 For now, this feature should be considered <strong>experimental</strong> and
1483 hasn't been implemented for all HTML output yet.</td></tr>
1485 <td valign="top"><a name="desc_frame_options">frame_options</a></td>
1486 <td valign="top">DENY</td>
1487 <td valign="top">Protection against <a
1488 href="http://en.wikipedia.org/wiki/Clickjacking">Clickjacking</a>: This
1489 option indicates that the site's content should not be displayed in a frame.
1490 This only works, however, when the visitor's browser respects the
1491 <tt>X-FRAME-OPTIONS</tt> HTTP header. Options are to disallow all framing
1492 (Strict), only allow framing from within the same site (Same Origin), or to
1493 allow all framing (disabled). We strongly suggest <em>not</em> to disable
1494 this option.</td></tr>
1497 <h3><a name="misc_debug">Miscellaneous: Debug</a></h3>
1499 <table border="1" width="100%">
1500 <tr><th style="width:8%">Variable</th>
1501 <th style="width:29%">Default Value</th>
1502 <th style="width:63%">Description</th></tr>
1504 <td valign="top"><a name="desc_rootdebug">rootdebug</a></td>
1505 <td valign="top"><code>false</code></td>
1506 <td valign="top">When a PHP error occurs, Geeklog's error handler will only
1507 display the actual error message to members of the Root group (to prevent
1508 leakage of possibly sensitive information). When set to <code>true</code>,
1509 this information will be displayed to <em>all</em> users. <strong>Use only
1510 for debugging purposes!</strong><br>
1511 Tip: If an error prevents you from logging into your site to enable that
1512 option, you can also <a href="#desc_rootdebug_siteconfig">enable it in your
1513 <tt>siteconfig.php</tt></a> file.</td></tr>
1516 <h3><a name="misc_digest">Miscellaneous: Daily Digest</a></h3>
1518 <table border="1" width="100%">
1519 <tr><th style="width:8%">Variable</th>
1520 <th style="width:29%">Default Value</th>
1521 <th style="width:63%">Description</th></tr>
1523 <td valign="top"><a name="desc_emailstories">emailstories</a></td>
1524 <td valign="top">0</td>
1525 <td valign="top">Let users get stories e-mailed to them (0=no, 1=yes), aka Daily Digest.
1526 Please note that this requires cron and the use of PHP as a shell script.</td></tr>
1528 <td valign="top"><a name="desc_emailstorieslength">emailstorieslength</a></td>
1529 <td valign="top">1</td>
1530 <td valign="top">When emailstories (above) is enabled, send only the title and the
1531 link to the new stories (0), or send the entire introtext (1) or send
1532 the first <i>n</i> characters from the introtext (where <i>n</i> = any other number)</td></tr>
1534 <td valign="top"><a name="desc_emailstoriesperdefault">emailstoriesperdefault</a></td>
1535 <td valign="top">0</td>
1536 <td valign="top">When set to 1, new users will be subscribed to the daily digest
1537 automatically when they register with the site.</td></tr>
1540 <h3><a name="misc_html">Miscellaneous: HTML Filtering</a></h3>
1542 <table border="1" width="100%">
1543 <tr><th style="width:8%">Variable</th>
1544 <th style="width:29%">Default Value</th>
1545 <th style="width:63%">Description</th></tr>
1547 <td valign="top"><a name="desc_user_html">user_html</a></td>
1548 <td valign="top"><p>, <b>, <i>, <a>, <em>, <br>, <tt>, <hr>, <ol>, <ul>, <li>, <code>, <pre></td>
1549 <td valign="top">HTML tags and attributes that normal users are allowed to
1550 use in story submissions and comments.</td></tr>
1552 <td valign="top"><a name="desc_admin_html">admin_html</a></td>
1553 <td valign="top">additional HTML tags, e.g. for tables</td>
1554 <td valign="top">HTML tags and attributes that admin users are allowed to
1555 use (in addition to those from user_html). Redefining a tag with
1556 additional attributes will overwrite the definition from user_html.</td></tr>
1558 <td valign="top"><a name="desc_advanced_html">advanced_html</a></td>
1559 <td valign="top">additional HTML tags for use with the Advanced Editor, e.g.
1561 <td valign="top">Additional HTML tags and attributes that users are allowed
1562 to use when the <a href="#desc_advanced_editor">Advanced Editor</a> is
1565 <td valign="top"><a name="desc_skip_html_filter_for_root">skip_html_filter_for_root</a></td>
1566 <td valign="top">0</td>
1567 <td valign="top">When set to 1, this will allow members of the Root group
1568 to use <em>all</em> HTML in their posts. <strong>Use at your own risk!</strong></td></tr>
1570 <td valign="top"><a name="desc_allowed_protocols">allowed_protocols</a></td>
1571 <td valign="top">array ('http', 'https', 'ftp');</td>
1572 <td valign="top">Defines which protocols are allowed in links (i.e. HTML
1573 <code><a></code> tags).</td></tr>
1576 <h3><a name="misc_censoring">Miscellaneous: Censoring</a></h3>
1578 <table border="1" width="100%">
1579 <tr><th style="width:8%">Variable</th>
1580 <th style="width:29%">Default Value</th>
1581 <th style="width:63%">Description</th></tr>
1583 <td valign="top"><a name="desc_censormode">censormode</a></td>
1584 <td valign="top">1</td>
1585 <td valign="top">Censor submissions and comments (0 = Disabled, 1 = Enabled, exact matches, 2 = Enabled, match start of word, 3 = Enabled, match fragment)</td></tr>
1587 <td valign="top"><a name="desc_censorreplace">censorreplace</a></td>
1588 <td valign="top">*censored*</td>
1589 <td valign="top">Text to replace a censored word with</td></tr>
1591 <td valign="top"><a name="desc_censorlist">censorlist</a></td>
1592 <td valign="top">array(<i>a list of "bad" words goes here ...</i>)</td>
1593 <td valign="top">An array of censored words</td></tr>
1596 <h3><a name="misc_ip_lookup">Miscellaneous: IP Lookup</a></h3>
1598 <table border="1" width="100%">
1599 <tr><th style="width:8%">Variable</th>
1600 <th style="width:29%">Default Value</th>
1601 <th style="width:63%">Description</th></tr>
1603 <td valign="top"><a name="desc_ip_lookup">ip_lookup</a></td>
1604 <td valign="top"><i>not set</i></td>
1605 <td valign="top">The IP addresses of comment posters are logged and displayed for admin users. When this variable is set to point to a service that can do IP address lookups, it's possible to lookup the owner of an IP address by clicking on it, making it easier to report abuse to ISPs, etc.<br>
1606 <code>$_CONF['ip_lookup']</code> should hold the complete URL to the lookup service, with a '<code>*</code>' marking the place where the IP address should go. It's also possible to use Tom Willet's <a href="http://sourceforge.net/project/showfiles.php?group_id=68255&package_id=95743">NetTools</a> package, in which case the correct setting would be <code>$_CONF['ip_lookup'] = $_CONF['site_url'] . '/nettools/whois.php?domain=*';</code></td></tr>
1609 <h3><a name="misc_ip_webservices">Miscellaneous: Webservices</a></h3>
1611 <table border="1" width="100%">
1612 <tr><th style="width:8%">Variable</th>
1613 <th style="width:29%">Default Value</th>
1614 <th style="width:63%">Description</th></tr>
1616 <td valign="top"><a name="desc_disable_webservices">disable_webservices</a></td>
1617 <td valign="top">false</td>
1618 <td valign="top">Set this to <code>true</code> to disable the webservices.</td></tr>
1620 <td valign="top"><a name="desc_restrict_webservices">restrict_webservices</a></td>
1621 <td valign="top">false</td>
1622 <td valign="top">Set this to <code>true</code> to restrict webservices usage
1623 to users with the <tt>webservices.atompub</tt> permission (e.g. those in
1624 the predefined "Webservices Users" group).</td></tr>
1626 <td valign="top"><a name="desc_atom_max_stories">atom_max_stories</a></td>
1627 <td valign="top">10</td>
1628 <td valign="top">Max. number of stories returned when an Atom feed is
1629 requested through the webservices API.</td></tr>
1632 <p>Also see <a href="http://wiki.geeklog.net/wiki/index.php/Using_the_Webservices">Using the Webservices</a> in the Geeklog Wiki.</p>
1634 <h3><a name="misc_ip_webservices">Miscellaneous: Topics</a></h3>
1636 <table border="1" width="100%">
1637 <tr><th style="width:8%">Variable</th>
1638 <th style="width:29%">Default Value</th>
1639 <th style="width:63%">Description</th></tr>
1641 <td valign="top"><a name="desc_disable_breadcrumbs_topics">disable_breadcrumbs_topics</a></td>
1642 <td valign="top">false</td>
1643 <td valign="top">Set this to <code>true</code> to disable topic breadcrumbs.</td></tr>
1645 <td valign="top"><a name="desc_disable_breadcrumbs_articles">disable_breadcrumbs_articles</a></td>
1646 <td valign="top">false</td>
1647 <td valign="top">Set this to <code>true</code> to disable article breadcrumbs.</td></tr>
1649 <td valign="top"><a name="desc_disable_breadcrumbs_plugins">disable_breadcrumbs_plugins</a></td>
1650 <td valign="top">false</td>
1651 <td valign="top">Set this to <code>true</code> to disable all breadcrumbs that are displayed by plugins.</td></tr>
1654 <h2><a name="db-config.php">db-config.php</a></h2>
1656 <p>As the name implies, the file <tt>db-config.php</tt> contains the database
1657 configuration. This information is put there during the initial install and
1658 you should not normally have to edit this file.</p>
1660 <table border="1" width="100%">
1661 <tr><th style="width:8%">Variable</th>
1662 <th style="width:29%">Default Value</th>
1663 <th style="width:63%">Description</th></tr>
1664 <tr><td valign="top">_DB_host</td>
1665 <td valign="top">localhost</td>
1666 <td valign="top">Database Server (to be entered in the form: <i>hostname:port:unixsocket</i>). In most cases you won't need to change the default value.</td></tr>
1667 <tr><td valign="top">_DB_name</td>
1668 <td valign="top">geeklog</td>
1669 <td valign="top">Database Name</td></tr>
1670 <tr><td valign="top">_DB_user</td>
1671 <td valign="top">root</td>
1672 <td valign="top">Database User Account</td></tr>
1673 <tr><td valign="top">_DB_pass</td>
1674 <td valign="top">null</td>
1675 <td valign="top">Database User Password</td></tr>
1676 <tr><td valign="top">_DB_table_prefix</td>
1677 <td valign="top">gl_</td>
1678 <td valign="top">Prefix to put in front of all of Geeklog's table names (to
1679 avoid name collisions with tables used by other applications)</td></tr>
1680 <tr><td valign="top">_DB_dbms</td>
1681 <td valign="top">mysql</td>
1682 <td valign="top">This option tells Geeklog which type of database it's
1683 running on. Can be either <code>'mysql'</code> (for MySQL) or
1684 <code>'mssql'</code> (for Microsoft SQL Server).</td></tr>
1688 <h2><a name="siteconfig.php">siteconfig.php</a></h2>
1690 <p>The <tt>siteconfig.php</tt> file holds configuration data that can not be
1691 stored in the database. Again, most of this information is put there during
1692 the installation and you should not normally have to edit this file.</p>
1694 <table border="1" width="100%">
1695 <tr><th style="width:8%">Variable</th>
1696 <th style="width:29%">Default Value</th>
1697 <th style="width:63%">Description</th></tr>
1698 <tr><td valign="top"><a name="desc_path">path</a></td>
1699 <td valign="top">/path/to/geeklog/</td>
1700 <td valign="top">Base file system path for your site (trailing slash necessary)</td></tr>
1701 <tr><td valign="top"><a name="desc_path_system">path_system</a></td>
1702 <td valign="top">/path/to/geeklog/system/</td>
1703 <td valign="top">Path to your system directory for your site (trailing slash necessary). This directory holds the code libraries used throughout Geeklog</td></tr>
1705 <td valign="top"><a name="desc_site_enabled">site_enabled</a></td>
1706 <td valign="top">true</td>
1707 <td valign="top">A Geeklog site can be disabled quickly (e.g. for maintenance)
1708 by setting this to 'false'.<br>
1709 Also see the <a href="#desc_site_disabled_msg">site_disabled_msg</a>
1710 configuration option.</td></tr>
1712 <td valign="top"><a name="desc_default_charset">default_charset</a></td>
1713 <td valign="top">iso-8859-1</td>
1714 <td valign="top">Character encoding used by Geeklog when serving HTML pages or
1715 sending email. Only used if the language file did not already set
1716 another character encoding.<br>
1717 For <a href="http://wiki.geeklog.net/wiki/index.php/Multi-Language_Support">multi-language</a> setups, using <code>'utf-8'</code> as the default character
1718 set is recommended.</td></tr>
1720 <td valign="top"><a name="desc_rootdebug_siteconfig">rootdebug</a></td>
1721 <td valign="top"><i>(disabled)</i></td>
1722 <td valign="top">Same as the '<a href="#desc_rootdebug">rootdebug</a>' option
1723 in the Configuration. However, sometimes an error may occur that prevents
1724 you from logging into your site and enabling the 'rootdebug' option. In
1725 such a case, you can uncomment this line and enable the option here.<br>
1726 In addition to 'true' and 'false', you can also set this option to 'force'
1727 (only in <tt>siteconfig.php</tt>). This will enable displaying of sensitive
1728 information like passwords and cookies.<br>
1729 In any case, the same strong warning as <a href="#desc_rootdebug">above</a>
1730 applies here, too: <strong>Do not leave this option enabled on a "live"
1731 site!</strong></td></tr>
1735 <h2><a name="url-rewrite">URL Rewriting</a></h2>
1737 <p>Geeklog includes a simple but useful URL rewriting feature which can help
1738 make your site more crawler friendly (i.e. the URLs of your site are more
1739 likely to be picked up by the search engine's indexing bots). This feature is
1740 supported for URLs to stories, static pages, the article directory, and links.
1742 <p>URL rewriting means that your URLs will look like this</p>
1743 <p style="margin-left:4em;"><tt>http://www.geeklog.net/article.php/20021022234959146</tt></p>
1744 <p>instead of like this</p>
1745 <p style="margin-left:4em;"><tt>http://www.geeklog.net/article.php?story=20021022234959146</tt></p>
1746 <p>While some search engines will pick up the second form, Google seems to
1747 prefer the first format and often ignores the second format.</p>
1748 <p><strong>Note:</strong> This feature may not work with all web servers. It
1749 is known to work with Apache (all versions) and known <em>not</em> to work
1750 with IIS (at least some versions). Please try it out before you go public
1754 <h2><a name="Localization">Localization</a></h2>
1756 <p>Localizing Geeklog is fairly easy. All strings are contained in a
1757 language file. The default file that ships with the tarball is english.php.
1758 People interested in translating Geeklog to other languages are encouraged
1760 href="http://lists.geeklog.net/listinfo/geeklog-translations">geeklog-translations</a>
1761 mailing list. All important information concerning translating Geeklog will
1764 <h3><a name="date_formats">Locale and Date Formats</a></h3>
1766 <p>You can set the locale and date format in the configuration. To set the
1767 locale, set the variable to the proper string or if you leave it blank it
1768 will pull the default locale from the operating system. The date formats
1769 are handled by your locale. Isn't that smart? Locale names are OS
1770 dependent. On most UNIX hosts, you can find locale codes in the
1771 <i>/usr/share/locale/locale.alias</i> file and on some systems the command
1772 <i>locale -a</i> will display all available locales on a system. If a
1773 locale doesn't exist you can create it using the <i>localedef</i> command.
1775 <p>More info on locale: <a
1776 href="http://www.opengroup.org/onlinepubs/7908799/xbd/locale.html">http://www.opengroup.org/onlinepubs/7908799/xbd/locale.html</a><br>
1777 More info on localdef: <a
1778 href="http://www.opengroup.org/onlinepubs/7908799/xcu/localedef.html">http://www.opengroup.org/onlinepubs/7908799/xcu/localedef.html</a>
1780 <h3>Date Format Syntax</h3>
1783 <li><tt>%a - abbreviated weekday name according to the current locale</tt></li>
1784 <li><tt>%A - full weekday name according to the current locale</tt></li>
1785 <li><tt>%b - abbreviated month name according to the current locale</tt></li>
1786 <li><tt>%B - full month name according to the current locale</tt></li>
1787 <li><tt>%c - preferred date and time representation for the current locale</tt></li>
1788 <li><tt>%C - century number (the year divided by 100 and truncated to an integer, range 00 to 99)</tt></li>
1789 <li><tt>%d - day of the month as a decimal number (range 00 to 31)</tt></li>
1790 <li><tt>%D - same as %m/%d/%y</tt></li>
1791 <li><tt>%e - day of the month as a decimal number, a single digit is preceded by a space (range ' 1' to '31')</tt></li>
1792 <li><tt>%h - same as %b</tt></li>
1793 <li><tt>%H - hour as a decimal number using a 24-hour clock (range 00 to 23)</tt></li>
1794 <li><tt>%I - hour as a decimal number using a 12-hour clock (range 01 to 12)</tt></li>
1795 <li><tt>%j - day of the year as a decimal number (range 001 to 366)</tt></li>
1796 <li><tt>%m - month as a decimal number (range 1 to 12)</tt></li>
1797 <li><tt>%M - minute as a decimal number</tt></li>
1798 <li><tt>%n - newline character</tt></li>
1799 <li><tt>%p - either `am' or `pm' according to the given time value, or the corresponding strings for the current locale</tt></li>
1800 <li><tt>%r - time in a.m. and p.m. notation</tt></li>
1801 <li><tt>%R - time in 24 hour notation</tt></li>
1802 <li><tt>%S - second as a decimal number</tt></li>
1803 <li><tt>%t - tab character</tt></li>
1804 <li><tt>%T - current time, equal to %H:%M:%S</tt></li>
1805 <li><tt>%u - weekday as a decimal number [1,7], with 1 representing Monday</tt></li>
1806 <li><tt>%U - week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week</tt></li>
1807 <li><tt>%V - The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week.</tt></li>
1808 <li><tt>%W - week number of the current year as a decimal number, starting with the first Monday as the first day of the first week</tt></li>
1809 <li><tt>%w - day of the week as a decimal, Sunday being 0</tt></li>
1810 <li><tt>%x - preferred date representation for the current locale without the time</tt></li>
1811 <li><tt>%X - preferred time representation for the current locale without the date</tt></li>
1812 <li><tt>%y - year as a decimal number without a century (range 00 to 99)</tt></li>
1813 <li><tt>%Y - year as a decimal number including the century</tt></li>
1814 <li><tt>%Z - time zone or name or abbreviation</tt></li>
1815 <li><tt>%% - a literal `%' character</tt></li>
1818 <div class="footer">
1819 <a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
1820 All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.