High security risk!

This screen was accessed without requiring authentication. You should always make sure the configuration interface requires authentication, or it may be used by a hacker to modify your Foswiki configuration.

See Protecting Your Configuration for more information on limiting access to configuration.

Status: 1 error 5 warnings

Introduction

Explanation of colours and symbols
{DefaultUrlHost} required
Required settingsMust have a value
Error
ErrorsMust be fixed
Warning
WarningsNon-fatal, but often a good indicator that something is wrong
{Validation}{Method}
Expert settingsFor expert use only. You should not fiddle with them unless you have read all the documentation first.

Is this a new site?

Continue your setup with the Installation Guide Part 2

You will also need to consider how you are going to manage authentication and access control.

See the reference manual sections on authentication and access control, and the 'Security' section.

If your Foswiki site is already working

go to your Foswiki's start page.

How to become an administrator

You need to first register as a normal user and then goto AdminGroup and add that user to the GROUP setting (follow the text in yellow).

If you are on a non-standard platform or environment

There are a lot of supplemental documents on Foswiki.org

If you get stuck

There is a lot of support available at the Support forum.

Web server environment

1 warning
CONTEXT_DOCUMENT_ROOT/var/www/html
CONTEXT_PREFIX
DOCUMENT_ROOT/var/www/html
Warning: Could not write to the Foswiki root directory. This is not necessarily a big problem, but can cause issues installing some extensions that write files into the server root.
GATEWAY_INTERFACECGI/1.1
HTTP_ACCEPTtext/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
HTTP_ACCEPT_ENCODINGbr,gzip
HTTP_ACCEPT_LANGUAGEen-US,en;q=0.5
HTTP_CONNECTIONKeep-Alive
HTTP_HOSTwiki.ltl.uni-due.de
HTTP_USER_AGENTCCBot/2.0 (https://commoncrawl.org/faq/)
PATH/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
QUERY_STRING
REMOTE_ADDR107.21.85.250
REMOTE_PORT51436
REQUEST_METHODGET
REQUEST_SCHEMEhttp
REQUEST_URI/foswiki/bin/configure.pl
SCRIPT_FILENAME/var/www/html/foswiki/bin/configure.pl
SCRIPT_NAME/foswiki/bin/configure.pl
SERVER_ADDR134.91.18.141
SERVER_ADMINwebmaster@localhost
SERVER_NAMEwiki.ltl.uni-due.de
SERVER_PORT80
SERVER_PROTOCOLHTTP/1.1
SERVER_SIGNATURE
Apache/2.4.7 (Ubuntu) Server at wiki.ltl.uni-due.de Port 80
SERVER_SOFTWAREApache/2.4.7 (Ubuntu)
UMASK022
Operating systemLinux 4.4.0-139-generic (x86_64-linux-gnu-thread-multi)
Perl version5.018002 (linux)
Note that by convention "Perl version 5.008" is referred to as "Perl version 5.8" and "Perl 5.008004" as "Perl 5.8.4" (i.e. ignore the leading zeros after the .)
@INC library path/var/www/html/foswiki/lib
/etc/perl
/usr/local/lib/perl/5.18.2
/usr/local/share/perl/5.18.2
/usr/lib/perl5
/usr/share/perl5
/usr/lib/perl/5.18
/usr/share/perl/5.18
/usr/local/lib/site_perl
/var/www/html/foswiki/lib/CPAN/lib/arch
/var/www/html/foswiki/lib/CPAN/lib/5.18.2/x86_64-linux-gnu-thread-multi
/var/www/html/foswiki/lib/CPAN/lib/5.18.2
/var/www/html/foswiki/lib/CPAN/lib
This is the Perl library path, used to load Foswiki modules, third-party modules used by some plugins, and Perl built-in modules.
System temporary directory/tmp
CGI bin directory/var/www/html/foswiki/bin
Foswiki module in @INC pathFoswiki.pm (Version: v1.1.9) found
Perl modules
Algorithm::Diff
1.1902 installed. for base Foswiki
Apache::Htpasswd
Not installed. may be required for ApacheHtpasswd password manager
Archive::Tar
1.90 installed. may be required by the Extensions Installer in configure if command line tar or unzip is not available
Authen::SASL
2.15 installed. required for sending mail with Net::SMTP when server requires authentication
B::Deparse
1.20 installed. for base Foswiki
Carp
1.29 installed. for base Foswiki
CGI
3.63 installed. for base Foswiki (Versions 2.89, 3.37, 3.43, and 3.47 must be avoided. Most version from 3.15 and onwards should work)
CGI::Cookie
1.30 installed. required for Sessions support, available from the CPAN archive.
CGI::Session
4.48 installed. required for Sessions support, available from the CPAN archive.
Config
5.018002 installed. for base Foswiki
Cwd
3.40 installed. for base Foswiki
Data::Dumper
2.145 installed. for base Foswiki
Digest::MD5
2.52 installed. for base Foswiki
Digest::SHA
5.84 installed. may be required for password encryption
Crypt::PasswdMD5
1.3 installed. for admin password hash and .htpasswd encoding
Encode
2.49 installed. for international characters
Encode::compat
Not installed. may be required for international characters
Error
0.17010 installed. for base Foswiki
Exporter
5.68 installed. for base Foswiki
File::Basename
2.84 installed. for base Foswiki
File::Copy
2.26 installed. for base Foswiki
File::Glob
1.20 installed. for base Foswiki
FileHandle
2.02 installed. for base Foswiki
File::Path
2.09 installed. for base Foswiki
File::Spec
3.40 installed. for base Foswiki
File::Temp
0.23 installed. for base Foswiki
FindBin
1.51 installed. required if you want to use the Extensions Installer in configure
Getopt::Long
2.39 installed. may be required for international characters
HTML::Entities
3.69 installed. for WysiwygPlugin
HTML::Parser
3.71 installed. for WysiwygPlugin
HTML::Tree
5.03 installed. for CompareRevisionsAddOn
I18N::Langinfo
0.10 installed. may be required for international characters
Lingua::EN::Sentence
Not installed. may be required for generating new language files
Locale::Maketext
1.23 installed. may be required for international characters
Locale::Maketext::Lexicon
0.98 installed. may be required for international characters
LWP
6.05 installed. needed for the Configure Extensions installer, and for external URL based INCLUDEs
MIME::Base64
3.13 installed. for base Foswiki
Net::SMTP
2.31 installed. required for sending mail if sendmail not available on server
POSIX
1.32 installed. for base Foswiki
Socket
2.009 installed. for base Foswiki
Symbol
1.07 installed. may be required for international characters
Unicode::MapUTF8
Not installed. This is required for international characters for Perl 5.6. Do not install this for Perl 5.8 or later.
version
0.9902 installed. Used for standard perl version strings
Win32::Console
Not installed. may be required for international characters on Windows
PATH_INFO
For a URL such as http://wiki.ltl.uni-due.de/foswiki/bin/configure.pl/foo/bar, the correct PATH_INFO is /foo/bar, without any prefixed path components. Test PATH_INFO now - particularly if you are using mod_perl, Apache or IIS, or are using a web hosting provider. Look at the new path info here. It should be /foo/bar.
mod_perlNot used for this script (correct). mod_perl may be enabled for the other scripts. You can check this by visiting System.WebHome in your wiki.
mod_perl is not loaded into Apache
CGI useruserid = www-data groups = www-data, www-data
Your CGI scripts are executing as this user.
Original PATH/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
This is the PATH value passed in from the web server to this script - it is reset by Foswiki scripts to the PATH below, and is provided here for comparison purposes only.
Current PATH/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
This is the actual PATH setting that will be used by Perl to run programs. It is normally identical to {SafeEnvPath}, unless that variable is empty, in which case this will be the webserver user's standard path..

General path settings

1 error 3 warnings

If you are a first-time installer: once you have set up the eight paths below, your wiki should work - try it. You can always come back and tweak other settings later.

Security Note: Only the URL paths listed below should be browseable from the web. If you expose any other directories (such as lib or templates) you are opening up routes for possible hacking attempts.

{DefaultUrlHost} required  
Warning: Current setting does not match HTTP_HOST wiki.ltl.uni-due.de
This is the root of all Foswiki URLs e.g. http://myhost.com:123.
Show info
{PermittedRedirectHostUrls}  
If your host has aliases (such as both www.mywiki.net and mywiki.net and some IP addresses) you need to tell Foswiki that redirecting to them is OK. Foswiki uses redirection as part of its normal mode of operation when it changes between editing and viewing. To prevent Foswiki from being used in phishing attacks and to protect it from middleman exploits, the security setting {AllowRedirectUrl} is by default disabled, restricting redirection to other domains. If a redirection to a different host is attempted, the target URL is compared against this list of additional trusted sites, and only if it matches is the redirect permitted.
Enter as a comma separated list of URLs (protocol, hostname and (optional) port) e.g. http://your.domain.com:8080,https://other.domain.com
Show info
{ForceDefaultUrlHost} 
Enable this parameter to force foswiki to ignore the hostname of the entered URL and generate all links using the DefaultUrlHost.

By default, foswiki will use whatever URL that was entered by the user to generate links. The only exception is the special "localhost" name, which will be automatically replaced by the DefaultUrlHost. In most installations this is the preferred behavior, however when using SSL Accelerators, Reverse Proxys, and load balancers, the URL entered by the user may have been altered, and foswiki should be forced to return the DefaultUrlHost.

Show info
{ScriptUrlPath} required  
This is the 'cgi-bin' part of URLs used to access the Foswiki bin directory e.g. /foswiki/bin
Do not include a trailing /.

See ShorterUrlCookbook for more information on setting up Foswiki to use shorter script URLs. The setting for the view script may be adjusted below. Other scripts need to be manually added to lib/LocalSite.cfg

Show info
{ScriptUrlPaths}{view} required  %24Foswiki::cfg%7bScriptUrlPath%7d/view%24Foswiki::cfg%7bScriptSuffix%7d
This is the complete path used to access the Foswiki view script including any suffix. Do not include a trailing /. (This is an exception override, so the ScriptSuffix is not automatically added.) e.g. /foswiki/bin/view.pl
Note: The default is acceptable except when shorter URLs are used.

If you are using Shorter URL's, then this is typically set to the base path of your wiki, which should be the value of {ScriptUrlPath} excluding /bin. e.g. if your {ScriptUrlPath} is either empty or set to /bin leave {ScriptUrlPaths}{view} empty; if it is set to something like /directory/bin set it to /directory

Do not change this unless your Web Server configuration has been set to use shorter URLs. See also the Foswiki Apache Config Generator and Shorter URL Cookbook

Show info
{ScriptDir} required  
This is the file system path used to access the Foswiki bin directory.
Show info
{PubUrlPath} required  
Test the correctness of this path with this link:
My "pub" directory
Attachments URL path e.g. /foswiki/pub

Security Note: files in this directory are *not* protected by Foswiki access controls. If you require access controls, you will have to use webserver controls (e.g. .htaccess on Apache)

Show info
{PathCheckLimit} 
This is the maximum number of files and directories that will be checked for permissions for the pub and data Directory paths. This limit is initially set to 5000, which should be reasonable for a default installation. If it is exceeded, then an informational message is returned stating that incomplete checking was performed. If this is set to a large number on large installations, then a significant delay will be incurred when configure is run, due to the recursive directory checking.
Show info
{PubDir} required  
File checking limit 5000 reached, checking stopped - see expert options
Warning: 274 or more directories appear to have more access permission than requested in the Store configuration. Excess permissions might allow other users on the web server to have undesired access to the files. Verify that the Store expert settings of {RCS}{filePermission} (0644} and {RCS}{dirPermission}) (0755}) are set correctly for your environment and correct the file permissions listed below. (Files are not checked for excessive permissions in this release).
First 10 detected errors of insufficient, or excessive permissions
/var/www/html/foswiki/pub - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/ThesisTemplate - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/UserAccounts - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/RightsAssigmentForThesisSeminars - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/LtlTemplatesLogos - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/RaumSchilder - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/ThesisReviewForm - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/pub/LangTech/CoffeeList - directory permission 0775 exceeds requested 0755
Attachments store (file path, not URL), must match /foswiki/pub e.g. /usr/local/foswiki/pub
Show info
{DataDir} required  
File count: 844
Warning: 10 or more directories appear to have more access permission than requested in the Store configuration. Excess permissions might allow other users on the web server to have undesired access to the files. Verify that the Store expert settings of {RCS}{filePermission} (0644} and {RCS}{dirPermission}) (0755}) are set correctly for your environment and correct the file permissions listed below. (Files are not checked for excessive permissions in this release).
First 10 detected errors of insufficient, or excessive permissions, and all instances of missing files.
/var/www/html/foswiki/data - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/LangTech - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/Trash - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/TWiki - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/EduNLP - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/Main - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/_empty - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/System - directory permission 0775 exceeds requested 0755
/var/www/html/foswiki/data/_default - directory permission 0775 exceeds requested 0755
Topic files store (file path, not URL) e.g. /usr/local/foswiki/data
Show info
{ToolsDir} required  
Tools directory e.g. /usr/local/foswiki/tools
Show info
{TemplateDir} required  
Template directory e.g. /usr/local/foswiki/templates
Show info
{LocalesDir} required  
Translation files directory (file path, not URL) e.g. /usr/local/foswiki/locale
Show info
{WorkingDir} required  
Error: /var/www/html/foswiki/working/logs/error.202005 not writable

