General path settings
If you are a first-time installer; once you have set up the next
six paths below, your TWiki 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.
This is the root of all TWiki URLs e.g. http://myhost.com:123.
{DefaultUrlHost} δ
If your host has aliases (such as both www.twiki.org and twiki.org, and some IP addresses)
you need to list them to tell TWiki that redirecting to them is OK. TWiki uses redirection
as part of its normal mode of operation when it changes between editing and viewing.
The security setting {AllowRedirectUrl} is per default disabled making redirecting to other
domains restricted to prevent TWiki from being used in phishing attacks to protect it from
middleman exploits. You can add additional URLs to this setting to enable redirects to
additional trusted sites. Enter as comma separated list of URLs or hostnames. The URL must
be in the format http://your.domain.com.
{PermittedRedirectHostUrls}
This is the 'cgi-bin' part of URLs used to access the TWiki bin
directory e.g. /twiki/bin
Do not include a trailing /.
See http://twiki.org/cgi-bin/view/TWiki.ShorterUrlCookbook for more information on setting up
TWiki to use shorter script URLs.
{ScriptUrlPath} δ
Attachments URL path e.g. /twiki/pub
Security Note: files in this directory are *not*
protected by TWiki access controls. If you require access controls, you
will have to use webserver controls (e.g. .htaccess on Apache)
This is not set correctly if the link below is broken:Go to "pub" directory
{PubUrlPath} δ
Attachments store (file path, not URL), must match /twiki/pub e.g.
/usr/local/twiki/pub
{PubDir} δ
Template directory e.g. /usr/local/twiki/templates
{TemplateDir} δ
Topic files store (file path, not URL) e.g. /usr/local/twiki/data
{DataDir} δ
Translation files directory (file path, not URL) e.g. /usr/local/twiki/locales
{LocalesDir} δ
Directory where TWiki stores files that are required for the management
of TWiki, but are not normally 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 TWiki 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 TWiki registration process to store registrations that are pending
verification.
{WorkingDir} δ
Suffix of TWiki CGI scripts (e.g. .cgi or .pl). You may need to set this
if your webserver requires an extension.
{ScriptSuffix}δ
Security setup
Paths Path control. Overrides the default PATH setting to control
where TWiki 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 TWiki.
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
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
Windows Cygwin Perl
path separator is :
The Windows system directory is required.
Use '/' not '\' in pathnames.
Typical setting is /cygdrive/c/windows/system32
{SafeEnvPath} δ
Sessions You can use persistent CGI session tracking 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 TWiki will not
be able to remember logged-in users consistently.
See TWiki.TWikiUserAuthentication for a full discussion of the pros and
cons of using persistent sessions. Session files are stored in the
{WorkingDir}/tmp directory.
{UseClientSessions}
EXPERT 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 TWiki 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 TWiki 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_twiki.pl includes this function.
{Sessions}{ExpireAfter}
EXPERT 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 TWiki 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.
{Sessions}{ExpireCookiesAfter}
EXPERT If you have persistent sessions enabled, then TWiki will use a cookie in
the browser to store the session ID. If the client has cookies disabled,
then TWiki will not be able to record the session. As a fallback, TWiki
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}).
{Sessions}{IDsInURLs}
EXPERT It's important to check that the user trying to use a session is the
same user who originally created the session. TWiki does this by making
sure, before initializing a previously stored session, that the IP
address stored in the session matches the IP address of the user asking
for that session. Turn this off if a client IP address may change during
the lifetime of a session (unlikely)
{Sessions}{UseIPMatching}
EXPERT For compatibility with older versions, TWiki 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, TWiki will not store cookies in the
browser.
The mapping is held in the file $TWiki::cfg{WorkingDir}/tmp/ip2sid.
If you turn this option on, you can safely turn {Sessions}{IDsInURLs}
off .
{Sessions}{MapIP2SID}
Authentication TWiki supports different ways of responding when the user asks to log
in (or is asked to log in as the result of an access control fault).
They are:
none - Don't support logging in, all users have access to everything.
TWiki::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.
TWiki::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.
{LoginManager}
TWiki::LoginManager::TemplateLogin none TWiki::LoginManager::ApacheLogin
EXPERT Browsers typically remember your login and passwords to make authentication
more convenient for users. If your TWiki is used on public terminals, or other
you can prevent this, forcing the user to enter the login and password every time.
{TemplateLogin}{PreventBrowserRememberingPassword}
EXPERT 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.
{LoginNameFilterIn}
EXPERT Guest user's login name. You are recommended not to change this.
{DefaultUserLogin}
EXPERT Guest user's wiki name. You are recommended not to change this.
{DefaultUserWikiName}
EXPERT An internal admin user login name (matched with the configure password, if set)
which can be used as a temporary Admin login (see: Main.TWikiAdminUser).
This login name is additionally required by the install script for some addons
and plugins, usually to gain write access to the TWiki web.
If you change this you risk making topics uneditable.
{AdminUserLogin}
EXPERT An admin user WikiName what is displayed for actions done by the AdminUserLogin
You should normally not need to change this. (you will need to move the
%USERSWEB%.TWikiAdminUser topic to match)
{AdminUserWikiName}
EXPERT Group of users that can use special action=repRev and action=delRev
on =save= and ALWAYS have edit powers. See TWiki.TWikiDocumentation
for an explanation of twiki groups. This user will also run all the
standard cron jobs, such as statistics and mail notification.
The default value "TWikiAdminGroup" is used everywhere in TWiki to
protect important settings so you would need a really special reason to
change this setting.
{SuperAdminGroup}
EXPERT 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 TWiki to manually rename the existing topic
{UsersTopicName}
EXPERT Comma-separated list of scripts that require the user to authenticate.
With TemplateLogin, any time an unauthenticated user attempts to access
one of these scripts, they will be redirected to the login script. With
ApacheLogin, they will be redirected to the logon script (note
login and logon; they are different scripts). This approach means that
only the logon script needs to be specified as require valid-user when
using Apache authentication.
If you want finer access control (e.g. authorised users only in one web
but open access in another) then you should *clear* this list, and use
TWiki Permissions to control access. Users wishing to make changes will
have to log in by clicking a "log in" link instead of being automatically
redirected when they try to edit.
{AuthScripts}
EXPERT 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.
{AuthRealm}
User Mapping The user mapping is used to equate login names, used with external
authentication systems, with TWiki user identities. By default only
two mappings are available, though other mappings *may* be installed to
support authentication providers.
TWiki::Users::TWikiUserMapping - uses TWiki user and group topics to
determine user information, and group memberships.
TWiki::Users::BaseUserMapping - has only 2 users, {TWikiAdminUser} and
{TWikiGuestUser}, with the Admins login and password being set from this
configure script. Does not support User registration , and
only works with TemplateLogin.
{UserMappingManager}
TWiki::Users::TWikiUserMapping TWiki::Users::BaseUserMapping
Registration 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).
{Register}{AllowLoginName}
EXPERT 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.
{RenderLoggedInButUnknownUsers}
by turning this option off, you can temporarily disable new user registration.
it will have no effect on existing users.
{Register}{EnableNewUserRegistration}
EXPERT Hide password in registration email to the *user*
Note that TWiki sends admins a separate confirmation.
{Register}{HidePasswd}
Whether registrations must be verified by the user following
a link sent in an email to the user's registered email address
{Register}{NeedVerification}
Passwords Name of the password handler implementation. The password handler manages
the passwords database, and provides password lookup, and optionally
password change, services. TWiki ships with two alternative implementations:
TWiki::Users::HtPasswdUser - handles 'htpasswd' format files, with
passwords encoded as per the HtpasswdEncoding
TWiki::Users::ApacheHtpasswdUser - should behave identically to
HtpasswdUser, 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.
You can provide your own alternative by implementing a new subclass of
TWiki::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 TWiki 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 TWiki Based identity.
{PasswordManager}
TWiki::Users::HtPasswdUser none TWiki::Users::ApacheHtpasswdUser
Minimum length for a password, for new registrations and password changes.
If you want to allow null passwords, set this to 0.
{MinPasswordLength}
Path to the file that stores passwords, for the TWiki::Users::HtPasswdUser
password manager. You can use the htpasswd Apache program to create a new
password file with the right encoding.
{Htpasswd}{FileName}δ
Password encryption, for the TWiki::Users::HtPasswdUser password manager.
You can use the htpasswd Apache program to create a new
password file with the right encoding.
crypt is the default, and should be used on Linux/Unix.
sha1 is recommended for use on Windows.
md5 htdigest format - useful on sites where password files are required
to be portable. In this case, the {AuthRealm} is used with the username
and password to generate the encrypted form of the password, thus:
user:{AuthRealm}:password . Take note of this, because it means that
if the {AuthRealm} changes, any existing MD5 encoded passwords will be
invalidated by the change!
plain stores passwords as plain text (no encryption).
crypt-md5 Enable use of standard libc (/etc/shadow) crypt-md5 password (like $1$saltsalt$hashashhashhashhash...$) which are stronger than the crypt paswords, salted, and the salt is stored in the encrypted password string as in normal crypt passwords.
{Htpasswd}{Encoding}
crypt sha1 md5 plain crypt-md5
EXPERT {OS} and {DetailedOS} are calculated in the TWiki 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
{OS}
EXPERT The value of Perl $OS
{DetailedOS}
EXPERT Remove .. from %INCLUDE{filename}%, to stop includes
of relative paths.
{DenyDotDotInclude}
EXPERT
Allow %INCLUDE of URLs. This is disabled by default, because it is possible
to mount a denial-of-service (DoS) attack on a TWiki site using INCLUDE and
URLs. Only enable it if you are in an environment where a DoS attack is not
a high risk.
{INCLUDE}{AllowURLs}
EXPERT Allow the use of SCRIPT and LITERAL tags in content. If this is set false,
all SCRIPT and LITERAL sections will be removed from the body of topics.
SCRIPT can still be used in the HEAD section, though. Note that this may
prevent some plugins from functioning correctly.
{AllowInlineScript}
EXPERT 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.
{UploadFilter}
EXPERT Filter-out regex for webnames, topic 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.
{NameFilter}
EXPERT If this is set, the the search module will use more relaxed
rules governing regular expressions searches.
{ForceUnsafeRegexes}
EXPERT Build the path to /twiki/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.
{GetScriptUrlFromCgi}
EXPERT 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 TWiki script
hangs.
{DrainStdin}
EXPERT Remove port number from URL. If set, and a URL is given with a port
number e.g. http://my.server.com:8080/twiki/bin/view, this will strip
off the port number before using the url in links.
{RemovePortNumber}
EXPERT 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 just list of trusted URLs keep this setting
disabled and add a list of trusted URL to the {PermittedRedirectHostUrls}
setting in the General path settings section.
{AllowRedirectUrl}
EXPERT Defines the filter-in regexp that must match the names of environment
variables that can be seen using the %ENV{}% TWiki variable. Set it to
'^.*$' to allow all environment variables to be seen (not recommended).
{AccessibleENV}
Anti-spam measures
Log files
Localisation
Configuration items in this section control two things: recognition of
national (non-ascii) characters and the system locale used by TWiki, which
influences how programs TWiki and external programa called by it behave
regarding internationalization.
Note: for user interface internationalization, the only settings that
matter are {UserInterfaceInternationalisation}, which enables user interface
internationalisation, and {Site}{CharSet}, which controls which charset TWiki
will use for storing topics and displaying content for the users. As soon as
{UserInterfaceInternationalisation} is set and the required
(Locale::Maketext::Lexicon and Encode/MapUTF8 Perl
modules) are installed (see the CGI Setup section above), the
multi-language user interface will just work.
Enable user interface internationalisation, i.e. presenting the user
interface in the users own language.
Under {UserInterfaceInternationalisation}, check every language that you want
your site to support. This setting is only used when
{UserInterfaceInternationalisation} is enabled. If you disable all languages,
internationalisation will also be disabled, even if
{UserInterfaceInternationalisation} is enabled: internationalisation support
for no languages doesn't make any sense.
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 below is empty, it's probably because {LocalesDir} is pointing
to the wrong place.
{UserInterfaceInternationalisation}
Languages
{Languages}{ja}{Enabled}
{Languages}{sv}{Enabled}
{Languages}{ru}{Enabled}
{Languages}{pl}{Enabled}
{Languages}{'zh-cn'}{Enabled}
{Languages}{ko}{Enabled}
{Languages}{'zh-tw'}{Enabled}
{Languages}{es}{Enabled}
{Languages}{nl}{Enabled}
{Languages}{fi}{Enabled}
{Languages}{bg}{Enabled}
{Languages}{pt}{Enabled}
{Languages}{fr}{Enabled}
{Languages}{da}{Enabled}
{Languages}{cs}{Enabled}
{Languages}{uk}{Enabled}
{Languages}{de}{Enabled}
{Languages}{it}{Enabled}
Set the timezone (this only effects the display of times,
all internal storage is still in GMT). May be gmtime or servertime
{DisplayTimeValues}
gmtime servertime
Set the default format for dates. The traditional TWiki format is
'$day $month $year' (31 Dec 2007). The ISO format '$year-$mo-$day'
(2007-12-31) is recommended for non English language TWikis. Note that $mo
is the month as a two digit number. $month is the three first letters of
English name of the month
{DefaultDateFormat}
$year-$mo-$day $day $month $year $year/$mo/$day $year.$mo.$day
Locale - set to enable operating system level locales and
internationalisation support for 8-bit character sets
{UseLocale}
Site-wide locale - used by TWiki 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_US.ISO-8859-1 - Standard US ISO-8859-1 (default)
de_AT.ISO-8859-15 - Austria with ISO-8859-15 for Euro
ru_RU.KOI8-R - Russia
ja_JP.eucjp - Japan
C - English only; no I18N features regarding character
encodings and external programs.
UTF-8 locale like en_US.utf8 is still considered experimental
{Site}{Locale}
EXPERT 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.
{Site}{LocaleRegexes}
EXPERT 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.
{UpperNational}
EXPERT
{LowerNational}
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.
{Site}{CharSet}δ
EXPERT Change non-existant plural topic name to singular,
e.g. TestPolicies to TestPolicy. Only works in English.
{PluralToSingular}
Store settings
Default 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.
You can manually add options to LocalSite.cfg to select a
different store for each web. If $TWiki::cfg{Store}{Fred} is defined, it will
be taken as the name of a perl class (which must implement the methods of
TWiki::Store::RcsFile).
The TWiki::Store::Subversive class is an example implementation using the
Subversion version control system as a data store.
{StoreImpl}
RcsWrap RcsLite
EXPERT Specifies the extension to use on RCS files. Set to -x,v on windows, leave
blank on other platforms.
{RCS}{ExtOption}
File security for new directories. You may have to adjust these
permissions to allow (or deny) users other than the webserver user access
to directories that TWiki creates. This is an *octal* number
representing the standard UNIX permissions (e.g. 755 == rwxr-xr-x)
{RCS}{dirPermission}
File security for new files. You may have to adjust these
permissions to allow (or deny) users other than the webserver user access
to files that TWiki creates. This is an *octal* number
representing the standard UNIX permissions (e.g. 644 == rw-r--r--)
{RCS}{filePermission}
EXPERT Some file-based Store implementations (RcsWrap and RcsLite for
example) 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 TWiki. 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.
{AutoAttachPubFiles}
EXPERT Number of seconds to remember changes for. This doesn't affect revision
histories, which always remember the date a file change. 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.
{Store}{RememberChangesFor}
EXPERT 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.
{RCS}{asciiFileSuffixes}
EXPERT Set this if your RCS cannot check out using the -p option.
May be needed in some windows installations (not required for cygwin)
{RCS}{coMustCopy}
EXPERT RcsWrap initialise a file as binary.
%FILENAME|F% will be expanded to the filename.
{RCS}{initBinaryCmd}
EXPERT RcsWrap initialise a topic file.
{RCS}{initTextCmd}
EXPERT RcsWrap uses this on Windows to create temporary binary files during upload.
{RCS}{tmpBinaryCmd}
EXPERT RcsWrap check-in.
%USERNAME|S% will be expanded to the username.
%COMMENT|U% will be expanded to the comment.
{RCS}{ciCmd}
EXPERT RcsWrap check in, forcing the date.
%DATE|D% will be expanded to the date.
{RCS}{ciDateCmd}
EXPERT RcsWrap check out.
%REVISION|N% will be expanded to the revision number
{RCS}{coCmd}
EXPERT RcsWrap file history.
{RCS}{histCmd}
EXPERT RcsWrap revision info about the file.
{RCS}{infoCmd}
EXPERT 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.
{RCS}{rlogDateCmd}
EXPERT RcsWrap differences between two revisions.
{RCS}{diffCmd}
EXPERT RcsWrap lock a file.
{RCS}{lockCmd}
EXPERT RcsWrap unlock a file.
{RCS}{unlockCmd}
EXPERT RcsWrap break a file lock.
{RCS}{breaklockCmd}
EXPERT RcsWrap delete a specific revision.
{RCS}{delRevCmd}
EXPERT TWiki RCS has two built-in search algorithms
The default 'Forking' algorithm, which forks a subprocess that
runs a 'grep' command,
the 'PurePerl' implementation, which is written in Perl and
usually only used as a last resort.
Normally 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.
Note that there is an alternative algorithm available from
http://twiki.org/cgi-bin/view/Plugins/NativeSearchContrib, that often
gives better performance with mod_perl and Speedy CGI.
{RCS}{SearchAlgorithm}
EXPERT The standard TWiki 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.
{RCS}{QueryAlgorithm}
EXPERT Full path to GNU-compatible egrep program. This is used for searching when
{SearchAlgorithm} is 'TWiki::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).
{RCS}{EgrepCmd}
EXPERT Full path to GNU-compatible fgrep program. This is used for searching when
{SearchAlgorithm} is 'TWiki::Store::SearchAlgorithms::Forking'.
{RCS}{FgrepCmd}
Set to enable hierarchical webs. Without this setting, TWiki 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. See
TWiki.MultiLevelWikiWebs for more details.
{EnableHierarchicalWebs}
EXPERT 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!)
{SystemWebName}
EXPERT 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.
{TrashWebName}
EXPERT 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!)
{UsersWebName}
Mail and Proxies
Enable email globally.
{EnableEmail}
TWiki administrator's e-mail address e.g. webmaster@example.com
(used in %WIKIWEBMASTER%)
NOTE: must be a single valid email address
{WebMasterEmail}δ
TWiki administrator's name address, for use in mails (first name and
last name, e.g. =Fred Smith=) (used in %WIKIWEBMASTERNAME%)
{WebMasterName}
Mail program. If Net::SMTP is installed, it will be used in preference.
To force TWiki to use the {MailProgram}, unset both {SMTP}{MAILHOST}
below and all SMTPMAILHOST settings in your TWiki's Preferences topics.
This needs to be a command-line program that accepts
MIME format mail messages on standard input, and mails them.
To disable all outgoing email from TWiki leave both this field and the
MAILHOST field below blank.
{MailProgram}
Mail host for outgoing mail. This is only used if Net::SMTP is installed.
Examples: mail.your.company
CAUTION This setting can be overridden by a setting of SMTPMAILHOST
in TWikiPreferences. Make sure you delete that setting if you are using a
TWikiPreferences topic from a previous release of TWiki. To disable all
outgoing mail from TWiki leave both this field and the MailProgram field
above blank.
{SMTP}{MAILHOST}
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: twiki.your.company.
CAUTION This setting can be overridden by a setting of SMTPSENDERHOST
in TWikiPreferences. Make sure you delete that setting if you are using a
TWikiPreferences topic from a previous release of TWiki.
{SMTP}{SENDERHOST}
Username for SMTP. Only required if your server requires authentication. If
this is left blank, TWiki will not attempt to authenticate the mail sender.
{SMTP}{Username}
Password for your {SMTP}{Username}.
{SMTP}{Password}
EXPERT Remove IMG tags in notification mails.
{RemoveImgInMailnotify}
EXPERT Name of topic in each web that has notification registrations.
If you change this setting you will have to
use TWiki to manually rename the topic in all existing webs
{NotifyTopicName}
EXPERT Set this option on to enable debug
mode in SMTP. Output will go to the webserver error log.
{SMTP}{Debug}
EXPERT Some environments require outbound HTTP traffic to go through a proxy
server. (e.g. proxy.your.company).
CAUTION This setting can be overridden by a PROXYHOST setting
in TWikiPreferences. Make sure you delete the setting from there if
you are using a TWikiPreferences topic from a previous release of TWiki.
{PROXY}{HOST}
EXPERT 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 TWikiPreferences. Make sure you delete the setting from there if you
are using a TWikiPreferences topic from a previous release of TWiki.
{PROXY}{PORT}
EXPERT Domains excluded from proxy, such as
intra.example.com, bugs.example.com
{PROXY}{SkipProxyForDomains}
Miscellaneous settings
Number of top viewed topics to show in statistics topic
{Stats}{TopViews}
Number of top contributors to show in statistics topic
{Stats}{TopContrib}
EXPERT Name of statistics topic
{Stats}{TopicName}
EXPERT Template path. A comma-separated list of generic file names, containing
variables standing for part of the file name. When a template $name in $web
with $skin is requested, this path is instantiated into a sequence of file
names. The first file on this list that is found considered to be the
requested template file. The file names can either be absolute file names
ending in ".tmpl" or a topic file in a TWiki web.
{TemplatePath}δ
EXPERT List of protocols (URI schemes) that TWiki will
automatically recognize and activate if found in absolute links.
Additions you might find useful in your environment could be '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 .
{LinkProtocolPattern}
EXPERT Set to enable experimental mirror-site support. If this name is
different to MIRRORSITENAME, then this TWiki is assumed to be a
mirror of another. You are highly recommended not
to dabble with this experimental, undocumented, untested feature!
{SiteWebTopicName}
EXPERT Name of site-level preferences topic in the {SystemWebName} web.
If you change this setting you will have to
use TWiki and *manually* rename the existing topic.
(i.e. don't change it unless you are certain that you know what
you are doing!)
{SitePrefsTopicName}
EXPERT 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 TWikiPreferences,
as it will make upgrading a lot easier.
{LocalSitePreferences}
EXPERT Name of main topic in a web.
If you change this setting you will have to
use TWiki 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!)
{HomeTopicName}
EXPERT Name of preferences topic in a web.
If you change this setting you will have to
use TWiki 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!)
{WebPrefsTopicName}
EXPERT How many links to other revisions to show in the bottom bar. 0 for all
{NumberOfRevisions}
EXPERT 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).
{ReplaceIfEditedAgainWithin}
EXPERT 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)
{LeaseLength}
EXPERT 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.
{LeaseLengthLessForceful}
EXPERT 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 TWiki data directory.
{MimeTypesFileName}δ
EXPERT If set, this will cause TWiki to treat warnings as errors that will
cause TWiki to die. Provided for use by Plugin and Skin developers,
who should develop with it switched on.
{WarningsAreErrors}
Plugins
Extensions
Consult online extensions repositories for
new extensions. If you made any changes, save them first!
Find More Extensions
EXPERT Extensions Repositories Search List
TWiki extension repositories are just TWiki webs that are organised in the
same way as the Plugins web on TWiki.org. The 'Find more extensions' link
above searches these repositories for installable extensions. To set up an
extensions repository:
Create a TWiki web to contain the repository
Copy the FastReport page from TWiki:Plugins.FastReport to your new web
Copy the PackageForm page from TWiki:Plugins.PackageForm to your new web
Set the WEBFORMS variable in WebPreferences to PackageForm
The page for each extension must have the TWiki form PackageForm ,
and should have the packaged extension attached as a zip and/or
tgz file.
This setting is a semicolon-separated list of repository specifications, each in the format: name=(listurl,puburl) ,
where:
name is the symbolic name of the repository e.g. TWiki.org
listurl is the root of a view URL
puburl is the root of a download URL
For example,
twiki.org=(http://twiki.org/cgi-bin/view/Plugins/,http://twiki.org/p/pub/Plugins/);
wikiring.com=(http://wikiring.com/bin/view/Extensions/,http://wikiring.com/bin/viewfile/Extensions/)
{ExtensionsRepositories}
Mailer Contrib
JSCalendarContrib Settings
This is the configuration used by the JSCalendarContrib .
See also documentation at
TWiki:Plugins/JSCalendarContrib
and Mishoo's JS Calendar home .
Date format . Default: %Y-%m-%d. Available date specifiers:
%a - abbreviated weekday name
%A - full weekday name
%b - abbreviated month name
%B - full month name
%C - century number
%d - the day of the month ( 00 .. 31 )
%e - the day of the month ( 0 .. 31 )
%H - hour ( 00 .. 23 )
%I - hour ( 01 .. 12 )
%j - day of the year ( 000 .. 366 )
%k - hour ( 0 .. 23 )
%l - hour ( 1 .. 12 )
%m - month ( 01 .. 12 )
%M - minute ( 00 .. 59 )
%n - a newline character
%p - "PM" or "AM"
%P - "pm" or "am"
%S - second ( 00 .. 59 )
%s - number of seconds since Epoch
%t - a tab character
%U, %W, %V - the week number
%u - the day of the week ( 1 .. 7, 1 = MON )
%w - the day of the week ( 0 .. 6, 0 = SUN )
%y - year without the century ( 00 .. 99 )
%Y - year including the century ( ex. 1979 )
%% - a literal % character
{JSCalendarContrib}{format}
Interface language . Default: en. Available: af, al, bg, big5, big5-utf8, br, ca,
cn_utf8, cs-utf8, cs-win, da, de, du, el, en, es, fi, fr, he-utf8, hr, hr-utf8, hu,
it, jp, ko, ko-utf8, lt, lt-utf8, lv, nl, no, pl, pl-utf8, pt, ro, ru, ru_win_,
si, sk, sp, sv, tr, zh.
{JSCalendarContrib}{lang}
Style . Default: blue. Available: blue, blue2, brown, green, system, tas, win2k-1,
win2k-2, win2k-cold-1, win2k-cold-2.
{JSCalendarContrib}{style}