config.ini settings

In most cases, you will not need to modify ini file settings. This section is presented for advanced users only.

Many configuration setting are available through Search Engine's Setup Options, however, less commonly used settings are reserved for ini file and must be edited with a text editor. Be very careful to keep a backup of this file. If this file is corrupted, you will receive an error message when running Search Engine. You will not be able to login or use the program at all until the ini file has been fixed.


general settings

 ini setting  description
 datadir  This is where Search Engine looks for all its data files.
 searchabledir  This directory contains summaries of the words in HTML files so Search Engine doesn't have to parse the HTML every time
 result_cache  This directory contains a cache of the search results for the most recent searches made
 search_stats  This directory contains statistics for the last and top searches
 filelocking  Filelocking prevents two programs from updating the same data files at the same time. Turning off filelocking can cause data corruption. Be sure to backup your data files often if you need to disable this feature.
 filelock  This is the name of the directory that is created as a filelock.
 allow_mod_perl  Search Engine has not been specifically designed for mod_perl. See your web server's documentation for information on how to disable mod_perl. Search Engine will display an error message and will refuse to run under mod_perl. Although we do not recommend doing so, you can turn off this warning by enabling this ini setting.
 login_timeout  This is the amount of time in minutes before Search Engine will log out a user due to inactivity.
 stat_track_terms  This setting defines the threshold for search terms to be kept track of. Search Engine shows you the most extreme 100 results, but it keeps track of up to this number. If this setting is too low, it will become difficult for new popular terms to find their way into the top 100 lists.
 purge_cat_days  This is the number of days that pass before a cached page is discarded.
 context_bytes  The recommended number of bytes of context that Search Engine will return. Please note that if two fragments of context overlap they will be combined, resulting in a shorter context for that result.
 context_keywords  The maximum number of fragmented sections of context. Search Engine will return a new fragment for each keyword up to this maximum.
 find_on_samba_mount  In the rare case that your server will be using a Samba mount from a Unix or Linux machine, you'll need to set this to 1 this so make Search Engine check all directories. If you're not sure whether you'll be using a Samba mount, leave this setting at 0.
 demo  By enabling Demo Mode, you can prevent any potentially dangerous changes from being made with the program. A lot of functionality will be lost, for example, administrators will be able to see the Setup Options, but will not be able to modify them
umask umask = 000
Some web servers are configured so that files created by scripts have restricted permissions. This can cause a problem for Search Engine because it requires its own data files to be writable by the program itself. If you find a file can be created once, but not on subsequent attempts, take a look at the data/* files to see if they still have 777 permission. If not, you can set this config option to "000" to explicitly tell the program what umask permissions to use. This option was added in version 1.10.
max_filelock_wait max_filelock_wait = 5
This is the number of seconds the program will wait for a filelock to become available. If it has to wait longer than this amount of time, the program returns a filelock warning message. You can increase the time to wait by adjusting this setting. This option was added in version 1.10.

[language] settings

 ini setting  description
 month_abbr  Month abbreviations in a comma separated list.
 month_full  Full month names in a comma separated list.
 week_abbr  Weekday abbreviations in a comma separated list.
 week_full  Full weekday names in a comma separated list.
 ampm  How to display AM and PM, separated by a comma.
 ordinals  A list of numbers to display in dates. This list is comma separated, beginning with zero (0).

[ui] settings

 ini setting  description
 perpage  The default number of records to display on a list page within the control panel.
 bgcolor  Specify the color of the background behind Search Engine.
 date_format  Describes the format for displaying a date. (See below)
 time_format  Describes the format for displaying a time. (See below)
 datetime_format  Describes the format for displaying date and time together. (See below)



Date/time formats

A date/time format is a string of text with special markers. Markers begin with a percent sign and are followed by one character. By using a combination of these markers in your string, you can describe how dates and times are displayed. See %c for an example.

 marker   description  example
   %%  a percent sign   % 
   %a  abbreviated weekday name   Tue 
   %A  full weekday name   Tuesday 
   %b  abbreviated month name   Nov 
   %B  full month name   November 
   %c  same as "%m/%d/%y %H:%M:%S"   12/31/03 14:09:26 
   %C  same as "%a %b %e %T %Y"   Sat Nov 19 21:05:57 1994 
   %d  day of month (zero-padded)   02 
   %D  MM/DD/YY   12/31/01 
   %e  day of month   4 
   %h  abbreviated month name   Nov 
   %H  24 hour number (zero-padded)   17 
   %I  12 hour number (zero-padded)   07 
   %j  day number within year (zero-padded)   087 
   %k  24 hour number   17 
   %l  12 hour number   7 
   %m  month number (zero-padded)   06 
   %M  minutes (zero-padded)   03 
   %n  newline character   [enter] 
   %o  ornate day of month   23rd 
   %p  AM or PM   PM 
   %P  am or pm   pm 
   %q  quarter number 1-4   3 
   %r  same as "%I:%M:%S %p"   09:05:57 PM 
   %R  same as "%H:%M"   21:05 
   %s  seconds since epoch   997895411 
   %S  seconds (zero-padded)   05 
   %t  tab character   [tab] 
   %T  same as "%H:%M:%S"   21:05:57 
   %U  week number (out of 52)
 Sunday as first day of week 
 45 
   %w  day of the week, Sunday = 0   5 
   %W  week number (out of 52)
 Monday as first day of week 
 45 
   %x  same as "%m/%d/%y"   11/19/94 
   %X  same as "%H:%M:%S"   21:05:57 
   %y  year, 2 digits (zero-padded)   03 
   %Y  year, 4 digits   2004