Directory where Foswiki stores files that are required for the management of Foswiki, but are not required to be browsed from the web. A number of subdirectories will be created automatically under this directory:
  • {WorkingDir}/tmp - used for security-related temporary files (these files can be deleted at any time without permanent damage)
    • Passthrough files are used by Foswiki to work around the limitations of HTTP when redirecting URLs
    • Session files are used to record information about active users - for example, whether they are logged in or not.
    For obvious reasons, these files must not be browseable from the web! Additionally you are recommended to restrict access rights to this directory so only the web server user can create files.
  • {WorkingDir}/work_areas - these are work areas used by extensions that need to store data on the disc
  • {WorkingDir}/registration_approvals - this is used by the default Foswiki registration process to store registrations that are pending verification.
Show info
{ScriptSuffix}  
Suffix of Foswiki CGI scripts (e.g. .cgi or .pl). You may need to set this if your webserver requires an extension.
Show info
{SafeEnvPath} required  
You can override the default PATH setting to control where Foswiki looks for external programs, such as grep and rcs. By restricting this path to just a few key directories, you increase the security of your Foswiki.
  1. Unix or Linux
    • Path separator is :
    • Make sure diff and shell (Bourne or bash type) are found on path.
    • Typical setting is /bin:/usr/bin
  2. Windows ActiveState Perl, using DOS shell
    • path separator is ;
    • The Windows system directory is required.
    • Use '\' not '/' in pathnames.
    • Typical setting is C:\windows\system32
  3. Windows Cygwin Perl
    • path separator is :
    • The Windows system directory is required.
    • Use '/' not '\' in pathnames.
    • Typical setting is /cygdrive/c/windows/system32
Show info
{OS}  
{OS} and {DetailedOS} are calculated in the Foswiki code. You should only need to override if there is something badly wrong with those calculations.
{OS} may be one of UNIX WINDOWS VMS DOS MACINTOSH OS2
Show info
{DetailedOS}  
The value of Perl $OS
Show info
{MaxLSCBackups} 
Changes to LocalSite.cfg will be backed up in /var/www/html/foswiki/lib/
Maximum number of backup versions of LocalSite.cfg to retain when changes are saved. Enables you to recover quickly from accidental changes. 0 does not save any backup versions. -1 does not limit the number of versions retained. Caution: If the directory is not writable and this parameter is non-zero, you will be unable to save the configuration.
Show info
Hide info textsShow info texts

Security and Authentication

1 warning

The above tabs allow you to control most aspects of how Foswiki handles security related activities.

Sessions

Sessions are how Foswiki tracks a user across multiple requests. A user's session id is stored in a cookie, and this is used to identify the user for each request they make to the server. You can use sessions even if you are not using login. This allows you to have persistent session variables - for example, skins. Client sessions are not required for logins to work, but Foswiki will not be able to remember logged-in users consistently. See User Authentication for a full discussion of the pros and cons of using persistent sessions.

{UseClientSessions} 
Control whether Foswiki will use persistent sessions.
Show info
{Sessions}{ExpireAfter} 
Set the session timeout, in seconds. The session will be cleared after this amount of time without the session being accessed. The default is 6 hours (21600 seconds).

Note By default, session expiry is done "on the fly" by the same processes used to serve Foswiki requests. As such it imposes a load on the server. When there are very large numbers of session files, this load can become significant. For best performance, you can set {Sessions}{ExpireAfter} to a negative number, which will mean that Foswiki won't try to clean up expired sessions using CGI processes. Instead you should use a cron job to clean up expired sessions. The standard maintenance cron script tools/tick_foswiki.pl includes this function.

Session files are stored in the {WorkingDir}/tmp directory.

This setting is also used to set a lifetime for passthru redirect requests.

Show info
{Sessions}{ExpireCookiesAfter} 
TemplateLogin only. Normally the cookie that remembers a user session is set to expire when the browser exits, but using this value you can make the cookie expire after a set number of seconds instead. If you set it then users will be able to tick a 'Remember me' box when logging in, and their session cookie will be remembered even if the browser exits.

This should always be the same as, or longer than, {Sessions}{ExpireAfter}, otherwise Foswiki may delete the session from its memory even though the cookie is still active.

A value of 0 will cause the cookie to expire when the browser exits. One month is roughly equal to 2600000 seconds.

Show info
{Sessions}{IDsInURLs} 
If you have persistent sessions enabled, then Foswiki will use a cookie in the browser to store the session ID. If the client has cookies disabled, then Foswiki will not be able to record the session. As a fallback, Foswiki can rewrite local URLs to pass the session ID as a parameter to the URL. This is a potential security risk, because it increases the chance of a session ID being stolen (accidentally or intentionally) by another user. If this is turned off, users with cookies disabled will have to re-authenticate for every secure page access (unless you are using {Sessions}{MapIP2SID}).
Show info
{Sessions}{UseIPMatching} 
It is possible to enable a check that the user trying to use a session is on the same IP address that was used when the session was created. This gives a small increase in security. Public web sites can easily be accessed by different users from the same IP address when they access through the same proxy gateway, meaning that the protection is limited. Additionally, people get more and more mobile using a mix of LAN, WLAN, and 3G modems and they will often change IP address several times per day. For these users IP matching causes the need to re-authenticate all the time. IP matching is therefore disabled by default and should only be enabled if you are sure the users IP address never changes during the lifetime of a session.
Show info
{Sessions}{MapIP2SID} 
For compatibility with older versions, Foswiki supports the mapping of the clients IP address to a session ID. You can only use this if all client IP addresses are known to be unique. If this option is enabled, Foswiki will not store cookies in the browser. The mapping is held in the file $Foswiki::cfg{WorkingDir}/tmp/ip2sid. If you turn this option on, you can safely turn {Sessions}{IDsInURLs} off.
Show info
{Session}{filePermission} 
File security for new session objects created by the login manager. You may have to adjust these permissions to allow (or deny) users other than the webserver user access session objects that Foswiki creates in the filesystem. This is an octal number representing the standard UNIX permissions (e.g. 0640 == rw-r-----)
Show info
{Sessions}{CookieRealm} 
By default the Foswiki session cookie is only accessible by the host which sets it. To change the scope of this cookie you can set this to any other value (ie. company.com). Make sure, Foswiki can access its own cookie.
If empty, this defaults to the current host.
Show info
{Validation}{Method} 

By default Foswiki uses Javascript to perform "double submission" validation of browser requests. This technique, called "strikeone", is highly recommended for the prevention of cross-site request forgery (CSRF). See also Why am I being asked to confirm?.

If Javascript is known not to be available in browsers that use the site, or cookies are disabled, but you still want validation of submissions, then you can fall back on a embedded-key validation technique that is less secure, but still offers some protection against CSRF. Both validation techniques rely on user verification of "suspicious" transactions.

This option allows you to select which validation technique will be used.
If it is set to "strikeone", or is undefined, 0, or the empty string, then double-submission using Javascript will be used.
If it is set to "embedded", then embedded validation keys will be used.
If it is set to "none", then no validation of posted requests will be performed.

Show info
{Validation}{ValidForTime} 
Validation keys are stored for a maximum of this amount of time before they are invalidated. Time in seconds.
Show info
{Validation}{MaxKeysPerSession} 
The maximum number of validation keys to store in a session. There is one key stored for each page rendered. If the number of keys exceeds this number, the oldest keys will be force-expired to bring the number down.
Show info
{Validation}{ExpireKeyOnUse} 
Expire a validation key immediately when it is used to validate the saving of a page. This protects against an attacker evesdropping the communication between browser and server and exploiting the keys sent from browser to server. If this is enabled and a user edits and saves a page, and then goes back to the edit screen using the browser back button and saves again, they will be met by a warning screen against "Suspicious request from browser". The same warning will be displayed if you build an application with pages containing multiple forms and users try to submit from these forms more than once. If this warning screen is a problem for your users, you can disable this setting which enables reuse of validation keys. However this will lower the level of security against cross-site request forgery.
Show info
Hide info textsShow info texts

Login

Foswiki supports different ways of handling how a user asks, or is asked, to log in.

