FWE Configuration File
The configuration file contains 6 sections using variable=value format, one per line.
In the first section you specify general values for your site.
Sitename = String
This string is only used for web masters who have multiple configuration files on the same machines. It is not actually used by the software, however, we found it to be useful when setting up a new Wiki on our web servers.
SiteURL = String
The SiteURL is only used when someone types in your EDIT_SCRIPTNAME URL to a topic which does not exist in your database. This helps for the occasion where a search engine (or sometimes a user) is trying to load an old edit screen. FWE will redirect the visitor to the SiteURL - which could be your homepage, or a page within the Wiki.
CompanyName = String
This field is used to place your company name in any HTML file presented by the WIKI. Internally FWE supports a macro system allowing you to use one of hundreds of templates. Replacing the macro ###COMPANY_NAME### with the string you have set here.
Default_Topic = String
FWE by default inserts into a new installation a page called Welcome with brief information about the product to help someone jump right in and start using our engine. And if someone visits your wiki and starts tinkering with the URL, this it the topic that is displayed instead of a blank page or error.
Delete_Phrase = String
This is important to keep secure! This phrase will allow you to put an item into the edit mode, remove all of the text and put this string in. When you save the document, the server checks the content against this phrase - if they match, all records of this page are purged from the database and you re redirected to the Default_Topic. If you feel this is not something you want to support on your site, simply remove this from your configuration file.
Authentication = String
This field allows you to enable one of 4 (four) security designs used to authenticate someone who wishes to make change(s) to your wiki.
Available choices are Blank, SINGLE, DATABASE, POP3. You can also setup security at the Apache level too.
BY_IP_ONLY = String
This optional field is an IP filter, blocking all IPs which are not defined. To define multiple IP addresses which are allowed to ADD and EDIT you wiki, place a space between them. e.g. 10.1.10.2 10.1.10.7 70.91.2.129 will allow those three IP addresses to make changes to your wiki. If this field is blank, then any IP address is allowed to post their changes.
BY_IP_ONLY_NOTICE_TOPIC = String
This field is the topic which will be displayed to anyone who is not in your BY_IP_ONLY list.
The second section is for your Apache web server.
Once you have set these variables to the values you wish to use, you will need to modify your httpd.conf or apache2.conf and add either globally or to a <VirtualHost> the following strings (matching your paths).
ScriptAliasMatch ^/path1/((?!(?i:webobjects)).*$) "/opt/3Fwiki/fpc_wiki_engine" ScriptAliasMatch ^/path2/((?!(?i:webobjects)).*$) "/opt/3Fwiki/fpc_wiki_engine" ScriptAliasMatch ^/path3/((?!(?i:webobjects)).*$) "/opt/3Fwiki/fpc_wiki_engine" ScriptAliasMatch ^/path4/((?!(?i:webobjects)).*$) "/opt/3Fwiki/fpc_wiki_engine" <Directory "/opt/3Fwiki"> AllowOverride None Options \ ExecCGI -MultiViews SymLinksIfOwnerMatch Order allow,deny Allow from all </Directory>
VIEW_SCRIPTNAME = /path1/
This is the URI which puts FWE into a VIEW mode. When the URL contains this followed by any String, FWE will fetch from the database server the content for the topic (the string after this path). For example our welcome page. In your HTML file, this is the Macro ###VIEW_SCRIPTNAME### - useful if you have hard coded links on your HTML, or if you are using FWE as a content management system for your site.
EDIT_SCRIPTNAME = /path2/
This is the URI which puts FWE into an EDIT mode. The string after this path is expected to be an exist topic in your database. If the topic does not already exist (someone is hacking around with your URLs or an old bookmark), FWE will redirect the browser to the URL contained in your SiteURL variable. In your HTML file, this is the Macro ###EDIT_SCRIPTNAME###.
ADD_SCRIPTNAME = /path3/
This is an optional URI which puts FWE into an ADD mode. This string after this path is expected to be a new topic not found in your database. If the topic already exists, the string (fork) is appended to the topic name, avoiding overwrite. In your HTML file, this is the Macro ###ADD_SCRIPTNAME###.
SEARCH_SCRIPTNAME = /path4/
This is the URI which puts FWE into a SEARCH mode. The string after this path is a list of the words or phrase which you are asking to search. Our searching techniques are extremely advanced and support different techniques (controlled by the configuration file). We do much more than a simple "contains" or "like".
The third section controls our word filtering and searching process
When a new document is added to the system, FWE parses everything to pre-build the HTML version of the content - giving our Wiki engine much faster results than all other Wiki engines. During this parsing phase FWE is also running the words against this static list of words. Words which are found in these lists are not added to the TAG CLOUD nor the SEARCH ENGINE.
DONT_TAG = String
Contains a space delimited listing of words which you do not want to include in your system. These can be current slang, words which you feel are not helpful to someone searching your data.
DONT_TAG_PRONOUNS = String
Contains a space delimited listing of pronouns which you do not want to include in your system. These words are generally useless to any search algorithm.
SEARCH_USING_SOUNDEX = Number String
When a visitor does a search request, do you want your software to use a SOUNDEX compare to find words in addition to the default "EXACT MATCH". To enable set to 1 {default} or set to 0 to disable.
SEARCH_USING_METAPHONE = String
When a visitor does a search request, do you want your software to use a METAPHONE comparison to find words in addition to the default "EXACT MATCH". To enable set to 1 {default} or set to 0 to disable.
SEARCH_USING_DOUBLE_METAPHONE = String
When a visitor does a search request, do you want your software to use a DOUBLE METAPHONE comparison to find words in addition to the default "EXACT MATCH". To enable set to 1 {default} or set to 0 to disable.
SEARCH_USING_CARVERPHONE = String
When a visitor does a search request, do you want your software to use a CARVERPHONE comparison to find words in addition to the default "EXACT MATCH". To enable set to 1 {default} or set to 0 to disable.
The fourth section control database connections
FWE uses ODBC calls, allowing it to communicate with any database solution which supports standard SQL commands like INSERT, UPDATE, DELETE, SELECT .
Driver = String
Unlike most ODBC implementations which use DSN connection strings, FWE communicates directly to the driver. So this string should be the name found in your ODBCINST.INI (In Windows, your "Drivers Tab" found in the Control Panel
Database = String
This is used for database engines like PostgreSQL, MySQL, etc. which support databases.
Database2 = String
Using this keyword instead of Driver and Database will use the DSN entry from ODBC.INI, for database engines like DB2.
Username = String
This is part of the login credential used to communicate to the database. FWE expect this user to be able to create tables, manipulate the content of the tables it has created.
Password = String
This is part of the login credential used to communicate to the database.
Server = String
This is the IP Address or machine name of the database server. FWE supports the command line parameter -T to test these settings.
Port = Numeric String
This is the port which the database server is listening on. Not all ODBC drivers require this to be set, however, to avoid errors you should refer to your database server documentation and set this to the default port number for your server.
Prefix = String
Since FWE can have multiple instances on the same servers, this string is added to the start of all table names. Allowing you to have multiple wiki environments without worry of collision. If blank, the system will use fwe.
Param = Variable=Value
Some database engines require special settings to handle large objects as strings. Or if you need to control connection pools, or any other type of ODBC setting. If your connection requires multiple variable=value pairs then you will have something like:
Param = Variable1=Value1 Param = Variable2=Value2
The fifth section controls SQL Data Types
Even though SQL is a standard, Database Engines do not always implement Data Types the same way. There are three different data types our product uses.
SQL_INT32 = String
This should be a Data Type capable of handling numbers as large as 2,147,483,647 or larger.
SQL_CONTENT = String
This should be a Data Type capable of handling LARGE strings of data. Usually over 65,000 characters. FWE will support Normal LARGE OBJECTS and Wide LARGE OBJECTS.
SQL_TITLE = String
This should be a Data Type capable of handling strings of 100 characters or less. This should either be the type CHAR or VARCHAR/VARCHAR2. Make sure the type you select supports (###) as a parameter like Varchar(15).
The sixth section controls Date Formatting
Internally FWE uses Unix Timestamp format, however, when rendering the data on your HTML you may way it to look much nicer. The following characters are supported for the 5 format variables.
AMPM, AM/PM, A/P = Return the time in 12 hour format with AM or PM string.
: and / = Date or Time separators
C,D,H,M,N,S,T,Y,Z = Valid Characters with the following meanings:
YY, YYYY = Year
M,MM = if after H then mean Minutes
M = 0 to 12 of Month
MM = 00 to 12 of Month
MMM = Jan to Dec of Month
MMMM = January to December of Month
D = 0 to 31 of Day
DD = 00 to 31 of Day
DDD = Sun to Sat of Day
DDDD = Sunday to Saturday of Day
DDDDD = Short Date Format per Operating System
DDDDDD = Long Date Format per Operating System
H = 1 to 12 of Hour, if AMPM is not present then 0 to 24
HH = 1 to 12 of Hour, if AMPM is not present then 0 to 24
N = 0 to 59 of Minutes
NN = 00 to 59 of Minutes
S = 0 to 59 of Seconds
SS = 00 to 59 of Seconds
Z = 0 to 9 of hundredths of seconds
ZZZ = 0 to 999 of Milliseconds
T = Short Time Format per Operating System
TT = Long Time Format per Operating System
C = Short Date Format per Operating System, unless time is included
then Short Date Format space Long Time Format
DATE = String
TIME = String
DATETIME = String
RECENT_DATE_RANGE = Numeric String
If the data is within NOW to NOW minus this value then use RECENT_DATE format instead of DATETIME format. This allows you to show things like MMM-DD for things in the past 30 days for example, and everything else in MMM-DD-YYYY.
RECENT_DATE = String
Time is not included normally.
That is everything that is controlled by the configuration file. Remember, you can have multiple configuration files (one per folder where the binary is located) -- which means to have two different wiki setups you need to copies of the binary and configuration file.
Also see FWE Parameters for features you can do from the command line.
Search Engine
