Adding phpdoc tags to String[] array so the code scanner will pick them up and do...
[phpeclipse.git] / net.sourceforge.phpeclipse.help / docbook-src / guide / src / en / user-manual / install_xampp.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- jEdit buffer-local properties: -->
3 <!-- :indentSize=2:noTabs=true: -->
4 <!-- :xml.root=docmaster.xml: -->
5
6 <sect1 id="sec.install_amp">
7   <title>Installing <application>Apache</application>/<application>MySQL</application>/<application>PHP</application>, </title>
8   <para>
9     Most PHP developers find it easiest to work with a running web server of their local machine. This allows you to test your work as you go, without having to upload it to a hosting environment. Therefore, it's suggested that at this point you install Apache, PHP, and (if you are using it), MySQL. This step is required if you plan to use the php debugger. Together this tools are often referred to as AMP (or AMPP if you include Perl as well as PHP).
10   </para>
11
12
13   <sect2 id="sec.install_xampp">
14     <title>Installing <application>XAMPP</application></title>
15     <para>
16       <application>XAMPP</application> is a software bundle which includes everything you need to install Apache/MySQL/PHP/Perl in one go. It's available for Windows, Linux and Solaris. Particularly on a Windows machine, this is definitely the fastest way to get up and running with these tools, as someone else has done the integration and configuration work for you. Under linux, it may be a quick solution to set up, but will not be as easy to automatically maintain (or integrate with other packages) as if you installed these tools separately with your distribution's package management system (such as: apt, YaST, emerge, or up2date). This is covered in the next section.
17     </para>
18
19     <para>
20       To install XAMPP, visit <ulink url="http://www.apachefriends.org/en/xampp.html">Apachefriends</ulink>. Select your operating system:
21       <itemizedlist>
22         <listitem>
23           <para>
24             <ulink url="http://www.apachefriends.org/en/xampp-windows.html">Windows</ulink>
25           </para>
26         </listitem>
27         <listitem>
28           <para>
29             <ulink url="http://www.apachefriends.org/en/xampp-linux.html">Linux</ulink>
30           </para>
31         </listitem>
32         <listitem>
33           <para>
34             <ulink url="http://www.apachefriends.org/en/xampp-solaris.html">Solaris</ulink>
35           </para>
36         </listitem>
37       </itemizedlist>
38       and then follow the simple installation instructions found on that page.
39     </para>
40
41     <para>
42       There are two different methods of installing <application>XAMPP</application> for Windows:
43       <itemizedlist>
44         <listitem>
45           <para>
46             Method A: Installation with installer
47           </para>
48         </listitem>
49         <listitem>
50           <para>
51             Method B: <quote>Installation</quote> without installer
52           </para>
53         </listitem>
54       </itemizedlist>
55       The advantage of method B is, that it doesn't do anything with the Windows registry, and you can have different versions of XAMPP (and so different versions of PHP) in parallel. This can be important if you have to test your PHP files with different versions of PHP&nbsp;4 (or different versions of PHP&nbsp;5).
56     </para>
57
58     <tip>
59       <para>
60         You can switch between PHP&nbsp;4 and PHP&nbsp;5 with <filename>php-switch.bat</filename>.
61       </para>
62     </tip>
63   </sect2>
64
65   <sect2 id="sec.xampp_change_doc_root">
66     <title>Changing the Document Root</title>
67     <para>
68       Assuming that you have installed XAMPP for Windows under <filename class="directory">C:\Program Files</filename> the default path of the &docroot; is <filename class="directory">C:\Program Files\apachefriends\xampp\htdocs</filename>.
69     </para>
70
71     <para>
72       Per default this folder contains help and demo files from the XAMPP maintainers. That's what you see if you have started XAMPP and type <quote>http://localhost</quote> within your web browser.
73     </para>
74
75     <para>
76       So, when you want to write your own files (That's what we suppose, when you use &phpeclipse;), you can either delete everything what is within <filename class="directory">C:\Program&nbsp;Files\apachefriends\xampp\htdocs</filename>, or you can set the &docroot; to any other path by opening <filename>C:\Program&nbsp;Files\apachefriends\xampp\apache\conf\httpd.conf</filename> with an editor, search the line which starts with <emphasis role="bold">DocumentRoot</emphasis> and change the path to what you need.
77     </para>
78
79     <para>
80       The next section shows an additional way to point the webserver to different locations without changing the &docroot;.
81     </para>
82   </sect2>
83
84   <sect2 id="sec.xampp_add_alias">
85     <title>Adding Aliases</title>
86     <para>
87       An additional way to let the web server know where to look for files is with the help of <quote>Alias</quote>. Just open the file <filename>C:\Program&nbsp;Files\apachefriends\xampp\apache\conf\httpd.conf</filename> with an editor and append for example<footnote><para>The example shows a eclipse default workspace path (in case your user name is Robert).</para></footnote>:
88       <programlisting><![CDATA[Alias /my_php_workspace "C:/Documents and Settings/Robert/workspace"]]></programlisting>
89     </para>
90
91     <para>
92       Assuming we have PHP files within the folder <filename class="directory">C:/Documents&nbsp;and&nbsp;Settings/Robert/workspace/MyFirstPHPProject</filename> e.g. <filename>index.php</filename> the URL to access this file would be <ulink url="http://localhost/my_php_workspace/MyFirstPHPProject/index.php"></ulink>.
93     </para>
94
95     <note>
96       <para>
97         The knowledge of where the &docroot; is, or how we can change the &docroot; or add aliases is a prerequisite when we want to successfully set up and work with &phpeclipse;.
98       </para>
99     </note>
100   </sect2>
101 </sect1>