GeekLog's server settings are configured in a text file called config.php.
It is necessary to edit this file to get your system running as well as
configuring it to your preferences. This file contains a set of variables
that are defined below:
Variable |
Default Value |
Description |
path |
/path/to/geeklog/ |
Base file system path for your site (trailing slash necessary) |
path_system |
/path/to/geeklog/system/ |
Path to your system directory for your site (trailing slash necessary). This directory holds the code libraries used throughout Geeklog |
path_html |
/path/to/geeklog/public_html/ |
Path to your web tree directory for your site (trailing slash necessary). This directory holds all the web pages used by Geeklog. |
path_log |
/path/to/geeklog/logs/ |
File system path for the log files |
path_language |
/path/to/geeklog/language/ |
location of the Geeklog language files |
backup_path |
Base path with "/backups/" suffix |
location where mysqldump (see above) will store database backups |
Variable |
Default Value |
Description |
site_name |
GeekLog Site |
Name of your site |
site_slogan |
Another Nifty GeekLog Site |
Slogan for your site. This is added to the HTML title field. |
site_mail |
admin@example.com |
E-mail address for all admin mail |
site_url |
http://www.yourdomain.com |
Base URL for your site (no trailing slash) |
theme |
XSilver |
Default theme to use on the site |
layout_url |
Site URL path, with layout dir and default layout |
Location of the default layout |
path_themes |
/path/to/geeklog/public_html/layout/ |
Directory where all themes reside |
path_layout |
/path/to/geeklog/public_html/layout/XSilver/ |
Path to current theme directory |
allow_user_themes |
Can be 1 or 0 |
If set to 1, users can set their own theme that the site uses |
allow_user_language |
Can be 1 or 0 |
If set to 1, users can select the language for the site navigation |
allow_user_photo |
Can be 1 or 0 |
If set to 1, users can upload a photo to their profile |
hide_author_exclusion |
Can be 1 or 0 |
If set to 1, the option to to exclude certain authors from being seen is hidden from the user's preferences. |
site_enabled |
true |
A Geeklog site can be disabled quickly (e.g. for maintenance) by setting
this to 'false'. |
site_disabled_msg |
'Geeklog Site is down. Please come back soon.' |
This contains the message to display when a Geeklog site is disabled.
If the text begins with "http:" then visitors are redirected to that
URL. |
Variable |
Default Value |
Description |
language |
english |
Name of your language file. Additional language files may be
available for download at http://www.geeklog.net.
If you translate a language file, please send it to us. Also see Localization below. |
locale |
en-gb |
Locale for the system |
date |
%A, %B %d %Y @ %I:%M %p %Z |
Date format used for most of the site, including story displays. See date formats below. |
daytime |
%m/%d %I:%M%p |
Date format used when a shorter date is needed. See date formats below. |
shortdate |
%x |
Date format this is the shortest date. See date
formats below. |
dateonly |
%d-%b |
Short date format (day and month only), to be used e.g. in the
Upcoming Events and Older Stories blocks. See date
formats below. |
timeonly |
%I:%M %p %Z |
Format string for the time only, to be used e.g. on the Event Details
page. See date formats below. |
default_charset |
iso-8859-1 |
Character encoding used by Geeklog when serving HTML pages or
sending email. Only used if the language file did not already set
another character encoding. |
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.
Variable |
Default Value |
Description |
loginrequired |
0 |
Login is required to access any part of the site. When
set to 1, this overrides the following settings. When you only want to
block access to certain parts of the site, set this to 0 and select
from the following settings. |
submitloginrequired |
0 |
When set to 1, only registered users can submit stories, links, and
events |
commentsloginrequired |
0 |
When set to 1, only registered users can submit comments |
linksloginrequired |
0 |
When set to 1, only registered users can access the links area |
pollsloginrequired |
0 |
When set to 1, only registered users can access the list of recent
polls |
calendarloginrequired |
0 |
When set to 1, only registered users can access the calendar |
statsloginrequired |
0 |
When set to 1, only registered users can access the site stats |
searchloginrequired |
0 |
When set to 1, only registered users can use the advanced search. When
set to 2, the simple search is blocked for anonymous users, too. |
profileloginrequired |
0 |
When set to 1, only registered users can view another user's profile |
emailuserloginrequired |
0 |
When set to 1, only registered users can use the email submission
form to send an email to another user |
emailstoryloginrequired |
0 |
When set to 1, only registered users can email stories |
Variable |
Default Value |
Description |
storysubmission |
1 |
Enable (1) or disable (0) the story submission queue |
linksubmission |
1 |
Enable (1) or disable (0) the link submission queue |
eventsubmission |
1 |
Enable (1) or disable (0) the event submission queue |
usersubmission |
1 |
Enable (1) or disable (0) the user submission queue (i.e.
new users must be approved before they receive their password) |
allow_domains |
'' |
When user submission is enabled this can contain a comma-separated list
of domain names from which user submissions will not be queued (but
approved automatically).
Example: 'mycompany.com,myothercompany.com' |
notification |
array() |
Send an email notification to $_CONF['site_email'] when a new
story, link, or event has been submitted or a new user has registered with
the site. The array() can hold any combination of the strings
'story', 'link', 'event', and 'user'
(separated by commas), depending on which notification(s) you want.
Example: array('story','user'); would
send notifications when a new story has been submitted or a new user has
registered. No notifications would be sent for new links or events. |
listdraftstories |
0 |
When set to 1, this will display an additional block on the
submissions page (moderation.php) that lists all the stories that
have the 'draft' flag set. |
postmode |
plaintext |
Sets the default submission mode to 'html' or 'plaintext' |
speedlimit |
45 |
Minimum delay between submissions in seconds. This helps prevent Denial of Service (DOS) attacks |
skip_preview |
0 |
If 1, allows submission of stories and comments without previewing (i.e. the submission form will always have a Preview and a Submit button). |
Variable |
Default Value |
Description |
sortmethod |
sortnum |
alpha = Sort topics in topic list alphabetically sortnum = Sort topics in topic list by sort number |
showstorycount |
1 |
Show the number of stories in a topic in the Sections block (0=no, 1=yes) |
showsubmissioncount |
1 |
Show the number of story submissions for a topic in the Sections block (0=no, 1=yes) |
hide_home_link |
0 |
Hide the "Home" link from the Sections block (0=no, 1=yes) |
showemptysearchresults |
0 |
Show empty result blocks even when search returned no hits for
stories, events, links, etc. (0=no, 1=yes) |
whosonline_threshold |
300 |
How long, in seconds, users can be idle before removing them from the whosonline block |
emailstories |
0 |
Let users get stories e-mailed to them (0=no, 1=yes), aka Daily Digest.
Please note that this requires cron and the use of PHP as a shell script. |
emailstorieslength |
1 |
When emailstories (above) is enabled, send only the title and the
link to the new stories (0), or send the entire introtext (1) or send
the first n characters from the introtext (where n = any other number) |
emailstoriesperdefault |
0 |
When set to 1, new users will be subscribed to the daily digest
automatically when they register with the site. |
newstoriesinterval |
86400 |
Stories are "new" if they are this many seconds old. |
newcommentsinterval |
172800 |
Comments are "new" if they are this many seconds old. |
newlinksinterval |
1209600 |
Links are "new" if they are this many seconds old. |
hidenewstories |
0 |
Set to 1 to hide new stories from What's New block. |
hidenewcomments |
0 |
Set to 1 to hide new comments from What's New block. |
hidenewlinks |
0 |
Set to 1 to hide new links from What's New block. |
copyrightyear |
(commented out) |
Set this to the year you want to appear in the copyright notice of your
site's footer. If not set, Geeklog will use the current year. |
allow_username_change |
0 |
If set to 1, users will be allowed to change their username
(login name). Stories and comments posted under the old username will
automatically show the new username. |
allow_account_delete |
0 |
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". |
passwordspeedlimit |
300 |
Minimum delay between two requests for a new password, in seconds. |
Variable |
Default Value |
Description |
personalcalendars |
0 |
Allow account holders to have a personal calendar |
showupcomingevents |
1 |
Show up-coming events (0=no, 1=yes) |
upcomingeventsrange |
14 |
Number of days that "Upcoming Events" will look ahead. |
event_types |
Anniversary, Appointment, Birthday, Business, Education, Holiday, Meeting, Miscellaneous, Personal, Phone Call, Special Occasion, Travel, Vacation |
The set of event types that are used both on the public calendar and the user's personal calendars |
Variable |
Default Value |
Description |
maximagesperarticle |
5 |
max. number of images you can have in a story |
limitnews |
10 |
Number of stories to limit the index page to, this same number will appear in the older stuff block |
minnews |
1 |
Minimum numbers of stories than can appear on a topic page |
contributedbyline |
1 |
Show author username to public, and enable search by username (0=no, 1=yes) |
article_image_align |
right |
Which side of article the topic image should be shown (right or left) |
hideemailicon |
0 |
When set to 1, this will disable the ability to send a story by email. It
will also hide the email icon from stories and the "Email Article To a
Friend" from the Story Options block. |
hideprintericon |
0 |
When set to 1, this will disable display of a story in a "printer
friendly" format. It will also hide the printer icon from stories and
the "View Printable Version" from the Story Options
block. |
showfirstasfeatured |
0 |
When set to 1, this will render the first story on any page
using the templates for a featured story, even if that story is not
featured. This will even be applied to the first story on page 2 of a
topic page, for example. |
Variable |
Default Value |
Description |
image_lib |
'' (empty string) |
Set this to either 'imagemagick' or 'netpbm' if images should be
resized during upload. Leave as '' if you don't want images to be
resized or if you don't have those packages available. |
path_to_mogrify |
(commented out) |
If you chose 'imagemagick' for $_CONF['image_lib'] above, then this
should hold the complete path to the mogrify binary (from the ImageMagick
package), e.g. '/usr/bin/mogrify'.
You will need a fairly recent version of ImageMagick for this to work
(version 5.4.9 or newer is recommended). |
path_to_netpbm |
(commented out) |
If you chose 'netpbm' for $_CONF['image_lib'] above, then this should
hold the complete path to the directory where the binaries from
the netpbm package are kept, e.g. '/usr/bin/netpbm/'. Note that the path
must end in a slash.
Precompiled binaries of the netpbm package for various platforms can be
downloaded from the Homepage of the Gallery
project. |
keep_unscaled_image |
0 |
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). |
max_image_width |
300 |
Max. width of an image in pixels. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
max_image_height |
300 |
Max. height of an image in pixels. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
max_image_size |
1048576 (equals 1 MB) |
Max. size of an image in bytes. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
max_photo_width |
96 |
Max. width of a user photo in pixels. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
max_photo_height |
96 |
Max. height of a user photo in pixels. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
max_photo_size |
65536 (equals 64 KB) |
Max. size of a user photo in bytes. If it exceeds this, it is either
rejected or resized (depending on the setting of $_CONF['image_lib']
above).
|
Geeklog can export its headlines to a so-called RSS feed (also known as an RDF feed). This will let you share your news with other sites (Hint: Create a Portal block from Geeklog's Block menu to import RSS/RDF news feeds from other sites).
Variable |
Default Value |
Description |
backend |
1 |
Create an RSS/RDF file for the stories in rdf_file (0=no, 1=yes) |
rdf_file |
HTML path with "/backend/geeklog.rdf" suffix |
File system path for the RDF file. This file allows you to share your site's headlines with others |
rdf_language |
en-gb |
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). Example: 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). |
rdf_limit |
10 |
Limit the number of stories in the RSS 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. |
rdf_storytext |
0 |
If this value is 1, then the entire introtext of the stories will be included in the RSS feed. Any number greater than one 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. |
Variable |
Default Value |
Description |
user_html |
<p>,<b>,<i>,<a>,<em>,<br>,<tt>,<hr>,<ol>,<ul>,
<li>,<code>,<pre> |
HTML tags and attributes that normal users are allowed to
use in story submissions and comments. |
admin_html |
additional HTML tags, e.g. for tables |
HTML tags and attributes that admin users are allowed to
use (in addition to those from user_html). Redefining a tag with
additional attributes will overwrite the definition from user_html. |
censormode |
1 |
Censor submissions and comments (0=no, 1=yes) |
censorreplace |
*censored* |
Text to replace a censored word with |
censorlist |
array("fuck","cunt","fucker","fucking","pussy","cock",
"c0ck","cum","twat","clit","bitch","fuk","fuking",
"motherfucker") |
An array of censored words |
Localizing GeekLog is fairly easy. All strings are contained in a
language file. The default file that ships with the tarball is english.php.
People interested in translating Geeklog to other languages are encouraged
to join the geeklog-translations
mailing list. All important information concerning translating Geeklog will
be posted there.
You can set the locale and date format in the config.php file. To set the
locale, set the variable to the proper string or if you leave it blank it
will pull the default locale from the operating system. The date formats
are handled by your locale. Isn't that smart? Locale names are OS
dependent. On most UNIX hosts, you can find locale codes in the
/usr/share/locale/locale.alias file and on some systems the command
locale -a will display all available locales on a system. If a
locale doesn't exist you can create it using the localedef command.