<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<title>TWIG Administrators Manual - 4.1 config.inc.php3</title>
<meta name="Microsoft Border" content="tb, default">
</head>
<body><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td>
<table border="0" width="100%">
<tr>
<td width="50%" valign="bottom">
<h1>TWIG Administrators Manual</h1>
</td>
<td width="50%" valign="bottom"><img border="0" src="../images/twig.gif" align="right" width="153" height="75"></td>
</tr>
<tr>
<td width="50%" valign="bottom">
</td>
<td width="50%" valign="bottom"></td>
</tr>
<tr>
<td width="50%" valign="bottom">
Return to <a href="../index.html">Table of Contents</a>
</td>
<td width="50%" valign="bottom"></td>
</tr>
</table>
<hr>
</td></tr><!--msnavigation--></table><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><!--msnavigation--><td valign="top">
<h2>4.1 Configuration - config.inc.php3</h2>
<p> This file contains all of the primary configuration items for TWIG.<br>
<br>
Here is a list of the settings:<br>
</p>
<table border="0" width="112%">
<tr>
<td width="9%" colspan="3">
<h3>Primary Configuration Settings:</h3>
</td>
</tr>
<tr>
<td width="6%"> </td>
<td align="right" valign="top" nowrap>$config["brandname"]</td>
<td width="79%">This is the name used for the title bar.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["fromdomain"] </td>
<td width="79%">This is where mail will be sent from, usually this is the
domain name of your server.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["basedir"] </td>
<td width="79%">The path of the URL to your TWIG installation, usually /twig,
this is not a complete URL, only the path after the server name.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["imgdir"] </td>
<td width="79%">The path to graphics files, usually /twig/images.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["index"] </td>
<td width="79%">This is what you name the index file, usually index.php,
changing this may cause problems in future versions of twig and it is
therefore recommended that you do not alter this setting.</td>
</tr>
<tr>
<td width="6%"> </td>
<td align="right" valign="top" nowrap>$config["url_timestamp"]</td>
<td width="79%">Whether or not to include a timestamp in TWIG's URL's. TWIG
pages should not be cached by any standards compliant browser or cache.
Enable this only if you have a broken browser or cache that wants to cache
TWIG pages anyway.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["auth"]</td>
<td width="79%">Authorization Type, default to forms.
<p>basic authentication uses the http standard authentication mechanism to
retrieve a username and password from the user.</p>
<p>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.<p>secureform uses an HTML form to
authenticate the user. This form will force the user to use HTTPS to
submit the data with. Once the user is authenticated it will re-direct the
user back to HTTP.<br>
</td>
</tr>
<tr>
<td width="6%"> </td>
<td align="right" valign="top" nowrap>$config["use_https"]</td>
<td width="79%">This will force TWIG to use HTTPS, TWIG will redirect the
user to https://$config["basedir"] if it finds a connection on port 80
instead of port 443.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["auth_timeout"]</td>
<td width="79%">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.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["auth_logout_redirect"]</td>
<td width="79%">Set the page to redirect the user to after they have logged out of
TWIG.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["auth_provider"]</td>
<td width="79%">Authorization Method.
<table border="0" width="909">
<tr>
<td width="62"> imap</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider mirrors TWIG 1's login process, an IMAP<br>
server is connected to and a mailbox is opened each <br>
time a page is loaded.</td>
</tr>
<tr>
<td width="62">imap-new</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider differs from the original TWIG system by<br>
not opening the mailbox on the initial page load, but<br>
waits until the mailbox is required to open in. </td>
</tr>
<tr>
<td width="62"> sqltable</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider uses a sqltable (twig_accounts) to store<br>
users and passwords in, users must first be created in this<br>
table before they will be allowed to log in.<br>
<br>
This provider does not require an IMAP server to function.</td>
</tr>
<tr>
<td width="62"> mysql</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider connects to a MySQL server as the given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62"> pgsql</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider connects to a pgsql server as the given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62"> oracle</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider connects to a oracle server as the given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62"> sqlimap</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This is a combination of imap-new and sqltable, it first<br>
checks the sqltable for the user, if found it allows the user<br>
to log on. If not found then the imap server is contacted<br>
and checked. If the user is validated by the imap server <br>
then they are added to the sqltable so that next time the<br>
IMAP server will not be connected to untill need to by<br>
the mail module.</td>
</tr>
<tr>
<td width="62"> sqlopen</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider is based on sqltable but if the user is not<br>
found in the table, then the user is added to the table<br>
automatically, effectively giving open access to the server.</td>
</tr>
<tr>
<td width="62"> ldap</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"></td>
<td width="831"> This provider connects to an ldap server as then given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62"> nntp</td>
<td width="831"></td>
</tr>
<tr>
<td width="62"> </td>
<td width="831"> This provider connects to an nntp (news) server as then given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62">ibase</td>
<td width="831"> </td>
</tr>
<tr>
<td width="62"> </td>
<td width="831"> This provider connects to an Interbase server as
the given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62">imap-limit</td>
<td width="831"> </td>
</tr>
<tr>
<td width="62"> </td>
<td width="831"> This provider first verifies that the user is
listed in a sql<br>
table (same table as used for the sqlimap provider) and then <br>
verifies the user with the IMAP server. This effectively limits<br>
TWIG to only letting a subset of users to login to it.</td>
</tr>
<tr>
<td width="62">oracle</td>
<td width="831"> </td>
</tr>
<tr>
<td width="62"> </td>
<td width="831"> This provider connects to an Oracle server as
the given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
<tr>
<td width="62">pop3</td>
<td width="831"> </td>
</tr>
<tr>
<td width="62"> </td>
<td width="831"> This provider connects to a POP3 server with the
given<br>
username and password, if successful it allows the user on,<br>
otherwise they are rejected.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["security"]</td>
<td width="79%">Type of security to use.
<table border="0" width="100%">
<tr>
<td width="8%">basic</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">This allows certain functions of TWIG to be disabled on a system-wide basis.</td>
</tr>
<tr>
<td width="8%">advanced</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">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.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["groups"]</td>
<td width="79%">Type of group support to use.
<table border="0" width="100%">
<tr>
<td width="8%">none</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">No groups will be supported and the user will not be able to 'file' their items in anything but a single group that only they can see.</td>
</tr>
<tr>
<td width="8%">personal</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">This groups system allows for items to be filed into groups for purposes of organization, but does not allow for sharing of information.</td>
</tr>
<tr>
<td width="8%">standard</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">This is the traditional TWIG group support. Like 'personal', it allows for items to be filed into groups for purposes of organization. However, standard groups can also be shared with other users allowing them to view an modify that information.</td>
</tr>
<tr>
<td width="8%">userperms</td>
<td width="92%"></td>
</tr>
<tr>
<td width="8%"></td>
<td width="92%">Like 'standard', this group type allows items to be placed into groups for purposes of organization and allows those groups to be shared among multiple users. However, the userperms groups system allows different users to be given different levels of access to the information filed under those groups.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["session_handler"]</td>
<td width="79%">Session hanlder.
<table border="0" width="100%">
<tr>
<td width="16%">get</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is the traditional TWIG storage system of this information, in forms hidden fields are used, in links additional variables are added.</td>
</tr>
<tr>
<td width="16%">sqltable</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">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.</td>
</tr>
<tr>
<td width="16%">get2</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This method is similar to get except that it produces a much shorter and more human readable url.</td>
</tr>
<tr>
<td width="16%">php4session</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is a method that uses php4's built in session
handler to store the session information.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["session_expiry"]</td>
<td width="79%">How long session records are retained (in seconds)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["login_handler"]</td>
<td width="79%">Login handler
<table border="0" width="100%">
<tr>
<td width="16%">cookie</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is the traditional TWIG storage system of this information, username and passwords are stored as a
cookie.</td>
</tr>
<tr>
<td width="16%">sqltable</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is a method that uses sqltables to store the login information and only uses a reference pointer in a cookie.</td>
</tr>
base64cookie|php4session|session|securecookie.php4session|securecookie.sqltable)
<tr>
<td width="16%">session</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">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</td>
</tr>
<tr>
<td width="16%">base64cookie</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This method is similar to cookie except that it encodes the cookie information with a base64 method.</td>
</tr>
<tr>
<td width="16%">php4session</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is a method that uses php 4's built in session handler to store the login information.</td>
</tr>
<tr>
<td width="16%">securecookie.php4session</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is a method that 'splits' the login information between the client and server, only when the page is being loaded does the password become available and no information is retained after the page has finished. This handler uses php 4's built in session
handler to store the server side data.</td>
</tr>
<tr>
<td width="16%">securecookie.sqltable</td>
<td width="84%"></td>
</tr>
<tr>
<td width="16%"></td>
<td width="84%">This is a method that 'splits' the login information between the client and server, only when the page is being loaded does the password become available and no information is retained after the page has finished. This handler uses a sqltable to store the server side data and will work with php 3 or 4.</td>
</tr>
<tr>
<td width="16%">session</td>
<td width="84%"> </td>
</tr>
<tr>
<td width="16%"> </td>
<td width="84%">This login handler stores the username and password in
the<br>
session data in clear text. This handler should only be <br>
used for debugging purposes and is not secure.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["language"]</td>
<td width="79%">Language file to use by default (english)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["spellcheck"]</td>
<td width="79%">Command, including full path and flags to run a spell check
(via pipe)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap></td>
<td width="79%"></td>
</tr>
<tr>
<td width="6%" colspan="3"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>Date Display Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["timeformat"]["12"]</td>
<td width="79%">Format to display time in for 12 hour clocks (see <a href="http://www.php3.org/manual/function.date.php3">http://www.php3.org/manual/function.date.php3</a>
for details on the format).</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["timeformat"]["24"]</td>
<td width="79%">Format to display time in for 24 hour clocks (see <a href="http://www.php3.org/manual/function.date.php3">http://www.php3.org/manual/function.date.php3</a>
for details on the format).</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["longdateformat"]</td>
<td width="79%">Format to display long dates in (see <a href="http://www.php3.org/manual/function.date.php3">http://www.php3.org/manual/function.date.php3</a>
for details on the format).</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["shortdateformat"]</td>
<td width="79%">Format to display dates in (see <a href="http://www.php3.org/manual/function.date.php3">http://www.php3.org/manual/function.date.php3</a>
for details on the format).</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["firstdayweek"]</td>
<td width="79%">The day to start the week on, 0=sunday, 1=monday</td>
</tr>
<tr>
<td width="6%" colspan="3"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>IMAP Server Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["imap_servertype"]</td>
<td width="79%">IMAP Server type (php-imap|php-pop3)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["imap_server"]</td>
<td width="79%">IMAP Server Host (defaults to localhost)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["imap_port"]</td>
<td width="79%">IMAP Server Port (defaults to 143)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["imap_path"]</td>
<td width="79%">IMAP Mail Path (defaults to home dir)</td>
</tr>
<tr>
<td width="6%"> </td>
<td align="right" valign="top" nowrap>$config["mail_folder_delimiter"] </td>
<td width="79%">What delimiter to use to seperate mail folders in to a hiarchy ("/" for UofW IMAP, "." for Cyrus and Courier)</td>
hierarchy ("/" for UofW IMAP, "." for Cyrus and Courier)</td>
</tr>
<tr>
<td width="6%"> </td>
<td align="right" valign="top" nowrap>$config["inboxmax"]</td>
<td width="79%">Maximum recommended INBOX size (defaults to 10 MB)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["mailboxmax"]</td>
<td width="79%">Maximum recommended mailbox size (defaults to 30 MB)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap></td>
<td width="79%"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>SMTP Server Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["mail_sender"]</td>
<td width="79%">Which mail delivery mechanism to use, internal/relay/imap-mail?</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["smtp_server"] </td>
<td width="79%">SMTP Relay server to send mail through, can be localhost.</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["smtp_port"]</td>
<td width="79%">SMTP Relay server port to send mail through</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["smtp_clientip"]</td>
<td width="79%">If enabled, an additional header line will be added to record the originating IP address of the client</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap></td>
<td width="79%"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>NEWS Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["news_server"] </td>
<td width="79%">News Server Host (defaults to localhost)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$config["news_port"] </td>
<td width="79%">News Server Port (defaults to 119)</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap></td>
<td width="79%"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>VHosts Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$vhosts[<server_name>] </td>
<td width="79%">Setup support for virtual hosts, see the VHOSTS section for
details</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap></td>
<td width="79%"></td>
</tr>
<tr>
<td width="6%" colspan="3">
<h3>Disabled features Configuration:</h3>
</td>
</tr>
<tr>
<td width="6%"></td>
<td align="right" valign="top" nowrap>$disabled["mail_compose"]</td>
<td width="79%">Turns of the mail composing feature (see FAQ for complete
list of features that can be disabled)</td>
</tr>
</table>
<table border="0" width="112%" id="table1">
<tr>
<td width="6%" colspan="3">
<h3>Debug features Configuration:</h3>
</td>
</tr>
<tr>
<td width="1%"></td>
<td align="right" valign="top" nowrap>$config["debug"]</td>
<td width="82%">This controls the amount of debugging information that TWIG
displays on each of it's pages, for all production sites this should be set
to 0.
<p>Set to 10 view debugging output in some parts of TWIG.</p>
<p>Set to 20 to view more detailed info, but may conflict with cookie
setting, if you need this level you should set the login handler to sesssion.</p>
<p>Set to 30 to see lots of extra information that is typiclly useless :)</td>
</tr>
<tr>
<td width="1%"> </td>
<td align="right" valign="top" nowrap>$config["debug_users"]["<username>"]</td>
<td width="82%">This allows you to set a specific user to have debug
infomration displayed. This can be useful in production sites to eiher
have a single 'debug' user or to debug a specific users issues.<p>Remove the
'//' and replace '<username>' with a real username to set debug levels for a
specific user.</td>
</tr>
</table>
<!--msnavigation--></td></tr><!--msnavigation--></table><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td>
<hr>
<table border="0" width="911">
<tr>
<td width="418">
Return to <a href="../index.html">Table of Contents</a>
</td>
<td width="477" align="right">Return to <a href="#TOP">Top</a></td>
</tr>
</table>
</td></tr><!--msnavigation--></table></body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
207e45e785cb8f6362fd9cc8fe5acbc8
>
files
>
20
