egroupware/doc/sgml/install.sgml

<chapter id="installing">
	<title>Obtaining and Installing phpGroupWare</title>
    <para>
		  After you have met the system requirements, You can install it from the TarBall or you can get it directly from CVS.
  	</para>
  <sect1 id=tarballins>
  	<title>Installing from TarBall</title>
    <para>
      Installing from a TarBall is very easy. The files should be installed in the webserver directory. 
      Example steps (please adjust to your servers config):
    	<programlisting>
cp phpgroupware-version.tar.gz /home/httpd/html
cd /home/httpd/html
tar zxf phpgroupware-version.tar.gz
    	</programlisting>
      You may have to get  required permissions to do this. 
      Contact your system administrator if you dont have the permission to write to your webserver directory.
    </para>
    <para>
    You can get current releases of phpGroupWare at the phpGroupware <ulink url="http://www.phpgroupware.org/downloads.php"><citetitle>website</citetitle></ulink>.
    </para>
  </sect1>

  <sect1 id=CVSins>
   	<title>Installing from CVS</title>
    <para>
      Installing from a CVS is fairly easy. The files should be checked out in the webserver directory.
      Example steps (please adjust to your servers config):
		  <programlisting>
cd /home/httpd/html
cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware login  (just hit enter if prompted for a password)
cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co phpgroupware
		  </programlisting>
      or if you prefer using CVSROOT:
		  <programlisting>
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'
cvs login   (just hit enter if prompted for a password)
cvs co headlines
		  </programlisting>
		  You may have to get required permissions to do this. 
      Contact your system administrator if you dont have the permission to write to your webserver directory.
    </para>
  </sect1>
  			
  <sect1 id=fileperms>
   	<title>Setting File Permissions</title>
    <para>
      There are a few directories which will need special fie permissions set for phpGroupWare to work properly. 
    </para>
    <para>
      Temp Directory (Required) - This can be /tmp for simplicity, but it is required for several apps to function properly. 
      Simply make sure that the webserver can add/delete files in it.
    </para>
    <para>
      Files Directory (Required) - This can be should be the files dir under the phpgroupware dir. You will need to give the webserver account owndership of this directory.
		  <programlisting>
chown nobody:nobody
chmod 700 /home/httpd/html/phpgroupware/files
		  </programlisting>
    </para>
    <para>
      Root Directory (Not recommended) - If you give the webserver account write access to the phpgroupware directory, then the setup program can create the header.inc.php for you. 
      Otherwise you will need to use the setup program to create it, and then you can manually save it to file.
		  <programlisting>
If you want to do it:
chown :nobody /home/httpd/html/phpgroupware
chmod 770
		  </programlisting>
    </para>
    <para>
		  You may have to get  required permissions to do this. 
      Contact your system administrator if you dont have the permission to write to your webserver directory.
    </para>
  </sect1>

  <sect1>
 	  <title>Setup / Configure phpGroupWare</title>
		<para>
  	  Point your browser to phpgroupware/setup/ which will
  	  create (or upgrade) the header.inc.php and database tables. 
  	  Setup will attempt to determine what version
  	  of the phpGroupWare databases and header.inc.php you have installed, and upgrade to the most recent version.
    </para>
    <note><title>Note</title>
      <para>
          You are advised to backup your existing alpha
    			database before running the setup script to avoid problems!
    	</para>
  	</note>
  </sect1>
  <sect1>
    <title>Testing the install</title>
    <para>
      If your config is setup properly you can now login.  Point your browser to the installed location 
      and login with the username <classname>demo</classname> and the password is <classname>1234</classname>
  	</para>
    <para>
		At this point it would be a good idea to create a new user with administrative privileges and
		delete the old one.
	  </para>
  </sect1>
  <sect1>
	  <title>Installing additional applications</title>
  	<para>
  		Once you have the core phpGroupWare install up and running,
  		you may want to download and install additional applications.
  	</para>
          <para>
  		You should consult any <filename>README</filename> or <filename>INSTALL</filename>
  		files that come with the new application first, as most require you
  		to create additional tables in the database, and add additional
  		translation data to the lang table (typically a file called <filename>lang.sql</filename>)
  	</para>
          <para>
  		You install the new application within the phpGroupWare install tree by
  		copying the application directory into the phpGroupWare install location,
  		and enabling the application through the Administration page.
  	</para>
          <para>
  		For example, this is the process to install the
  		Headlines application (see <ulink url="http://sourceforge.net/phpgwapps/">
  		<citetitle>http://sourceforge.net/phpgwapps/</citetitle></ulink> for
  		more on this and other applications).
  		<itemizedlist mark=bullet>
  		<listitem><para>Download the .tar.gz file for the application, or check out the source
  		with cvs with
  		<programlisting>
  export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'
  cvs login   (just hit enter if prompted for a password)
  cvs co headlines
  		</programlisting></para></listitem>
  	
  		<listitem><para>Move the <classname>headlines</classname> directory into your phpGroupWare
  			install directory.</para></listitem>
          	<listitem><para>Log into phpGroupWare as an administrative user, and go to the Administration page.
  				</para></listitem>
  
  		<listitem><para>In the first section, choose the <classname>Applications</classname> link.
  				</para></listitem>
  
  		<listitem><para>Click on add, and fill in the form.</para>
  		<para>
  			<application>Application name</application>
  			should be identical to the name
  			of the directory you moved into the phpGroupWare install, in this case use <classname>headlines</classname>
  		</para>
  		<para>
  			<application>Application Title</application>
  			is shown in the navigation bar and other places to refer to the
  			new application. Enter <classname>Headlines</classname> for this example.
  		</para>
  		<para>
  			<application>Enabled</application>
  			can be used to disable an application for all users temporially. You
  			should normal check the box to enable the application.
  		</para>
  		</listitem>
  		  <listitem><para>Back in the Administration page, you need to enable the application for specific users
  			or user groups by editing them, and checking the new <classname>Headlines</classname> box that appears
  			in the middle of the account editing page.</para></listitem>
  			<listitem><para>Once you have added the Headlines app to your account, you should see a Headlines
  			entry in the Administration and Preferences pages, and there should be an icon for
  			the Headlines application in the navigation bar.</para></listitem>
  			<listitem><para>Once you enable a few of the Headlines sites through the Administration page link, you
  			should see headlines grabbed from the sites you selected when you click on the Headlines
  			icon in the navigation bar.</para></listitem>
  		</itemizedlist>
  	</para>
  </sect1>
</chapter>