{LoginManager} 
  1. none - Don't support logging in, all users have access to everything.
  2. Foswiki::LoginManager::TemplateLogin - Redirect to the login template, which asks for a username and password in a form. Does not cache the ID in the browser, so requires client sessions to work.
  3. Foswiki::LoginManager::ApacheLogin - Redirect to an '...auth' script for which Apache can be configured to ask for authorization information. Does not require client sessions, but works best with them enabled.
Show info
{Trace}{LoginManager} 
Write debugging output to the webserver error log.
Show info
{AuthScripts} 
Note:The Following scripts are open to unauthenticated users:
attach.pl, changes.pl, compare.pl, compareauth.pl, edit.pl, manage.pl, oops.pl, preview.pl, previewauth.pl, rdiff.pl, rdiffauth.pl, register.pl, rename.pl, resetpasswd.pl, rest.pl, restauth.pl, save.pl, search.pl, statistics.pl, upload.pl, view.pl, viewauth.pl, viewfile.pl, viewfileauth.pl
Comma-separated list of scripts in the bin directory that require the user to authenticate. This setting is used with TemplateLogin; any time an unauthenticated user attempts to access one of these scripts, they will be required to authenticate. With ApacheLogin, the web server must be configured to require a valid user for access to these scripts. edit and save should be removed from this list if the guest user is permitted to edit topics without authentication.
Show info
{Session}{AcceptUserPwParam} 
Regular expression matching the scripts that should be allowed to accept the username and password parameters other than the login script. Older versions of Foswiki would accept the username and password parameter on any script. The =login= and =logon= script will always accept the username and password, but only from POST requests. In order to add support for the rest and restauth>> scripts, specify ^(view|rest)(auth)?$/
Show info
{Session}{AcceptUserPwParamOnGET} 
For backwards compatibility, enable this setting if you want username and password parameters to be accepted on a GET request when provided as part of the query string. It is more secure to restrict login operations to POST requests only.
Show info
{TemplateLogin}{PreventBrowserRememberingPassword} 
Browsers typically remember your login and passwords to make authentication more convenient for users. If your Foswiki is used on public terminals, you can prevent this, forcing the user to enter the login and password every time.
Show info
{LoginNameFilterIn} 
The perl regular expression used to constrain user login names. Some environments may require funny characters in login names, such as \. This is a filter in expression i.e. a login name must match this expression or an error will be thrown and the login denied.
Show info
{DefaultUserLogin} 
Guest user's login name. You are recommended not to change this.
Show info
{DefaultUserWikiName} 
Guest user's wiki name. You are recommended not to change this.
Show info
{AdminUserLogin} 
An internal admin user login name (matched with the configure password, if set) which can be used as a temporary Admin login (see: Main.AdminUser). This login name is additionally required by the install script for some addons and plugins, usually to gain write access to the Foswiki web. If you change this you risk making topics uneditable.
Show info
{AdminUserWikiName} 
An admin user WikiName that is displayed for actions done by the AdminUserLogin You should normally not need to change this. (You will need to move the %USERSWEB%.AdminUser topic to match. Do not register a user with this name!) This is a special WikiName and should never be directly authenticated. It is accessed by logging in using the AdminUserLogin either directly or with the sudo login.
Show info
{SuperAdminGroup} 
Group of users that can use special action=repRev and action=delRev on save and ALWAYS have edit powers. See %SYSTEMWEB%.CompleteDocumentation for an explanation of wiki groups. This user will also run all the standard cron jobs, such as statistics and mail notification. The default value "AdminGroup" is used everywhere in Foswiki to protect important settings so you would need a really special reason to change this setting.
Show info
{UsersTopicName} 
Name of topic in the {UsersWebName} web where registered users are listed. Automatically maintained by the standard registration scripts. If you change this setting you will have to use Foswiki to manually rename the existing topic
Show info
{AuthRealm} 
Authentication realm. This is normally only used in md5 password encoding. You may need to change it if you are sharing a password file with another application.
Show info
{UserMappingManager} 
The user mapping is used to equate login names, used with external authentication systems, with Foswiki user identities. By default only two mappings are available, though other mappings *may* be installed to support authentication providers.
  1. Foswiki::Users::TopicUserMapping - uses Foswiki user and group topics to determine user information, and group memberships.
  2. Foswiki::Users::BaseUserMapping - has only pseudo users such as {AdminUser} and {DefaultUserWikiName}, with the Admins login and password being set from this configure script. Does not support User registration, and only works with TemplateLogin.
Show info
Hide info textsShow info texts

Passwords

The password manager handles the passwords database, and provides password lookup, and optionally password change, services to the rest of Foswiki.

{PasswordManager} 
Name of the password handler implementation. Foswiki ships with two alternative implementations:
  1. Foswiki::Users::HtPasswdUser - handles 'htpasswd' format files, with passwords encoded as per the HtpasswdEncoding
  2. Foswiki::Users::ApacheHtpasswdUser - should behave identically to HtpasswdUser for crypt encoding, but uses the CPAN:Apache::Htpasswd package to interact with Apache. It is shipped mainly as a demonstration of how to write a new password manager. It is not recommended for production.
You can provide your own alternative by implementing a new subclass of Foswiki::Users::Password, and pointing {PasswordManager} at it in lib/LocalSite.cfg.

If 'none' is selected, users will not be able to change passwords and TemplateLogin manager then will always succeed, regardless of what username or password they enter. This may be useful when you want to enable logins so Foswiki can identify contributors, but you don't care about passwords. Using ApacheLogin and PassordManager set to 'none' (and AllowLoginName = true) is a common Enterprise SSO configuration, in which any logged in user can then register to create their Foswiki Based identity.

Show info
{MinPasswordLength} 
Minimum length for a password, for new registrations and password changes. If you want to allow null passwords, set this to 0.
Show info
{Htpasswd}{FileName} 
Note: Expands to: /var/www/html/foswiki/data/.htpasswd
Path to the file that stores passwords, for the Foswiki::Users::HtPasswdUser password manager. You can use the htpasswd Apache program to create a new password file with the right encoding, however use caution, as it will remove email addresses from an existing file.
Show info
{Htpasswd}{LockFileName} 
Note: Expands to: /var/www/html/foswiki/working/htpasswd.lock
Path to the lockfile for the password file. This normally does not need to be changed however if two Foswiki installations share and update a common password file it is critical that both use the same lockfile. For example, change it to the location of the password file, $Foswiki::cfg{DataDir}/htpasswd.lock. Foswiki must have rights to create the file in this location. Only applicable to HtPasswdUser.
Show info
{Htpasswd}{GlobalCache} 
Enable this option on systems using FastCGI, FCGID, or Mod_Perl in order to avoid reading the for every transaction. It will cause the HtPasswdUser module to globally cache the password file, reading it only once on initization. Only applicable to HtPasswdUser.
Show info
{Htpasswd}{DetectModification} 
Enable this option if the .htpasswd file can be updated either external to Foswiki or by another Foswiki instance. When enabled, Foswiki will verify the timestamp of the file and will invalidate the cache if the file has been changed. This is only useful if Foswiki is running in a mod_perl or fcgi envinroment. Only applicable to HtPasswdUser.
Show info
{Htpasswd}{Encoding} 
Warning:
Crypt::Eksblowfish::Bcrypt:
Not installed. Required to use or autodetect: bcrypt encoding.
Crypt::PasswdMD5:
1.3 installed. Required to use or autodetect: apache-md5, crypt-md5 encoding.
Digest::MD5:
2.52 installed. Required to use or autodetect: htdigest-md5 encoding.
Digest::SHA:
5.84 installed. Required to use or autodetect: sha1 encoding.
Password encryption, for the Foswiki::Users::HtPasswdUser password manager. This specifies the type of password hash to generate when writing entries to .htpasswd It is also used when reading password entries unless the parameter {Htpasswd}{AutoDetect} is enabled.

The choices in order of strongest to lowest strength:
(HTTPS)
Any below encoding over an HTTPS SSL connection. (Not a selection here.)
htdigest-md5
Strongest only when combined with the Foswiki::LoginManager::ApacheLogin Useful on sites where password files are required to be portable. The {AuthRealm} value is used with the username and password to generate the hashed form of the password, thus: user:{AuthRealm}:hash. This encoding is generated by the Apache htdigest command.
bcrypt
Hash based upon blowfish algorithm, strength of hash controlled by a cost parameter. Not compatible with Apache Authentication
apache-md5
Enable an Apache-specific algorithm using an iterated (1,000 times) MD5 digest of various combinations of a random 32-bit salt and the password (userid:$apr1$salt$hash). This is the default. This is the encoding generated by the htpasswd -m command.
sha1
It has the strongest hash however does not use salt and is therefor more vulnerable to dictionary attacks. This is the encoding generated by the htpasswd -s command (userid:{SHA}hash).
crypt-md5
Enable use of standard libc (/etc/shadow) crypt-md5 password (like user:$1$salt$hash:email). Unlike crypt encoding, it does not suffer from password truncation. Passwords are salted, and the salt is stored in the encrypted password string as in normal crypt passwords. This encoding is understood by Apache but cannot be generated by the htpasswd command.
crypt
Not Recommended. crypt encoding only uses the first 8 characters of the password. Extra characters are silently discarded. This is the default generated by the Apache htpasswd command (user:hash:email)
plain
stores passwords as plain text (no encryption). Useful for testing. Not compatible with {AutoDetect} option.
If you need to create entries in .htpasswd before Foswiki is operational, you can use the htpasswd or htdigest Apache program to create a new password file with the correct encoding. Use caution however as these programs do not support the email addresses stored by Foswiki in the .htpasswd file.
Show info
{Htpasswd}{AutoDetect} 
Allow the Foswiki::Users::HtPasswdUserpassword check routines to auto-detect the stored encoding type. Enable this to allow migration from one encoding format to another format. Note that this does add a small overhead to the parsing of the .htpasswd file. Tests show approximately 1ms per 1000 entries. It should be used with caution unless you are using CGI acceleration such as FastCGI or mod_perl. This option is not compatible with plain text passwords.
Show info
{Htpasswd}{BCryptCost} 
Specify the cost that should be incured when computing the hash of a password. This number should be increased as CPU speeds increase. The iterations of the hash is roughly 2^cost - default is 8, or 256 iterations.
Show info
Hide info textsShow info texts

Registration

Registration is the process by which new users register themselves with Foswiki.

{Register}{AllowLoginName} 
If you want users to be able to use a login ID other than their wikiname, you need to turn this on. It controls whether the 'LoginName' box appears during the user registration process, and is used to tell the User Mapping module whether to map login names to wikinames or not (if it supports mappings, that is).
Show info
{Register}{EnableNewUserRegistration} 
Controls whether new user registration is available. It will have no effect on existing users.
Show info
{Register}{NeedVerification} 
Whether registrations must be verified by the user, by following a link sent in an email to the user's registered email address
Show info
{Register}{ExpireAfter} 
Set the pending registration timeout, in seconds. The pending registration will be cleared after this amount of time. The default is 6 hours (21600 seconds). This is only used if {Register}{NeedVerification} is enabled.

