Skip to content

Commit

Permalink
Improve documentation for Admin Guide > Configuration
Browse files Browse the repository at this point in the history
Fixes #20880
  • Loading branch information
evilchewits authored and dregad committed May 15, 2016
1 parent a11f41a commit e98a8fa
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions .mailmap
@@ -1,5 +1,6 @@
Adrian Spinei <aspinei@users.sourceforge.net> aspinei
André Eisenbach <int2str@users.sourceforge.net> int2str
Alexander Ishmuradov <ishmuradov@gmail.com>
Bastian Pfenningschmidt <bpfennigschmidt@users.sourceforge.net> bpfennigschmidt
Damien Regad <dregad@mantisbt.org> <dr_mantis@regad.org>
Damien Regad <dregad@mantisbt.org> <damien.regad@merckgroup.com>
Expand Down
49 changes: 49 additions & 0 deletions docbook/Admin_Guide/en-US/Configuration.xml
Expand Up @@ -5,6 +5,55 @@
<chapter id="admin.config">
<title>Configuration</title>

<para>MantisBT is highly customizable through the web interface and
configuration files. Configuration options can be set globally as well as
customized for a specific project or user (except for options listed in
<emphasis>$g_global_settings</emphasis>).
</para>

<para>Configuration options can be set in
<emphasis>config_inc.php</emphasis> and in the
<emphasis>database</emphasis> (using the various manage pages).
Values stored in the database take precedence over values defined in
<emphasis>config_inc.php</emphasis>. Options stored in the database
can also be viewed and updated on
"Manage > Manage Configuration > Configuration Report" page.
</para>

<para>To determine which value to use MantisBT sequentially searches for
the specified configuration option. If the value is set, it starts
using it. Otherwise, goes to the next step.
</para>

<orderedlist>
<listitem>
<para>database: the value for current user and current project
</para>
</listitem>
<listitem>
<para>database: the value for current user and all projects
</para>
</listitem>
<listitem>
<para>database: the value for all users and current project
</para>
</listitem>
<listitem>
<para>database: the value for all users and all projects
</para>
</listitem>
<listitem>
<para>
<emphasis>config_inc.php</emphasis>
</para>
</listitem>
<listitem>
<para>
<emphasis>config_defaults_inc.php</emphasis>
</para>
</listitem>
</orderedlist>

<xi:include href="config/database.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="config/path.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="config/webserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
Expand Down

0 comments on commit e98a8fa

Please sign in to comment.