r1175: Working on stuff for the manual
[bugdar.git] / 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>.
9
10 When you have done this, open it in a text editor.
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 When you open it, you will find a list of variables. All but the following are required:
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 All of the other fields have to be provided by your host--if you do not know them.
23
24 Be sure in <varname>$pathtoisso</varname> that you place the full path to ISSO. That means that you shouldn't use a relative path like:
25
26 <filename>../../isso/</filename>
27
28 But instead, you should use:
29
30 <filename>/home/user/htdocs/isso/</filename>
31
32 Also make sure that it ends in a trailing slash!</para>
33 </section>
34
35 <!-- =================================================================== -->
36
37 <section id="install.run">
38 <title>Running the Installer</title>
39 <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.
40
41 Be sure that these uploaded files include your modified <filename>includes/config.php</filename>.
42
43 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:
44
45 <uri>http://www.example.com/bugtrack/install/install.php</uri>
46
47 Once here, follow through the steps until your installation is complete.
48
49 After you have completed installation and can log into the administrative control panel, be sure to delete this file on your web server:
50
51 <filename>install/global.php</filename>
52
53 If you do not do this, then people may be able to cause harm to your bug tracker.
54 </para>
55 </section>
56
57 </chapter>