This file contains all of the primary configuration items for TWIG.
Here is a list of the settings:
Primary Configuration Settings:
|
|
$config["fromdomain"] |
This is where mail will be sent from, usually this is the
domain name of your server. |
|
$config["basedir"] |
The path of the URL to your TWIG installation, usually /twig,
this is not a complete URL, only the path after the server name. |
|
$config["imgdir"] |
The path to graphics files, usually /twig/images. |
|
$config["index"] |
This is what you name the index file, usually index.php3,
changing this may cause problems in future versions of twig and it is
therefore recommended that you do not alter this setting. |
|
$config["auth"] |
Authorization Type, default to forms.
basic authentication uses the http standard authentication mechanism to
retrieve a username and password from the user.
forms authentication uses an HTML form (contained in
login.header.inc.php3, login.form.inc.php3 and login.footer.inc.php3) to retrieve
a username and password from the user. This method is the preferred
method due to its ability to properly log out a user, basic auth does not
properly support his functionality. |
|
$config["auth_timeout"] |
Set the auth timeout value in seconds (1800sec = 30min),
this will 'expire' a user if they have not reloaded a page in the
specified time. |
|
$config["auth_provider"] |
Authorization Method.
imap |
|
|
This provider mirrors TWIG 1's login process, an IMAP
server is connected to and a mailbox is opened each
time a page is loaded. |
imap-new |
|
|
This provider differes from the orginal TWIG system by
not opening the mailbox on the inital page load, but
waits until the mailbox is required to open in. |
sqltable |
|
|
This provider uses a sqltable (twig_accounts) to store
users and passwords in, users must first be created in this
table before they will be allowed to log in.
This provider does not require an IMAP server to function. |
mysql |
|
|
This provider connects to a MySQL server as then given
username and password, if successful it allows the user on,
otherwise they are rejected. |
pgsql |
|
|
This provider connects to a pgsql server as then given
username and password, if successful it allows the user on,
otherwise they are rejected. |
sqlimap |
|
|
This is a comibination of imap-new and sqltable, it first
checks the sqltable for the user, if found it allows the user
to log on. If not found then the imap server is contacted
and checked. If the user is validated by the imap server
then they are added to the sqltable so that next time the
IMAP server will not be connected to untill need to by
the mail module. |
sqlopen |
|
|
This provider is based on sqltable but if the user is not
found in the table, then the user is added to the table
automaticly, effecitivly giving open access to the server. |
ldap |
|
|
This provider connects to an ldap server as then given
username and password, if successful it allows the user on,
otherwise they are rejected. |
nntp |
|
|
This provider connects to an nntp (news) server as then given
username and password, if successful it allows the user on,
otherwise they are rejected. |
|
|
$config["security"] |
Type of security to use.
basic |
|
|
This basicly denies access to everything. |
advanced |
|
|
This is a full blown ACL based security system that in future versions of TWIG will be used to control much of the functionality of TWIG on an administrative level. |
|
|
$config["groups"] |
Type of group support to use.
none |
|
|
This basicly disables group support, allowing for only one group to be used: ALL. |
standard |
|
|
This is the traditional TWIG group support. |
|
|
$config["session_handler"] |
Session hanlder.
get |
|
|
This is the traditional TWIG storage system of this information, in forms hidden fields are used, in links additional variables are added. |
sqltable |
|
|
This is a method that uses sqltables to store the session information and only uses a reference pointer on the url or in the forms. |
|
|
$config["session_expiry"] |
How long session records are retained (in seconds) |
|
$config["login_handler"] |
Login handler
cookie |
|
|
This is the traniditonal TWIG storage system of this information, username and passwords are stored as a
cookie. |
sqltable |
|
|
This is a method that uses sqltables to store the login information and only uses a reference pointer in a cookie. |
session |
|
|
This is a method that uses stores the login information in the session data store, this should only be used with the sqltable session handler and is less secure than the other system |
|
|
$config["language"] |
Language file to use by default (english) |
|
$config["spellcheck"] |
Command, including full path and flags to run a spellcheck
(via pipe) |
|
|
|
Color Configuration:
|
|
$config["cellcolor"] |
Background color of certain cells |
|
$config["cellcoloralt"] |
Alternate background color of mail list cells |
|
$config["celltext"] |
Text color inside those cells |
|
$config["cellheadcolor"] |
Background color of header cells |
|
$config["cellheadtext"] |
Text color inside those cells |
|
$config["cellfont"] |
Font of text inside those cells |
|
Date Display Configuration:
|
|
$config["timeformat"] |
Format to display time in (see http://www.php3.org/manual/function.date.php3
for details on the format). |
|
$config["longdateformat"] |
Format to display long dates in (see http://www.php3.org/manual/function.date.php3
for details on the format). |
|
$config["shortdateformat"] |
Format to display dates in (see http://www.php3.org/manual/function.date.php3
for details on the format). |
|
Menu Display Styles
|
|
$config["MenuType"] |
Format to display the main menu in. |
|
$config["SubMenuType"] |
Format to display the sub menus in |
|
$config["PrevNextType"] |
Format to display the Previous/Next Lists in. |
|
|
|
IMAP Server Configuration:
|
|
$config["imap_server"] |
IMAP Server Host (defaults to localhost) |
|
$config["imap_port"] |
IMAP Server Port (defaults to 143) |
|
$config["imap_path"] |
IMAP Mail Path (defaults to home dir) |
|
$config["imap_sentfolder"] |
IMAP folder to hold sent messages (defaults to sent-mail) |
|
$config["imap_cyrus"] |
Is IMAP server Cyrus? (1=yes, 0=no) |
|
|
|
SMTP Server Configuration:
|
|
$config["smtp_relay"] |
Do we use a SMTP relay server? |
|
$config["smtp_server"] |
SMTP Relay server to send mail through, can be localhost. |
|
$config["smtp_port"] |
SMTP Relay server port to send mail through |
|
|
|
NEWS Configuration:
|
|
$config["news_server"] |
News Server Host (defaults to localhost) |
|
$config["news_port"] |
News Server Port (defaults to 119) |
|
$config["news_articles"] |
Default max number of headers to retrieve at once |
|
|
|
VHosts Configuration:
|
|
$vhosts[<server_name>] |
Setup support for virtual hosts, see the VHOSTS section for
details |
|
|
|
Disabled features Configuration:
|
|
$disabled["compose"] |
Turns of the mail composing feature (see FAQ for complete
list of features that can be disabled) |