Note By default, registration expiry is done "on the fly" during the registration process. For best performance, you can set {Register}{ExpireAfter} to a negative number, which will mean that Foswiki won't try to clean up expired registrations durning registration. Instead you should use a cron job to clean up expired sessions. The standard maintenance cron script tools/tick_foswiki.pl includes this function.

Note that if you are using registration approval by 3rd party reviewers, this timer should most likely be significantly increased. 24 hours = 86400, 3 days = 259200.

Pending registration requests are stored in the {WorkingDir}/registration_approvals directory.

Show info
{Register}{DisablePasswordConfirmation} 
Controls whether the user password has to be entered twice on the registration page or not. The default is to require confirmation, in which case the same password must be provided in the Twk1Password and Twk1Confirm inputs.
Show info
{Register}{HidePasswd} 
Hide password in registration email to the user Note that Foswiki sends administrators a separate confirmation.
Show info
{Register}{RegistrationAgentWikiName} 
The internal user that creates user topics on new registrations. You are recommended not to change this.
Show info
{Register}{UniqueEmail} 
Normally users can register multiple WikiNames using the same email address. Enable this parameter to prevent multiple registrations using the same email address.
Show info
{Register}{EmailFilter} 
This regular expression can be used to block certain email addresses from being used for registering users. It can be used to block some of the more common wikispam bots. If this regex matches the entered address, the registration is rejected. For example:
^.*@(lease-a-seo\.com|paydayloans).*$
To block all domains and list only the permitted domains, use an expression of the format:
@(?!(example\.com|example\.net)$)
Show info
Hide info textsShow info texts

Environment

{AccessibleCFG} 
Array of the names of configuration items that are available when using %IF, %SEARCH and %QUERY{}%. Extensions can push into this array to extend the set. This is done as a filter in because while the bulk of configuration items are quite innocent, it's better to be a bit paranoid.
Show info
{INCLUDE}{AllowURLs} 
Allow %INCLUDE of URLs. This is disabled by default, because it is possible to mount a denial-of-service (DoS) attack on a Foswiki site using INCLUDE and URLs. Only enable it if you are in an environment where a DoS attack is not a high risk.

You may also need to configure the proxy settings ({PROXY}{HOST} and {PROXY}{PORT}) if your server is behind a firewall and you allow %INCLUDE of external webpages (see Proxies).

Show info
{AllowInlineScript} 
Used to disallow the use of SCRIPT and LITERAL tags in topics by removing them from the body of topics during rendering. This setting is fundamentally unsafe and is now DEPRECATED - use SafeWikiPlugin instead.
Show info
{RenderLoggedInButUnknownUsers} 
If a login name (or an internal user id) cannot be mapped to a wikiname, then the user is unknown. By default the user will be displayed using whatever identity is stored for them. For security reasons you may want to obscure this stored id by setting this option to true.
Show info
{DenyDotDotInclude} 
Remove .. from %INCLUDE{filename}%, to stop includes of relative paths.
Show info
{UploadFilter} 
Filter-in regex for uploaded (attached) file names. This is a filter in, so any files that match this filter will be renamed on upload to prevent upload of files with the same file extensions as executables.

NOTE: Be sure to update this list with any configuration or script filetypes that are automatically run by your web server.

Show info
{NameFilter} 
Filter-out regex for webnames, topic names, file attachment names, usernames, include paths and skin names. This is a filter out, so if any of the characters matched by this expression are seen in names, they will be removed.
Show info
{ForceUnsafeRegexes} 
If this is set, then the search module will use more relaxed rules governing regular expressions searches.
Show info
{GetScriptUrlFromCgi} 
Build the path to /foswiki/bin from the URL that was used to get this far. This can be useful when rewriting rules or redirection are used to shorten URLs. Note that displayed links are incorrect after failed authentication if this is set, so unless you really know what you are doing, leave it alone.
Show info
{DrainStdin} 
Draining STDIN may be necessary if the script is called due to a redirect and the original query was a POST. In this case the web server is waiting to write the POST data to this script's STDIN, but CGI.pm won't drain STDIN as it is seeing a GET because of the redirect, not a POST. Enable this only in case a Foswiki script hangs.
Show info
{RemovePortNumber} 
Remove port number from URL. If set, and a URL is given with a port number e.g. http://my.server.com:8080/foswiki/bin/view, this will strip off the port number before using the url in links.
Show info
{AllowRedirectUrl} 
Allow the use of URLs in the redirectto parameter to the save script, and in topic parameter to the view script. WARNING: Enabling this feature makes it very easy to build phishing pages using the wiki, so in general, public sites should not enable it. Note: It is possible to redirect to a topic regardless of this setting, such as topic=OtherTopic or redirectto=Web.OtherTopic. To enable redirection to a list of trusted URLs, keep this setting disabled and set the {PermittedRedirectHostUrls}.
Show info
{UsePathForRedirectCache} 
Some authentication systems do not allow parameters to be passed in the target URL to be redirected to after authentication. In this case, Foswiki can be configured to encode the address of the parameter cache in the path information of the URL. Note that if you are using Apache rewriting rules, this may not work.
Show info
{AccessibleENV} 
Defines the filter-in regexp that must match the names of environment variables that can be seen using the %ENV{}% macro. Set it to '^.*$' to allow all environment variables to be seen (not recommended).
Show info
Hide info textsShow info texts

Proxies

