Location: PHPKode > projects > phpBugTracker > docs/html/configuration.html
<HTML
><HEAD
><TITLE
>Configuration Options</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="phpBugTracker"
HREF="index.html"><LINK
REL="UP"
TITLE="Administrator's Guide"
HREF="adminguide.html"><LINK
REL="PREVIOUS"
TITLE="Installation Instructions"
HREF="installation.html"><LINK
REL="NEXT"
TITLE="Developer's Guide"
HREF="devguide.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="docs.css"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#800080"
ALINK="#FF0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>phpBugTracker</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="installation.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 2. Administrator's Guide</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="devguide.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONFIGURATION">2.3. Configuration Options</H1
><BLOCKQUOTE
CLASS="ABSTRACT"
><DIV
CLASS="ABSTRACT"
><A
NAME="AEN139"><P
>Most of the options listed here can be configured via the Configuration page of the admin tools.  The <TT
CLASS="VARNAME"
>DB_</TT
> options can be found in <TT
CLASS="FILENAME"
>config.php</TT
> and are specified during the installation process via the installation web page.</P
></DIV
></BLOCKQUOTE
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>INSTALL_URL</DT
><DD
><P
>URL that is the home of the installation.</P
></DD
><DT
>CVS_WEB</DT
><DD
><P
>Location of your cvs web interface (see <TT
CLASS="FUNCTION"
>format_comments()</TT
> in <TT
CLASS="FILENAME"
>bug.php</TT
>).  This is for links to files in CVS generated from the comments attached to bugs.</P
></DD
><DT
>DB_TYPE</DT
><DD
><P
>The type of database server you are using, according to PEAR's naming convention.  Possible choices are fbsql, ibase, ifx, msql, mssql, mysql, oci8, odbc, pgsql, and sybase.  Note that only MySQL, PostgreSQL and Oracle 8 have been tested with phpBugTracker</P
></DD
><DT
>DB_HOST</DT
><DD
><P
>The hostname of the database server.</P
></DD
><DT
>DB_DATABASE</DT
><DD
><P
>The name of the database to be used.</P
></DD
><DT
>DB_USER</DT
><DD
><P
>Username to use for connecting to the database.</P
></DD
><DT
>DB_PASSWORD</DT
><DD
><P
>The password to use for connecting to the database.</P
></DD
><DT
>ADMIN_EMAIL</DT
><DD
><P
>The email address that will be used for all correspondence to and from the bug tracker.</P
></DD
><DT
>ENCRYPT_PASS</DT
><DD
><P
>When true, passwords will be stored as an <TT
CLASS="FUNCTION"
>md5()</TT
> hash in the database.  When false, they will be stored as plaintext.</P
><P
>If this is set to true, a new password will be generated for users if they request their password to be emailed to them, as the encryption is not reversible.</P
></DD
><DT
>THEME</DT
><DD
><P
>The directory below the <TT
CLASS="FILENAME"
>templates</TT
> directory (both in the top directory and the <TT
CLASS="FILENAME"
>admin</TT
> directory) where the <SPAN
CLASS="ACRONYM"
>HTML</SPAN
> template files are located.  This makes it easy to wrap the bug tracker in a completely different look.</P
></DD
><DT
>STYLE</DT
><DD
><P
>The CSS file to be used from the <TT
CLASS="FILENAME"
>styles</TT
> directory.  This makes it easy to change the color scheme and other CSS properties.</P
></DD
><DT
>USE_JPGRAPH</DT
><DD
><P
>Whether to use the <A
HREF="http://www.aditus.nu/jpgraph/"
TARGET="_top"
>JpGraph</A
> graphing class for some reports.</P
></DD
><DT
>MASK_EMAIL</DT
><DD
><P
>If true, then email addresses will be shown as <TT
CLASS="COMPUTEROUTPUT"
>example at example dot com</TT
>.  Otherwise, email addresses will be shown as <TT
CLASS="COMPUTEROUTPUT"
>hide@address.com</TT
>.</P
></DD
><DT
>HIDE_EMAIL</DT
><DD
><P
>If true, email addresses will be shown as <TT
CLASS="COMPUTEROUTPUT"
>******</TT
> to users who are not logged in (to help avoid spam bots on public bug trackers).  If false, email addresses will be shown according the setting of <TT
CLASS="VARNAME"
>MASK_EMAIL</TT
>, above.</P
></DD
><DT
>USE_SEVERITY_COLOR</DT
><DD
><P
>Whether to color the rows of the bug list according to the severity of the bugs.  The severity colors can be set via the admin interface.  If this is false, the bugs will be listed with alternating background colors of white and gray.</P
></DD
><DT
>EMAIL_IS_LOGIN</DT
><DD
><P
>If true, then users login with their email address, and the email address is shown for fields such as Assigned To and Reported By.  If false, the login is not tied to the user's email address.</P
></DD
><DT
>STRICT_UPDATING</DT
><DD
><P
>If set to true, the only people who can make changes to a bug are the reporter, the owner, and those with manager or admin permissions.</P
></DD
><DT
>NEW_ACCOUNTS_DISABLED</DT
><DD
><P
>If set to true, newaccount.php is disabled and only admins can create new accounts.</P
></DD
><DT
>ATTACHMENT_PATH</DT
><DD
><P
>The subdirectory in which to store bug attachments.  This directory needs to writeable by the web server.</P
></DD
><DT
>ATTACHMENT_MAX_SIZE</DT
><DD
><P
>Maximum size (in bytes) of an attachment.  This will not override the settings in <TT
CLASS="FILENAME"
>php.ini</TT
> if <TT
CLASS="FILENAME"
>php.ini</TT
> has a lower limit.</P
></DD
><DT
>DATE_FORMAT</DT
><DD
><P
>The format for displaying the date, according to PHP's <A
HREF="http://www.php.net/manual/function.date.php"
TARGET="_top"
><TT
CLASS="FUNCTION"
>date()</TT
></A
> function.</P
></DD
><DT
>TIME_FORMAT</DT
><DD
><P
>The format for displaying the date, according to PHP's <A
HREF="http://www.php.net/manual/function.date.php"
TARGET="_top"
><TT
CLASS="FUNCTION"
>date()</TT
></A
> function.</P
></DD
><DT
>LANGUAGE</DT
><DD
><P
>The language file (found in the <TT
CLASS="FILENAME"
>languages</TT
> sub-directory to use for error and warning messages.</P
></DD
><DT
>STRICT_UPDATING</DT
><DD
><P
>If false, any logged-in user can make changes to a bug.  If true, only the reporter, the person to whom the bug is currently assigned, and members of the Manager or Admin group can make changes to a bug.</P
></DD
><DT
>PROMOTE_VOTES</DT
><DD
><P
>The number of votes required to automatically promote a bug from the Unconfirmed to the New status.  A value of 0 disables auto-promotion.</P
></DD
><DT
>MAX_USER_VOTES</DT
><DD
><P
>The total number of votes a user may file on bugs.  A value of 0 disables the limit.</P
></DD
><DT
>RECALL_LOGIN</DT
><DD
><P
>Whether to show the "Remember Me" checkbox in the login form.  When checked, that box will cause a cookie to be set that stores the user's login name or email address and will prefill the login area with that value the next time the user attempts to log in.</P
></DD
><DT
>SHOW_PROJECT_SUMMARIES</DT
><DD
><P
>Whether to show the detailed project stats on the home page.</P
></DD
><DT
>FORCE_LOGIN</DT
><DD
><P
>Whether users must log in before being able to browse the bugs or reports.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="installation.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="devguide.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Installation Instructions</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="adminguide.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Developer's Guide</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Return current item: phpBugTracker