locale/en_US/manual-xml/install.xml

   1 <chapter id="install" revision="$Revision$">
   2         <title>Installation</title>
   3
   4         <!-- =================================================================== -->
   5
   6         <section id="install.intro">
   7                 <title>Installation Overview</title>
   8
   9                 <para>The installation process is very simple and includes only six easy steps:</para>
  10
  11                 <orderedlist>
  12                         <listitem>Download the latest version of Bugdar from <link xlink:href="http://www.bluestatic.org/software/bugdar/">Blue Static</link>.</listitem>
  13                         <listitem>Unzip the files from the download package.</listitem>
  14                         <listitem>Rename <filename>upload/includes/config.php.new</filename> to <filename>upload/includes/config.php</filename>.</listitem>
  15                         <listitem><link linkend="install.config">Open and edit</link> the new <filename>config.php</filename> according to the instructions in the file.</listitem>
  16                         <listitem>Upload the files to your web server.</listitem>
  17                         <listitem>Run the <link linkend="install.run">installation script</link>.</listitem>
  18                 </orderedlist>
  19         </section>
  20
  21         <!-- =================================================================== -->
  22
  23         <section id="install.config">
  24                 <title>The Configruation File</title>
  25                 <para>First, you have to rename the file <filename>includes/config.php.new</filename> to be <filename>includes/config.php</filename>.</para>
  26
  27                 <para>When you have done this, open it in a text editor.</para>
  28
  29                 <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>
  30
  31                 <para>When you open it, you will find a list of variables. All but the following are required:</para>
  32
  33                 <itemizedlist>
  34                         <listitem><varname>$usepconnect</varname></listitem>
  35                         <listitem><varname>$cookieprefix</varname></listitem>
  36                         <listitem><varname>$tableprefix</varname></listitem>
  37                 </itemizedlist>
  38
  39                 <para>All of the other fields have to be provided by your host--if you do not know them.</para>
  40
  41                 <para>Also make sure that it ends in a trailing slash!</para>
  42         </section>
  43
  44         <!-- =================================================================== -->
  45
  46         <section id="install.run">
  47                 <title>Running the Installer</title>
  48                 <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>
  49
  50                 <para>Be sure that these uploaded files include your modified <filename>includes/config.php</filename>.</para>
  51
  52                 <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>
  53
  54                 <para>Once here, follow through the steps until your installation is complete.</para>
  55
  56                 <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>
  57
  58                 <para>If you do not do this, then people may be able to cause harm to your bug tracker.</para>
  59         </section>
  60
  61 </chapter>