Some environments require outbound HTTP traffic to go through a proxy server. (e.g. http://proxy.your.company).
{PROXY}{HOST} 
Hostname or address of the proxy server. CAUTION This setting can be overridden by a PROXYHOST setting in SitePreferences. Make sure you delete the setting from there if you are using a SitePreferences topic from a previous release of Foswiki. If your proxy requires authentication, simply put it in the URL, as in: http://username:password@proxy.your.company.
Show info
{PROXY}{PORT} 
Some environments require outbound HTTP traffic to go through a proxy server. Set the port number here (e.g: 8080). CAUTION This setting can be overridden by a PROXYPORT setting in SitePreferences. Make sure you delete the setting from there if you are using a SitePreferences topic from a previous release of Foswiki.
Show info
Hide info textsShow info texts

Anti-spam

Foswiki incorporates some simple anti-spam measures to protect e-mail addresses and control the activities of benign robots. These should be enough to handle intranet requirements. Administrators of public (internet) sites are strongly recommended to install AntiWikiSpamPlugin

{AntiSpam}{EmailPadding} 
Text added to e-mail addresses to prevent spambots from grabbing addresses e.g. set to 'NOSPAM' to get fred@user.co.ru rendered as fred@user.coNOSPAM.ru
Show info
{AntiSpam}{HideUserDetails} 

Normally Foswiki stores the user's sensitive information (such as their e-mail address) in a database out of public view. This is to help prevent e-mail spam and identity fraud.

This setting controls whether or not the %USERINFO% macro will reveal details about users other than the current logged in user. It does not control how Foswiki actually stores email addresses.

If disclosure of emails is not a risk for you (e.g. you are behind a firewall) and you are happy for e-mails to be made public to all Foswiki users, then you can disable this option. If you prefer to store email addresses directly in user topics, see the TopicUserMapping expert setting under the UserMapping tab.

Note that if this option is set, then the user parameter to %USERINFO is ignored for non-admin users.

Show info
{AntiSpam}{EntityEncode} 
By default Foswiki will also manipulate e-mail addresses to reduce the harvesting of e-mail addresses. Foswiki will encode all non-alphanumeric characters to their HTML entity equivalent. e.g. @ becomes @ This is not completely effective, however it can prevent some primitive spambots from seeing the addresses. More advanced bots will still collect addresses.
Show info
{AntiSpam}{RobotsAreWelcome} 
By default, Foswiki doesn't do anything to stop robots, such as those used by search engines, from visiting "normal view" pages. If you disable this option, Foswiki will generate a META tag to tell robots not to index pages.
Inappropriate pages (like the raw and edit views) are always protected from being indexed.
Note that for full protection from robots you should also use robots.txt (there is an example in the root of your Foswiki installation).
Show info
Hide info textsShow info texts

Logging and Statistics

Logging

{Log}{Implementation} 
On busy systems with extremely large log files, the PlainFile logger can encounter issues when rotating the logs at the end of the month. The older Compatibility logger, or the new LogDispatchContrib are preferable on busy systems.
Foswiki supports different implementations of log files. It can be useful to be able to plug in a database implementation, for example, for a large site, or even provide your own custom logger. Select the implementation to be used here. Most sites should be OK with the PlainFile logger, which automatically rotates the logs every month.

Note that on very busy systems, this logfile rotation can be disruptive and the Compatibility logger might perform better.

The PlainFile::Obfuscating logger is identical to the PlainFile logger except that IP addresses are either obfuscated by replacing the IP Address with a MD5 Hash, or by completely masking it to x.x.x.x. If your regulatory domain prohibits tracking of IP Addresses, use the Obfuscating logger. Note that Authentication Errors are never obfuscated.

Note: the Foswiki 1.0 implementation of logfiles is still supported, through use of the Foswiki::Logger::Compatibility logger. Foswiki will automatically select the Compatibility logger if it detects a setting for {WarningFileName} in your LocalSite.cfg.

Show info
{Log}{Dir} 
Note: Expands to: /var/www/html/foswiki/working/logs
Directory where log files will be written. Note that the Compatibility Logger does not use this setting by default.
Show info
{Log}{Obfuscating}{MaskIP} 
The Obfuscating logger can either replace IP addresses with a hashed address that cannot be easily reversed to the original IP, or the IP address can be completely masked as x.x.x.x. Enable this parameter to replace The IP address with the literal string x.x.x.x.
Show info
{Log}{Action} 
Whether or not to log different actions in the events log. Information in the events log is used in gathering web statistics, and is useful as an audit trail of Foswiki activity. Actions not listed here will be logged by default. To disable logging of an action, add it to this list if not already present, and set value to 0.
Show info
{DebugFileName} 
Log file for debug messages when using the Compatibility logger. (Usually very low volume.) If %DATE% is included in the file name, it gets expanded to YYYYMM (year, month), causing a new log to be written each month.

To use the Compatibility logger, set this to a valid file path and name.
Foswiki 1.0.x default: $Foswiki::cfg{DataDir}/debug.txt
or Foswiki 1.1 logging directory $Foswiki::cfg{Log}{Dir}/debug%DATE%.txt

Show info
{WarningFileName} 
Log file for Warnings when using the Compatibility logger. (Usually low volume) If %DATE% is included in the file name, it gets expanded to YYYYMM (year, month), causing a new log to be written each month.

To use the Compatibility logger, set this to a valid file path and name.
Foswiki 1.0.x default: $Foswiki::cfg{DataDir}/warn%DATE%.txt
or Foswiki 1.1 logging directory $Foswiki::cfg{Log}{Dir}/warn%DATE%.txt

Show info
{LogFileName} 
This setting might be used by old plugins that have not been migrated to the Foswiki API. If not provided, Foswik core will provide a default setting of $Foswiki::cfg{WorkingDir}/logs/event.log.
It is not used by the PlainFile logger.
Log file recording web activity when using the Compatibility logger. (High volume). If %DATE% is included in the file name, it gets expanded to YYYYMM (year, month), causing a new log to be written each month.

To use the Compatibility logger, set this to a valid file path and name.

Foswiki 1.0.x default: $Foswiki::cfg{DataDir}/log%DATE%.txt
or Foswiki 1.1 logging directory $Foswiki::cfg{Log}{Dir}/log%DATE%.txt

Show info
Hide info textsShow info texts

Statistics

{Stats}{TopViews} 
Number of top viewed topics to show in statistics topic
Show info
{Stats}{TopContrib} 
Number of top contributors to show in statistics topic
Show info
{Stats}{AutoCreateTopic} 
Set this parameter to Allowed if you want the statistics script to create a missing WebStatistics topic only when the parameter autocreate=1 is supplied. Set it to Always if a missing WebStatistics topic should be created unless overridden by URL parameter 'autocreate=0'. Prohibited is the previous behavior and is the default.
Show info
{Stats}{StatisticsGroup} 
If this is set to the name of a Group, then the statistics script will only run for members of the specified and the AdminGroup. Ex. Set to AdminGroup to restrict statistics to administrators. Default is un-set. Anyone can run statistics.
Show info
{Stats}{TopicName} 
Name of statistics topic. Note: If you change the name of the statistics topic you must also rename the WebStatistics topic in each web, and the DefaultWebStatistics topic in the System web (and possibly in the Main web).
Show info
Hide info textsShow info texts

Internationalisation

Languages

{UserInterfaceInternationalisation} 
Locale::Maketext:
1.23 installed. I18N translations
Locale::Maketext::Lexicon:
0.98 installed. I18N translations
Locale::Msgfmt:
0.15 installed. I18N Language file compression
Encode:
2.49 installed. I18N conversions (core module in Perl 5.8)

Enable user interface internationalisation, i.e. presenting the user interface in the users own language(s). Some languages require the Locale::Maketext::Lexicon and Encode/MapUTF8 Perl modules to be installed.

Show info
{LanguageFileCompression} 

Enable compilation of .po string files into compressed .mo files. This can result in a significant performance improvement for I18N, but has also been reported to cause issues on some systems. So for now this is considered experimental. Note that if string files are being edited, it requires that configure be rerun to recompile modified files. Disable this option to prevent compling of string files. If disabled, stale <language>.mo files should be removed from the Foswiki locale directory so that the modified .po file will be used.

Show info
Hide info textsShow info texts

These settings control the languages that are available for the user interface. Check every language that you want your site to support.

Allowing all languages is the best for really international sites, but for best performance you should enable only the languages you really need. English is the default language, and is always enabled.

{LocalesDir} is used to find the languages supported in your installation, so if the list of available languages below is empty, it's probably because {LocalesDir} is pointing to the wrong place.

{Languages}{bg}{Enabled} 
{Languages}{cs}{Enabled} 
{Languages}{da}{Enabled} 
{Languages}{de}{Enabled} 
{Languages}{el}{Enabled} 
{Languages}{es}{Enabled} 
{Languages}{fi}{Enabled} 
{Languages}{fr}{Enabled} 
{Languages}{it}{Enabled} 
{Languages}{ja}{Enabled} 
{Languages}{ko}{Enabled} 
{Languages}{nl}{Enabled} 
{Languages}{no}{Enabled} 
{Languages}{pl}{Enabled} 
{Languages}{'pt-br'}{Enabled} 
{Languages}{pt}{Enabled} 
{Languages}{ro}{Enabled} 
{Languages}{ru}{Enabled} 
{Languages}{sv}{Enabled} 
{Languages}{tr}{Enabled} 
{Languages}{uk}{Enabled} 
{Languages}{'zh-cn'}{Enabled} 
{Languages}{'zh-tw'}{Enabled} 

Locale

Enable operating system level locales and internationalisation support for 8-bit character sets. This may be required for correct functioning of the programs that Foswiki calls when your wiki content uses international character sets.

{UseLocale} 
Enable the use of {Site}{Locale}.
Show info
{Site}{Locale} 
Site-wide locale - used by Foswiki and external programs such as grep, and to specify the character set in which content must be presented for the user's web browser.
Note that {Site}{Locale} is ignored unless {UseLocale} is set.
Locale names are not standardised. On Unix/Linux check 'locale -a' on your system to see which locales are supported by your system. You may also need to check what charsets your browsers accept - the 'preferred MIME names' at http://www.iana.org/assignments/character-sets are a good starting point.
WARNING: Topics are stored in site character set format, so data conversion of file names and contents will be needed if you change locales after creating topics whose names or contents include 8-bit characters.
Examples:
en.utf8 - English encoded using UTF8
en_US.ISO-8859-1 - US english with ISO-8859-1 encoding
de_AT.ISO-8859-15 - Austria with ISO-8859-15 for Euro
ru_RU.KOI8-R - Russian encoded using KOI8-R
ja_JP.eucjp - Japan
C - English only; no I18N features regarding character encodings and external programs.
Show info
{Site}{CharSet}  
Set this to match your chosen {Site}{Locale} (from 'locale -a') whose character set is not supported by your available perl conversion module (i.e. Encode for Perl 5.8 or higher, or Unicode::MapUTF8 for other Perl versions). For example, if the locale 'ja_JP.eucjp' exists on your system but only 'euc-jp' is supported by Unicode::MapUTF8, set this to 'euc-jp'. If you don't define it, it will automatically be defaulted to iso-8859-1
UTF-8 support is still considered experimental. Use the value 'utf-8' to try it.
Show info
{DisplayTimeValues} 
Set the timezone (this only effects the display of times, all internal storage is still in GMT). May be gmtime or servertimeA

This item is also used by configure to test if your perl supports early dates. Foswiki will still work fine on older versions of perl, but wiki applications that use dates somewhere prior to 1970 might encounter issues. 'configure' tests if 1901-01-01 is handled by the perl localtime function. Note, full support of early dates will not be available until Foswiki 1.2.

Show info
{DefaultDateFormat} 
Set the default format for dates. The traditional Foswiki format is '$day $month $year' (31 Dec 2007). The ISO format '$year-$mo-$day' (2007-12-31) is recommended for non English language Foswikis. Note that $mo is the month as a two digit number. $month is the three first letters of English name of the month
Show info
{Site}{LocaleRegexes} 
Disable to force explicit listing of national chars in regexes, rather than relying on locale-based regexes. Intended for Perl 5.6 or higher on platforms with broken locales: should only be disabled if you have locale problems.
Show info
{UpperNational} 
If a suitable working locale is not available (i.e. {UseLocale} is disabled), OR you are using Perl 5.005 (with or without working locales), OR {Site}{LocaleRegexes} is disabled, you can use WikiWords with accented national characters by putting any '8-bit' accented national characters within these strings - i.e. {UpperNational} should contain upper case non-ASCII letters. This is termed 'non-locale regexes' mode. If 'non-locale regexes' is in effect, WikiWord linking will work, but some features such as sorting of WikiWords in search results may not. These features depend on {UseLocale}, which can be set independently of {Site}{{LocaleRegexes}, so they will work with Perl 5.005 as long as {UseLocale} is set and you have working locales.
Show info
{LowerNational} 
Show info
{PluralToSingular} 
Change non-existent plural topic name to singular, e.g. TestPolicies to TestPolicy. Only works in English.
Show info
Hide info textsShow info texts

Store

Foswiki supports different back-end store implementations.

{Store}{Implementation} 
Store implementation.
  • RcsWrap uses normal RCS executables.
  • RcsLite uses a 100% Perl simplified implementation of RCS. RcsLite is useful if you don't have, and can't install, RCS - for example, on a hosted platform. It will work, and is compatible with RCS, but is not quite as fast.
Show info
{EnableHierarchicalWebs} 
Set to enable (hierarchical) sub-webs. Without this setting, Foswiki will only allow a single level of webs. If you set this, you can use multiple levels, like a directory tree, i.e. webs within webs.
Show info
{Store}{RememberChangesFor} 
Number of seconds to remember changes for. This doesn't affect revision histories, which always remember when a file changed. It only affects the number of changes that are cached for fast access by the 'changes' and 'statistics' scripts, and for use by extensions such as the change notification mailer. It should be no shorter than the interval between runs of these scripts.
Show info
{Store}{SearchAlgorithm} 
Foswiki RCS has two built-in search algorithms
  1. The default 'Forking' algorithm, which forks a subprocess that runs a 'grep' command and is recommended for Linux/Unix,
  2. The 'PurePerl' implementation, which is written in Perl and usually only used for native Windows installations where forking does not work stable because of limitations in length of command line
On Linux/Unix you will be just fine with the 'Forking' implementation. However if you find searches run very slowly, you may want to try a different algorithm, which may work better on your configuration. Forking may work OK also on Windows if you keep the directory path to Foswiki very short. Note that there is an alternative algorithm available from http://foswiki.org/Extensions/NativeSearchContrib , that often gives better performance with mod_perl and Speedy CGI.
Show info
{Store}{EgrepCmd} 
Full path to GNU-compatible egrep program. This is used for searching when {SearchAlgorithm} is 'Foswiki::Store::SearchAlgorithms::Forking'. %CS{|-i}% will be expanded to -i for case-sensitive search or to the empty string otherwise. Similarly for %DET, which controls whether matching lines are required. (see the documentation on these options with GNU grep for details).
Show info
{Store}{FgrepCmd} 
Full path to GNU-compatible fgrep program. This is used for searching when {SearchAlgorithm} is 'Foswiki::Store::SearchAlgorithms::Forking'.
Show info
{Store}{QueryAlgorithm} 
The standard Foswiki algorithm for performing queries is not particularly fast (it is based on plain-text searching). You may be able to select a different algorithm here, depending on what alternative implementations may have been installed.
Show info
{Store}{PrefsBackend} 
The algorithm used to store preferences. The default algorithm reads topics each time to access preferences. A caching algorithm that uses BerkeleyDB is also available from the PrefsCachePlugin. This algorithm is faster, but requires BerkeleyDB to be installed.
Show info
{RCS}{dirPermission} 
File security for new directories created by RCS stores. You may have to adjust these permissions to allow (or deny) users other than the webserver user access to directories that Foswiki creates. This is an octal number representing the standard UNIX permissions (e.g. 755 == rwxr-xr-x)
Show info
{RCS}{filePermission} 
File security for new files created by RCS stores. You may have to adjust these permissions to allow (or deny) users other than the webserver user access to files that Foswiki creates. This is an octal number representing the standard UNIX permissions (e.g. 644 == rw-r--r--)
Show info
{RCS}{AutoAttachPubFiles} 
Some file-based Store implementations (RcsWrap and RcsLite) store attachment meta-data separately from the actual attachments. This means that it is possible to have a file in an attachment directory that is not seen as an attachment by Foswiki. Sometimes it is desirable to be able to simply copy files into a directory and have them appear as attachments, and that's what this feature allows you to do. Considered experimental.
Show info
{RCS}{ExtOption} 
Specifies the extension to use on RCS files. Set to -x,v on windows, leave blank on other platforms.
Show info
{RCS}{asciiFileSuffixes} 
Perl regular expression matching suffixes valid on plain text files Defines which attachments will be treated as ASCII in RCS. This is a filter in, so any filenames that match this expression will be treated as ASCII.
Show info
{RCS}{coMustCopy} 
Set this if your RCS cannot check out using the -p option. May be needed in some windows installations (not required for cygwin)
Show info
{RCS}{initBinaryCmd} 
RcsWrap initialise a file as binary. %FILENAME|F% will be expanded to the filename.
Show info
{RCS}{initTextCmd} 
RcsWrap initialise a topic file.
Show info
{RCS}{tmpBinaryCmd} 
RcsWrap uses this on Windows to create temporary binary files during upload.
Show info
{RCS}{ciCmd} 
RcsWrap check-in. %USERNAME|S% will be expanded to the username. %COMMENT|U% will be expanded to the comment.
Show info
{RCS}{ciDateCmd} 
RcsWrap check in, forcing the date. %DATE|D% will be expanded to the date.
Show info
{RCS}{coCmd} 
RcsWrap check out. %REVISION|N% will be expanded to the revision number
Show info
{RCS}{histCmd} 
RcsWrap file history.
Show info
{RCS}{infoCmd} 
RcsWrap revision info about the file.
Show info
{RCS}{rlogDateCmd} 
RcsWrap revision info about the revision that existed at a given date. %REVISIONn|N% will be expanded to the revision number. %CONTEXT|N% will be expanded to the number of lines of context.
Show info
{RCS}{diffCmd} 
RcsWrap differences between two revisions.
Show info
{RCS}{lockCmd} 
RcsWrap lock a file.
Show info
{RCS}{unlockCmd} 
RcsWrap unlock a file.
Show info
{RCS}{breaklockCmd} 
RcsWrap break a file lock.
Show info
{RCS}{delRevCmd} 
RcsWrap delete a specific revision.
Show info
Hide info textsShow info texts

Tuning

HTTP Compression

Expert settings controlling compression of the generated HTML.

{HttpCompress} 
Enable gzip/deflate page compression. Modern browsers can uncompress content encoded using gzip compression. You will save a lot of bandwidth by compressing pages. This makes most sense when enabling page caching as well as these are stored in compressed format by default when {HttpCompress} is enabled. Note that only pages without any 'dirty areas' will be compressed. Any other page will be transmitted uncompressed.
Show info
Hide info textsShow info texts

HTML Page Layout

Expert setting controlling the layout of the generated HTML.

{MergeHeadAndScriptZones} 

{MergeHeadAndScriptZones} is provided to maintain compatibility with legacy extensions that use ADDTOHEAD to add <script> markup and require content that is now in the script zone.

Normally, dependencies between individual ADDTOZONE statements are resolved within each zone. However, if {MergeHeadAndScriptZones} is enabled, then head content which requires an id that only exists in script (and vice-versa) will be re-ordered to satisfy any dependency.

{MergeHeadAndScriptZones} will be removed from a future version of Foswiki.

Show info
Hide info textsShow info texts

Cache

Foswiki includes built-in support for caching HTML pages. This can dramatically increase performance, especially if there are a lot more page views than changes.

The cache has a number of setup and tuning parameters. You should read Page Caching on foswiki.org (or your local copy of this page in the System web) before enabling the cache. It is important that you read this topic carefully as the cache also has some major disadvantages with respect to formatted searches.
{Cache}{Enabled} 
This setting will switch on/off caching.
Show info
{Cache}{WebDependencies} 
List of those topics that have a manual dependency on every topic in a web. Web dependencies can also be specified using the WEBDEPENDENCIES preference, which overrides this setting.
Show info
{Cache}{DependencyFilter} 
Note: Expands to: System\..*|Trash\..*|.*Template$|TWiki\..*
Exclude topics that match this regular expression from the dependency tracker.
Show info
{CacheManager} 
Select the default caching mechanism. Note that individual subsystems might choose a different backend for their own purposes.
Show info
{MetaCacheManager} 
Select the database backend use to store meta data for the page cache.
Show info
{Cache}{RootDir} 
Note: Expands to: /var/www/html/foswiki/working/tmp/cache
Specify the root directory for CacheManagers that use file-system based storage. This is where the database files will be stored.
Show info
{Cache}{DBFile} 
Note: Expands to: /var/www/html/foswiki/working/tmp/foswiki_db
Specify the database file for the Foswiki::Cache::DB_File CacheManager
Show info
{Cache}{NameSpace} 
Note: Expands to: http://cd018141.ltl.uni-due.de
Specify the namespace used by this site in a store shared with other systems.
Show info
{Cache}{MaxSize} 
Specify the maximum number of cache entries for size-aware CacheManagers like MemoryLRU. This won't have any effect on other CacheManagers.
Show info
{Cache}{Servers} 
Specify a comma separated list of servers for distributed CacheManagers like Memcached. This setting won't have any effect on other CacheManagers.
Show info
Hide info textsShow info texts

Mail

Settings controlling if and how Foswiki sends email

Email general

Settings controlling if and how Foswiki handles email including the identity of the sender and other expert settings controlling the email process.

{EnableEmail} 
Enable email globally. Un-check this option to disable all outgoing email from Foswiki
Show info
{WebMasterEmail}  
Wiki administrator's e-mail address e.g. webmaster@example.com (used in %WIKIWEBMASTER%) NOTE: must be a single valid email address
Show info
{WebMasterName} 
Wiki administrator's name address, for use in mails (first name and last name, e.g. Fred Smith) (used in %WIKIWEBMASTERNAME%)
Show info
{Email}{Servertime} 
Send email Date header using local "server time" instead of GMT
Show info
{Email}{ValidTLD} 
This parameter is used to determine which Top Level domains are vaild when auto-linking email addresses. It is also used by UserRegistration to validate email addresses. Note, this parameter only controls matching of 3 character and longer TLDs. 2-character country codes and IP Address domains always permitted. See:
Valid TLD's at http://data.iana.org/TLD/tlds-alpha-by-domain.txt
Version 2012022300, Last Updated Thu Feb 23 15:07:02 2012 UTC
Show info
Hide info textsShow info texts

Email server

Settings to select the destination mail server or local email agent used for forwarding email.

{Email}{MailMethod}  
Net::SMTP:
2.31 installed. Required for SMTP Support
Net::SMTP::SSL:
1.01 installed. Required for SMTP over SSL
Select the method Foswiki will use for sending email. On Unix/Linux hosts "MailProgram" is generally acceptable. Otherwise choose one of the Email methods required by your ISP or Email server.
  • Net::SMTP sends in cleartext.
  • Net::SMTP::SSL sends using a secure encrypted connection.
Both of the above methods will perform authentication if a Username and password are provided below.
  • MailProgram uses the program configured below to send email. Authentication and encryption is done externally to Foswiki and the remainder of the below fields are not used.
Show info
{MailProgram} 
MailProgram is not used for the configued Email method: Net::SMTP
This needs to be a command-line program that accepts MIME format mail messages on standard input, and mails them.
Show info
{SMTP}{Debug} 
Set this option on to enable debug mode in SMTP. Output will go to the webserver error log.
Show info
{SMTP}{MAILHOST}  
Mail host for outgoing mail. This is only used if Net::SMTP is installed. Examples: mail.your.company If the smtp server uses a different port than the default 25 # use the syntax mail.your.company:portnumber

CAUTION This setting can be overridden by a setting of SMTPMAILHOST in SitePreferences. Make sure you delete that setting if you are using a SitePreferences topic from a previous release of Foswiki.

For Gmail, set MailMethod to Net::SMTP::SSL, set MAILHOST to smtp.gmail.com:465 and provide your gmail email address and password below for authentication.

Show info
{SMTP}{SENDERHOST}  
Mail domain sending mail, required if you are using Net::SMTP. SMTP requires that you identify the server sending mail. If not set, Net::SMTP will guess it for you. Example: foswiki.your.company. CAUTION This setting can be overridden by a setting of %SMTPSENDERHOST% in SitePreferences. Make sure you delete that setting.
Show info
{SMTP}{Username} 
Username for SMTP. Only required if your server requires authentication. If this is left blank, Foswiki will not attempt to authenticate the mail sender.
Show info
{SMTP}{Password} 
Password for your {SMTP}{Username}.
Show info
Hide info textsShow info texts

S/MIME

Configure signing of outgoing email. (Secure/Multipurpose Internet Mail Extensions) is a standard for public key encryption and signing of MIME encoded email messages. Messages generated by the server will be signed using an X.509 certificate.

{Email}{EnableSMIME} 
Crypt::SMIME:
Not installed. Required for S/MIME
Enable S/MIME signing.
Show info
{Email}{SmimeCertificateFile} 
Note: Expands to: /var/www/html/foswiki/data/cert.pem
Note: Can't read /var/www/html/foswiki/data/cert.pem
Secure email certificate. If you want e-mail sent by Foswiki to be signed, specify the filename of the administrator's X.509 certificate here. It must be in PEM format.
Show info
{Email}{SmimeKeyFile} 
Note: Expands to: /var/www/html/foswiki/data/key.pem
Note: Can't read /var/www/html/foswiki/data/key.pem
Secure email certificate. If you want e-mail sent by Foswiki to be signed, specify the filename of the administrator's X.509 private key here. It must be in PEM format. Be sure that this file is only readable by the Foswiki software; it must NOT be readable by users!
Show info
Hide info textsShow info texts

Email test

IMPORTANT: Verify your configuration before enabling email or testing user registration, before attempting to register any users to Foswiki.

You've made some changes! Consider saving them first. If you proceed, changes will be lost!


Caution: The test log will expose email usernames and passwords. They are not encrypted or obfuscated, and can be recovered from this log! Be careful if posting this log for debugging assistance! Especially the lines after the SMTP auth: Attempting authentication. They are not encrypted, but are reversably encoded.

This action will temporarily enable email along with the email debugging flag and will attempt to send an email to the admin email address. Errors will be reported back to the web interface instead of to the server logs.

Start test

Miscellaneous Expert

Miscellaneous expert options.

{SystemWebName} 
Name of the web where documentation and default preferences are held. If you change this setting, you must make sure the web exists and contains appropriate content, and upgrade scripts may no longer work (i.e. don't change it unless you are certain that you know what you are doing!)
Show info
{TrashWebName} 
Name of the web used as a trashcan (where deleted topics are moved) If you change this setting, you must make sure the web exists.
Show info
{SandboxWebName} 
Name of the web used as a scratchpad or temporary workarea for users to experiment with Foswiki topics.
Show info
{SitePrefsTopicName} 
Name of site-level preferences topic in the {SystemWebName} web. If you change this setting you will have to use Foswiki and *manually* rename the existing topic. (i.e. don't change it unless you are certain that you know what you are doing!)
Show info
{LocalSitePreferences} 
Web.TopicName of the site-level local preferences topic. If this topic exists, any settings in it will override settings in {SitePrefsTopicName}.
You are strongly recommended to keep all your local changes in a {LocalSitePreferences} topic rather than changing DefaultPreferences, as it will make upgrading a lot easier.
Show info
{HomeTopicName} 
Name of main topic in a web. If you change this setting you will have to use Foswiki to manually rename the topic in all existing webs (i.e. don't change it unless you are certain that you know what you are doing!)
Show info
{WebPrefsTopicName} 
Name of preferences topic in a web. If you change this setting you will have to use Foswiki to manually rename the topic in all existing webs (i.e. don't change it unless you are certain that you know what you are doing!)
Show info
{NotifyTopicName} 
Name of topic in each web that has notification registrations. If you change this setting you will have to use Foswiki to manually rename the topic in all existing webs
Show info
{UsersWebName} 
Name of the web where usertopics are stored. If you change this setting, you must make sure the web exists and contains appropriate content, and upgrade scripts may no longer work (i.e. don't change it unless you are certain that you know what you are doing!)
Show info
{TemplatePath} 
Note: Expands to:
  1. /var/www/html/foswiki/templates/$web/$name.$skin.tmpl
  2. /var/www/html/foswiki/templates/$name.$skin.tmpl
  3. $web.$skinSkin$nameTemplate
  4. System.$skinSkin$nameTemplate
  5. /var/www/html/foswiki/templates/$web/$name.tmpl
  6. /var/www/html/foswiki/templates/$name.tmpl
  7. $web.$nameTemplate
  8. System.$nameTemplate
A comma-separated list of generic file name templates, containing placeholders $name (the template name), $web (the web), and $skin (the skin(s)) standing in for part of the file name. This path is expanded to a sequence of file names. The first file on this list that is found is taken to be the requested template file. The file names can either be absolute file names ending in ".tmpl" or a topic name in a Foswiki web. See 'Security and usability' in System.SkinTemplates for advice on setting this path for increased security.
Show info
{LinkProtocolPattern} 
List of protocols (URI schemes) that Foswiki will automatically recognize in absolute links. Add any extra protocols specific to your environment (for example, you might add 'imap' or 'pop' if you are using shared mailboxes accessible through your browser, or 'tel' if you have a softphone setup that supports links using this URI scheme). A list of popular URI schemes can be found at http://en.wikipedia.org/wiki/URI_scheme.
Show info
{RequireCompatibleAnchors} 
'Anchors' are positions within a Foswiki page that can be targeted in a URL using the #anchor syntax. The format of these anchors has changed several times. If this option is set, Foswiki will generate extra redundant anchors that are compatible with the old formats. If it is not set, the links will still work but will go to the head of the target page. There is a small performance cost for enabling this option. Set it if your site has been around for a long time, and you want existing external links to the internals of pages to continue to work.
Show info
{NumberOfRevisions} 
How many links to other revisions to show in the bottom bar. 0 for all
Show info
{MaxRevisionsInADiff} 
Set the upper limit of the maximum number of difference that will be displayed when viewing the entire history of a page. The compared revisions will be evenly spaced across the history of the page e.g. if the page has 100 revisions and we have set this option to 10, we will see differences between r100 and r90, r90 and r80, r80 and r70 and so on.
Show info
{ReplaceIfEditedAgainWithin} 
If this is set to a > 0 value, and the revision control system supports it (RCS does), then if a second edit of the same topic is done by the same user within this number of seconds, a new revision of the topic will NOT be created (the top revision will be replaced). Set this to 0 if you want all topic changes to create a new revision (as required by most formal development processes).
Show info
{LeaseLength} 
When a topic is edited, the user takes a "lease" on that topic. If another user tries to also edit the topic while the lease is still active, they will get a warning. Leases are released automatically when the topic is saved; otherwise they remain active for {LeaseLength} seconds from when the edit started (or was checkpointed).

Note: Leases are not locks; they are purely advisory. Leases can always be broken, but they are valuable if you want to avoid merge conflicts (e.g. you use highly structured data in your topic text and want to avoid ever having to deal with conflicts)

Since Foswiki 1.0.6, Foswiki pages that can be used to POST to the server have a validation key, that must be sent to the server for the post to succeed. These validation keys can only be used once, and expire at the same time as the lease expires.

Show info
{LeaseLengthLessForceful} 
Even if the other users' lease has expired, then you can specify that they should still get a (less forceful) warning about the old lease for some additional time after the lease expired. You can set this to 0 to suppress these extra warnings completely, or to -1 so they are always issued, or to a number of seconds since the old lease expired.
Show info
{MimeTypesFileName} 
Note: Expands to: /var/www/html/foswiki/data/mime.types
Pathname to file that maps file suffixes to MIME types : For Apache server set this to Apache's mime.types file pathname, for example /etc/httpd/mime.types, or use the default shipped in the Foswiki data directory.
Show info
{WarningsAreErrors} 
If set, this will cause Foswiki to treat warnings as errors that will cause Foswiki to die. Provided for use by Plugin and Skin developers, who should develop with it switched on.
Show info
{DebugTracebacks} 
Enable tracebacks in configure error messages. Used for debugging;
Show info
Hide info textsShow info texts

Extensions

Extension operation and maintenance

  • Specify the plugin load order.
  • Use the Extensions Repository to add, update or remove plugins.
  • Enable and disable installed plugins.

Configure how plugins are loaded by Foswiki

{PluginsOrder} 
Plugins evaluation order. If set to a comma-separated list of plugin names, will change the execution order of plugins so the listed subset of plugins are executed first. The default execution order is alphabetical on plugin name.

If TWiki compatibility is required, TWikiCompatibilityPlugin should be the first Plugin in the list. SpreadSheetPlugin should typically be next in the list for proper operation.

Note that some other general extension environment checks are made and reported here. Plugins that are enabled but not installed and duplicate plugins in the TWiki and Foswiki libraries are reported here. Also if a TWiki plugin is enabled and the Foswik version is installed, this will also be reported here. Expand the "Expert" options to find these issues.
Show info
{Plugins}{WebSearchPath} 
Search path (web names) for plugin topics. Note that the current web is searched last, after this list. Most modern foswiki plugins do not use the plugin topic for settings, and this setting is ignored. It is recommended that this setting not be changed.
Show info
Hide info textsShow info texts

Install, Update or Remove extensions

{ExtensionsRepositories} 
Extensions Repositories Search List
Foswiki extension repositories are just Foswiki webs that are organised in the same way as the Extensions web on Foswiki.org. The 'Find more extensions' link above searches these repositories for installable extensions. To set up an extensions repository:
  1. Create a Foswiki web to contain the repository
  2. Copy the FastReport page from Foswiki:Extensions.FastReport to your new web
  3. Set the WEBFORMS preference in WebPreferences to PackageForm
The page for each extension must have the PackageForm (copy from Foswiki.org), and should have the packaged extension attached as a zip and/or tgz file.

The search list is a semicolon-separated list of repository specifications, each in the format: name=(listurl,puburl,username,password) where:

  • name is the symbolic name of the repository e.g. Foswiki.org
  • listurl is the root of a view URL
  • puburl is the root of a download URL
  • username is the username if TemplateAuth is required on the repository (optional)
  • password is the password if TemplateAuth is required on the repository (optional)
Note: if your Repository uses ApacheAuth, embed the username and password into the listurl as ?username=x;password=y

For example, twiki.org=(http://twiki.org/cgi-bin/view/Plugins/,http://twiki.org/p/pub/Plugins/); foswiki.org=(http://foswiki.org/Extensions/,http://foswiki.org/pub/Extensions/);

For Extensions with the same name in more than one repository, the last matching repository in the list will be chosen, so Foswiki.org should always be last in the list for maximum compatibility.

Show info
Hide info textsShow info texts
You made some changes! Consider saving them first. Otherwise click to Install, Update and Remove Extensions
If you have made any changes, consider saving them first. Install, Update and Remove Extensions

Enable or disable installed extensions

The plugins listed below were discovered by searching the @INC path for modules that match the Foswiki standard e.g. Foswiki/Plugins/MyPlugin.pm or the TWiki standard i.e. TWiki/Plugins/YourPlugin.pm Note that this list is only for Plugins. You cannot Enable/Disable Contribs, AddOns or Skins.

Any plugins enabled in the configuration but not found in the @INC path are listed at the end and are flagged as errors in the PluginsOrder check.

{Plugins}{AutoViewTemplatePlugin}{Enabled} 
{Plugins}{AutoViewTemplatePlugin}{Module} 
{Plugins}{CommentPlugin}{Enabled} 
{Plugins}{CommentPlugin}{Module} 
{Plugins}{CompareRevisionsAddonPlugin}{Enabled} 
{Plugins}{CompareRevisionsAddonPlugin}{Module} 
{Plugins}{EditTablePlugin}{Enabled} 
{Plugins}{EditTablePlugin}{Module} 
{Plugins}{HistoryPlugin}{Enabled} 
{Plugins}{HistoryPlugin}{Module} 
{Plugins}{InterwikiPlugin}{Enabled} 
{Plugins}{InterwikiPlugin}{Module} 
{Plugins}{JQueryPlugin}{Enabled} 
{Plugins}{JQueryPlugin}{Module} 
{Plugins}{MailerContribPlugin}{Enabled} 
This plugin is part of the MailerContrib, and must be enabled for mail notification from the browser to work
{Plugins}{MailerContribPlugin}{Module} 
{Plugins}{PatchFoswikiContribPlugin}{Enabled} 
{Plugins}{PatchFoswikiContribPlugin}{Module}  
{Plugins}{PreferencesPlugin}{Enabled} 
{Plugins}{PreferencesPlugin}{Module} 
{Plugins}{RenderListPlugin}{Enabled} 
{Plugins}{RenderListPlugin}{Module} 
{Plugins}{SlideShowPlugin}{Enabled} 
{Plugins}{SlideShowPlugin}{Module} 
{Plugins}{SmiliesPlugin}{Enabled} 
{Plugins}{SmiliesPlugin}{Module} 
{Plugins}{SpreadSheetPlugin}{Enabled} 
{Plugins}{SpreadSheetPlugin}{Module} 
{Plugins}{TablePlugin}{Enabled} 
{Plugins}{TablePlugin}{Module} 
{Plugins}{TinyMCEPlugin}{Enabled} 
{Plugins}{TinyMCEPlugin}{Module} 
{Plugins}{TWikiCompatibilityPlugin}{Enabled} 
{Plugins}{TWikiCompatibilityPlugin}{Module} 
{Plugins}{TwistyPlugin}{Enabled} 
{Plugins}{TwistyPlugin}{Module} 
{Plugins}{WysiwygPlugin}{Enabled} 
{Plugins}{WysiwygPlugin}{Module} 

JQueryPlugin

General settings

{JQueryPlugin}{Debug} 
This flag enables the debug mode for JQueryPlugin and all of its sub-modules. Instead of loading jquery.myplugin.js, it will load jquery.myplugin.uncompressed.js.
Show info
{JQueryPlugin}{MemoryCache} 
Enabling {MemoryCache} is an optimization flag useful when running Foswiki in a persistent perl environment (fast-cgi, mod_perl). If set, registration information of sub-modules are kept in memory between requests, thus speeding up the initialization phase.
Show info
{JQueryPlugin}{IconSearchPath} 
search path for JQICONs
Show info
{JQueryPlugin}{NoConflict} 
Enable this switch to prevent name conflicts with other javascript frameworks that use $. If enabled $ will be renamed to $j. To jQuery plugin authors: you should always wrap your plugins in a
(function($) { ... })(jQuery);
construct to make use of $ locally.
Show info
{JQueryPlugin}{DefaultPlugins} 
List of plugins loaded by default on any page. Note that you need at least the "migrate" plugin being loaded by default in case you are using a newer jQuery library. Starting with jquery-1.9.1 all deprecated methods have been removed from it and put into the "migrate" plugin.
Show info
{JQueryPlugin}{JQueryVersion} 
Note that starting with jQuery-1.9.1 deprecated features have been removed. If you are experiencing problems with plugins still using deprecated features then add the migrate plugin to the list of plugins loaded by default (see above). Further note that starting with jQuery-2.0 support for Internet Explorer 6/7/8 has been dropped. Use jQuery-1.9 in case you still need to cover these browsers.
Show info
{JQueryPlugin}{JQueryVersionForOldIEs} 
Use a different jQuery library for Internet Explorer 6/7/8. Since jQuery-2.0 these old browsers aren't suppored anymore. Use one of the jQuery-1.x libraries to still serve a compatible jQuery to these browsers. Or leave it empty to use the same library version for all browsers.
Show info
{JQueryPlugin}{JQueryTheme} 
Hide info textsShow info texts

Default themes

{JQueryPlugin}{Themes}{Base}{Enabled} 
{JQueryPlugin}{Themes}{Flickr}{Enabled} 
{JQueryPlugin}{Themes}{Lightness}{Enabled} 
{JQueryPlugin}{Themes}{Redmond}{Enabled} 
{JQueryPlugin}{Themes}{Smoothness}{Enabled} 
{JQueryPlugin}{Themes}{Foswiki}{Enabled} 

Default plugins

{JQueryPlugin}{Plugins}{Bgiframe}{Enabled} 
{JQueryPlugin}{Plugins}{Button}{Enabled} 
{JQueryPlugin}{Plugins}{BlockUI}{Enabled} 
{JQueryPlugin}{Plugins}{Chili}{Enabled} 
{JQueryPlugin}{Plugins}{Corner}{Enabled} 
{JQueryPlugin}{Plugins}{Cookie}{Enabled} 
{JQueryPlugin}{Plugins}{Cycle}{Enabled} 
{JQueryPlugin}{Plugins}{Debug}{Enabled} 
{JQueryPlugin}{Plugins}{Easing}{Enabled} 
{JQueryPlugin}{Plugins}{Farbtastic}{Enabled} 
{JQueryPlugin}{Plugins}{Focus}{Enabled} 
{JQueryPlugin}{Plugins}{Form}{Enabled} 
{JQueryPlugin}{Plugins}{Foswiki}{Enabled} 
{JQueryPlugin}{Plugins}{FluidFont}{Enabled} 
{JQueryPlugin}{Plugins}{Gradient}{Enabled} 
{JQueryPlugin}{Plugins}{HoverIntent}{Enabled} 
{JQueryPlugin}{Plugins}{InnerFade}{Enabled} 
{JQueryPlugin}{Plugins}{LiveQuery}{Enabled} 
{JQueryPlugin}{Plugins}{LocalScroll}{Enabled} 
{JQueryPlugin}{Plugins}{MaskedInput}{Enabled} 
{JQueryPlugin}{Plugins}{Masonry}{Enabled} 
{JQueryPlugin}{Plugins}{Media}{Enabled} 
{JQueryPlugin}{Plugins}{Metadata}{Enabled} 
{JQueryPlugin}{Plugins}{Migrate}{Enabled} 
{JQueryPlugin}{Plugins}{Placeholder}{Enabled} 
{JQueryPlugin}{Plugins}{PNotify}{Enabled} 
{JQueryPlugin}{Plugins}{PopUpWindow}{Enabled} 
{JQueryPlugin}{Plugins}{QueryObject}{Enabled} 
{JQueryPlugin}{Plugins}{Rating}{Enabled} 
{JQueryPlugin}{Plugins}{ScrollTo}{Enabled} 
{JQueryPlugin}{Plugins}{SerialScroll}{Enabled} 
{JQueryPlugin}{Plugins}{ShrinkUrls}{Enabled} 
{JQueryPlugin}{Plugins}{SimpleModal}{Enabled} 
{JQueryPlugin}{Plugins}{Slimbox}{Enabled} 
{JQueryPlugin}{Plugins}{Superfish}{Enabled} 
{JQueryPlugin}{Plugins}{Supersubs}{Enabled} 
{JQueryPlugin}{Plugins}{Tabpane}{Enabled} 
{JQueryPlugin}{Plugins}{TextboxList}{Enabled} 
{JQueryPlugin}{Plugins}{Tmpl}{Enabled} 
{JQueryPlugin}{Plugins}{Treeview}{Enabled} 
{JQueryPlugin}{Plugins}{UI}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Autocomplete'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Resizable'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Draggable'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Accordion'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Tabs'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Slider'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Dialog'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Button'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Datepicker'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Progressbar'}{Enabled} 
{JQueryPlugin}{Plugins}{'UI::Tooltip'}{Enabled} 
{JQueryPlugin}{Plugins}{Validate}{Enabled} 
{JQueryPlugin}{Plugins}{WikiWord}{Enabled} 
{JQueryPlugin}{Plugins}{Loader}{Enabled} 

Deprecated plugins

Any plugins listed here should be disabled. They will be removed in a future release of Foswiki. If enabled, they will be generate a Warning if deprecated, and an Error if the module has been removed from the Foswiki distribution.
{JQueryPlugin}{Plugins}{Autocomplete}{Enabled} 
Warning: this plugin is deprecated. Please use the autocomplete plugin part of the jQuery-ui package.
Show info
{JQueryPlugin}{Plugins}{Themeswitcher}{Enabled} 
{JQueryPlugin}{Plugins}{Tooltip}{Enabled} 
Warning: this plugin is deprecated. Please use the tooltip plugin part of the jQuery-ui package.
Show info
{JQueryPlugin}{Plugins}{Nifty}{Enabled} 
Warning: This plugin is deprecated. Use Corner instead
Show info
{JQueryPlugin}{Plugins}{Shake}{Enabled} 
Warning: This plugin is deprecated. The shake effect is now part of the latest jQuery-ui package.
Show info
Hide info textsShow info texts

Extra themes

{JQueryPlugin}{Themes}{PatternSkinTheme}{Url} 
{JQueryPlugin}{Themes}{PatternSkinTheme}{Enabled} 

TablePlugin

{Plugins}{TablePlugin}{DefaultAttributes} 
Default table attributes.
Show info
{Plugins}{TablePlugin}{Debug} 
Enable debugging (debug messages will be written to data/debug.txt)
Show info
Hide info textsShow info texts

TWikiCompatibilityPlugin

{Plugins}{TWikiCompatibilityPlugin}{TWikiWebTopicNameConversion} 
a hash mapping TWiki's TWiki web topics to Foswiki's topics
Show info
{Plugins}{TWikiCompatibilityPlugin}{MainWebTopicNameConversion} 
a hash mapping TWiki's Main web topics to Foswiki's topics
Show info
{Plugins}{TWikiCompatibilityPlugin}{WebSearchPath} 
Used by TWikiCompatibilityPlugin view and viewfile auto-compatibility. if a topic or attachment is not found in one web, it will try the other.
Show info
Hide info textsShow info texts

AutoViewTemplate settings

This is the configuration used by the AutoViewTemplatePlugin.
{Plugins}{AutoViewTemplatePlugin}{Debug} 
Turn on/off debugging in debug.txt
Show info
{Plugins}{AutoViewTemplatePlugin}{Override} 
Template defined by form overrides existing VIEW_TEMPLATE or EDIT_TEMPLATE settings
Show info
{Plugins}{AutoViewTemplatePlugin}{Mode} 
How to find the view or edit template. 'exist' means the template name is derived from the name of the form definition topic. 'section' means the template name is defined in a section in the form definition topic.
Show info
Hide info textsShow info texts

JSCalendarContrib

{JSCalendarContrib}{style} 
Style of the calendar
Show info
{JSCalendarContrib}{lang} 
Language of the calendar
Show info
{JSCalendarContrib}{format} 
Default format of the calendar
Show info
Hide info textsShow info texts

MailerContrib

{MailerContrib}{EmailFilterIn} 
Define the regular expression that an email address entered in WebNotify must match to be identified as a legal email by the notifier. You can use this expression to - for example - filter email addresses on your company domain, or even block use of raw emails in WebNotify altogether (just make it something that will never match, e.g. ^@@notAnEmail). If this is not defined, then the default setting of [A-Za-z0-9.+-_]+\@[A-Za-z0-9.-]+ is used.
Show info
{MailerContrib}{RemoveImgInMailnotify} 
Remove IMG tags in notification mails.
Show info
Hide info textsShow info texts

CompareRevisionsAddOn

{SwitchBoard}{compare} 
This setting is required to enable executing the compare script from the bin directory
Show info
{SwitchBoard}{compareauth} 
This setting is required when using ApacheLogin and the user needs to be authenticated when executing the compare script
Show info
Hide info textsShow info texts
Change Password:
Reset to the default value, which is:
VALUE
(click twice to undo)