locale/en_US/manual-xml/install.xml

   1 <chapter id="install" revision="$Revision$">
   2         <title>Installation</title>
   3
   4         <!-- =================================================================== -->
   5
   6         <section id="install.config">
   7                 <title>The Configruation File</title>
   8                 <para>First, you have to rename the file <filename>includes/config.php.new</filename> to be <filename>includes/config.php</filename>.</para>
   9
  10                 <para>When you have done this, open it in a text editor.</para>
  11
  12                 <note>Microsoft Windows users: do not use Notepad to do this. It may corrupt the file and make it unusable by your web server.</note>
  13
  14                 <para>When you open it, you will find a list of variables. All but the following are required:</para>
  15
  16                 <itemizedlist>
  17                         <listitem><varname>$usepconnect</varname></listitem>
  18                         <listitem><varname>$cookieprefix</varname></listitem>
  19                         <listitem><varname>$tableprefix</varname></listitem>
  20                 </itemizedlist>
  21
  22                 <para>All of the other fields have to be provided by your host--if you do not know them.</para>
  23
  24                 <para>Also make sure that it ends in a trailing slash!</para>
  25         </section>
  26
  27         <!-- =================================================================== -->
  28
  29         <section id="install.run">
  30                 <title>Running the Installer</title>
  31                 <para>After modifying the configuration file, upload all of the files in the <filename>upload</filename> directory of your download package to the web server where you want.</para>
  32
  33                 <para>Be sure that these uploaded files include your modified <filename>includes/config.php</filename>.</para>
  34
  35                 <para>Once you have done this, go to your web browser and enter the address of your installation, plus <filename>/install/install.php</filename>. For instance, if I uploaded the installation to <filename>/bugtrack/</filename> on my server, I'd go to: <uri>http://www.example.com/bugtrack/install/install.php</uri></para>
  36
  37                 <para>Once here, follow through the steps until your installation is complete.</para>
  38
  39                 <para>After you have completed installation and can log into the administrative control panel, be sure to delete this file on your web server: <filename>install/global.php</filename></para>
  40
  41                 <para>If you do not do this, then people may be able to cause harm to your bug tracker.</para>
  42         </section>
  43
  44 </chapter>