egroupware_official/doc/index.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with LaTeX2HTML 99.2beta8 (1.42)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>phpGroupWare Docs</TITLE>
<META NAME="description" CONTENT="phpGroupWare Docs">
<META NAME="keywords" CONTENT="index">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v99.2beta8">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="index.css">

</HEAD>

<BODY >
<!--Navigation Panel-->
<IMG WIDTH="81" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next_inactive"
 SRC="file:/usr/lib/latex2html/icons/nx_grp_g.png"> 
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/lib/latex2html/icons/up_g.png"> 
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/lib/latex2html/icons/prev_g.png">   
<BR>
<BR>
<BR>
<!--End of Navigation Panel-->

<P>

<P>

<P>

<P>

<P>
<H1 ALIGN="CENTER"><B>phpGroupWare Installation</B></H1>
<P ALIGN="CENTER"><STRONG>Editor: Darryl VanDorp</STRONG></P>
$Id$

<P>
<BR>

<H2><A NAME="SECTION00010000000000000000">
Contents</A>
</H2>
<!--Table of Contents-->

<UL>
<LI><A NAME="tex2html27"
  HREF="index.html">Contents</A>
<LI><A NAME="tex2html28"
  HREF="index.html#SECTION00020000000000000000">Dedication </A>
<LI><A NAME="tex2html29"
  HREF="index.html#SECTION00030000000000000000">1 What is phpGroupWare </A>
<LI><A NAME="tex2html30"
  HREF="index.html#SECTION00040000000000000000">2 Why you should use it </A>
<LI><A NAME="tex2html31"
  HREF="index.html#SECTION00050000000000000000">3 Installation</A>
<UL>
<LI><A NAME="tex2html32"
  HREF="index.html#SECTION00051000000000000000">3.1 Requirements </A>
<LI><A NAME="tex2html33"
  HREF="index.html#SECTION00052000000000000000">3.2 Tested Systems </A>
</UL>
<LI><A NAME="tex2html34"
  HREF="index.html#SECTION00060000000000000000">4 Obtaining and Installing phpGroupWare </A>
<UL>
<LI><A NAME="tex2html35"
  HREF="index.html#SECTION00061000000000000000">4.1 Installing from TarBall </A>
<LI><A NAME="tex2html36"
  HREF="index.html#SECTION00062000000000000000">4.2 Installing from CVS </A>
<LI><A NAME="tex2html37"
  HREF="index.html#SECTION00063000000000000000">4.3 Setting File Permissions </A>
<LI><A NAME="tex2html38"
  HREF="index.html#SECTION00064000000000000000">4.4 Setup the database</A>
<LI><A NAME="tex2html39"
  HREF="index.html#SECTION00065000000000000000">4.5 Setup / Configure phpGroupWare </A>
<LI><A NAME="tex2html40"
  HREF="index.html#SECTION00066000000000000000">4.6 Testing the install </A>
<LI><A NAME="tex2html41"
  HREF="index.html#SECTION00067000000000000000">4.7 Installing additional applications </A>
</UL>
<LI><A NAME="tex2html42"
  HREF="index.html#SECTION00070000000000000000">5 Trouble Shooting</A>
<UL>
<LI><A NAME="tex2html43"
  HREF="index.html#SECTION00071000000000000000">5.1 It seems to hang when I try to read my mail </A>
<LI><A NAME="tex2html44"
  HREF="index.html#SECTION00072000000000000000">5.2 When I log in I see the directory listing instead of a web page </A>
<LI><A NAME="tex2html45"
  HREF="index.html#SECTION00073000000000000000">5.3 I get garbage that looks like code when I go to the phpGroupWare
URL </A>
</UL>
<LI><A NAME="tex2html46"
  HREF="index.html#SECTION00080000000000000000">6 About this document</A>
<UL>
<LI><A NAME="tex2html47"
  HREF="index.html#SECTION00081000000000000000">6.1 History </A>
<LI><A NAME="tex2html48"
  HREF="index.html#SECTION00082000000000000000">6.2 Version History </A>
</UL>
<LI><A NAME="tex2html49"
  HREF="index.html#SECTION00090000000000000000">About this document ...</A>
</UL>
<!--End of Table of Contents-->

<P>

<H1><A NAME="SECTION00020000000000000000">
Dedication </A>
</H1>

<P>
Thanks to Joesph Engo for starting phpGroupWare (at the time called
webdistro) and the core of this HOWTO. Thanks to all the developers
and users who contribute to making phpGroupWare such a success. 

<P>

<H1><A NAME="SECTION00030000000000000000">
1 What is phpGroupWare </A>
</H1>

<P>
phpGroupWare is a web based GroupWare system. It comes with serveral
core apps for email, calendar, todo list, address book, file manager,
and a notepad.

<P>
It also provides a framework for add-on applications to integrate
seamlessly in phpGroupWare. Some samples are a bookmark manager, a
trouble ticket system, a weather reporter, a phone log, a chat program,
and a forum system. There are many more in development, and you can
develop your own as well. 

<P>

<H1><A NAME="SECTION00040000000000000000">
2 Why you should use it </A>
</H1>

<P>
You should use it if you would like a powerful groupware system that
can be access from anywhere on the Internet, and allows for custom
add-ons. For companies with a distributed user base, it's an ideal
solution. Oh, and did I mention that its FREE? 

<P>

<H1><A NAME="SECTION00050000000000000000">
3 Installation</A>
</H1>

<P>
Installation and Configuration of phpGroupWare has never been easier.
Just point and click, yeah it's very easy.

<P>
Since this is still a beta version we do expect some bugs. By carefully
reading this document you can easly install phpGroupWare. 

<P>

<H2><A NAME="SECTION00051000000000000000">
3.1 Requirements </A>
</H2>

<P>
You will need PHP compiled and installed on your system. You will
also need MySQL or PostgreSQL setup. If you are planning on using
the email system, you will need to have an IMAP server installed and
IMAP support compiled into PHP. You can have it installed as an Apache
module or command line version, the Apache module is preferred. We
will assume that you are running on a Linux or other Unix system for
these steps. Windows is supported, but there is no documentation for
it currently. 

<P>
In order to check if you have php installed create the file with your
favorite text editor named test.php in your webserver root directory:

<P>
<TT>&lt;? phpinfo(); ?&gt;</TT>

<P>
Then point your browser to http://yourserverroot/test.php. You should
get a very detailed page describing various options in php.

<P>
If you need to to compile php and apache the following links are good
starting points: 

<P>
A set of scripts to compile and install various modules with apache:
http://www.apachetoolbox.com

<P>
The Linux Apache MySQL PHP (LAMP) Guide v2 (latest as of this writing):
http://www.linuxhelp.net/guides/

<P>
The Soothing Seemless Setup of Apache, SSL, MySQL, and PHP: http://www.devshed.com/Server_Side/PHP/SoothinglySeamless

<P>

<H2><A NAME="SECTION00052000000000000000">
3.2 Tested Systems </A>
</H2>

<P>
On Linux 2.2.x, 2.4.x

<P>
PHP 3.0.15+ / PHP 4.0.x

<P>
Apache 1.3.x

<P>
MySQL 3.22.25 or PostgreSQL 7.0.x

<P>
Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access

<P>
We have reports of it working on Windows NT and OS/2, and using Oracle
as the database. 

<P>

<H1><A NAME="SECTION00060000000000000000">
4 Obtaining and Installing phpGroupWare </A>
</H1>

<P>
After you have met the system requirements, You can install it from
the TarBall or you can get it directly from CVS. 

<P>

<H2><A NAME="SECTION00061000000000000000">
4.1 Installing from TarBall </A>
</H2>

<P>
Installing from a TarBall is very easy. The files should be installed
in the webserver directory. Example steps (please adjust to your servers
config):

<P>
cp phpgroupware-version.tar.gz /home/httpd/html

<P>
cd /home/httpd/html

<P>
tar zxf phpgroupware-version.tar.gz

<P>
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.

<P>
You can get current releases of phpGroupWare at the phpGroupware <I>website</I>
(http://www.phpgroupware.org/downloads.php). 

<P>

<H2><A NAME="SECTION00062000000000000000">
4.2 Installing from CVS </A>
</H2>

<P>
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):

<P>

<UL>
<LI>cd /home/httpd/html
</LI>
<LI>cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
login (just hit enter if prompted for a password)
</LI>
<LI>cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
co phpgroupware
</LI>
</UL>
or if you prefer using CVSROOT:

<P>

<UL>
<LI>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'
</LI>
<LI>cvs login (just hit enter if prompted for a password)
</LI>
<LI>cvs co phpgroupware
</LI>
</UL>
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. 

<P>

<H3><A NAME="SECTION00062100000000000000">
4.2.1 Patched Branches in CVS</A>
</H3>

<P>
Recently the phpGroupWare developers started a branch for patches
to released versions. This is to facilitate bugs being fixed in a
released version without having to wait for the next offical release.
There is a developer who has been assigned the responsibility for
maintaining that branch and applying patches and fixes. To check out
this version of the code using 0.9.9 as an example you would do the
following:

<P>

<UL>
<LI>login to cvs anonymously as described above
</LI>
<LI>cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
-r Version-0_9_9-patches phpgroupware
</LI>
</UL>

<P>

<H2><A NAME="SECTION00063000000000000000">
4.3 Setting File Permissions </A>
</H2>

<P>
There are a few directories which will need special fie permissions
set for phpGroupWare to work properly.

<P>
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.

<P>
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.

<P>
chown nobody:nobody (note: this assumes your webserver runs as user
nobody, adjust for your installation)

<P>
chmod 700 /home/httpd/html/phpgroupware/files

<P>
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.

<P>
If you want to do it:

<P>
chown :nobody /home/httpd/html/phpgroupware

<P>
chmod 770

<P>
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. 

<P>

<H2><A NAME="SECTION00064000000000000000">
4.4 Setup the database</A>
</H2>

<P>
You need to create empty databases for the setup app to create the
tables in.

<P>

<H3><A NAME="SECTION00064100000000000000">
4.4.1 Mysql (assuming an existing and working Mysql install)</A>
</H3>

<P>

<UL>
<LI>Mandrake or Redhat: /etc/rc.d/init.d/mysqld start
</LI>
<LI>other: /usr/local/mysql/bin/safe_mysqld &amp;
</LI>
<LI>create the empty database: mysqldadmin -u someuser create phpgroupware
-p
</LI>
<LI>login to mysql: mysql -u someuser -p
</LI>
<LI>issue the following at the mysql prompt:
</LI>
<LI>grant all on phpgroupware.* to phpgroupware@localhost identified
by ``somepassword'';
</LI>
</UL>
For more detailed user documentation on Mysql see their website :
http://www.mysql.com

<P>

<H3><A NAME="SECTION00064200000000000000">
4.4.2 Postgresql (assuming an existing and working Postgresql install)</A>
</H3>

<P>
To create the required database in Postgresql make sure postgresql
is started:

<P>

<UL>
<LI>Mandrake or Redhat : /etc/rc.d/init.d/postgresql start
</LI>
<LI>others: /usr/bin/postmaster -D /var/lib/pgsql/data or /usr/bin/pg_ctl
-D /var/lib/pgsq/data start (adjust for your install dirs)
</LI>
<LI>create the empty database: /usr/bin/createdb phpgroupware
</LI>
<LI>create a database user: /usr/bin/createuser phpgroupware
</LI>
</UL>
For more detailed user documentation on Postgresql see their website
: http://www.postgresql.org

<P>

<H2><A NAME="SECTION00065000000000000000">
4.5 Setup / Configure phpGroupWare </A>
</H2>

<P>
Point your browser to http://yourserverroot/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. 

<P>
<B>Note:</B>  You are advised to backup your existing database before
running the setup script to avoid problems!

<P>

<H2><A NAME="SECTION00066000000000000000">
4.6 Testing the install </A>
</H2>

<P>
If your config is setup properly you can now login. Point your browser
to the installed location and login with the username demo and the
password is 1234

<P>
At this point it would be a good idea to create a new user with administrative
privileges and delete the old one. 

<P>

<H2><A NAME="SECTION00067000000000000000">
4.7 Installing additional applications </A>
</H2>

<P>
Once you have the core phpGroupWare install up and running, you may
want to download and install additional applications.

<P>
You should consult any README or INSTALL 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 lang.sql)

<P>
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.

<P>
For example, this is the process to install the Headlines application:

<P>
(see http://www.sourceforge.net/projects/phpgwapps for more
applications)

<P>
Download the .tar.gz file for the application, or check out the source
with cvs with

<P>
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'

<P>
cvs login (just hit enter if prompted for a password)

<P>
cvs co headlines

<P>
Move the headlines directory into your phpGroupWare install directory.

<P>
Log into phpGroupWare as an administrative user, and go to the Administration
page.

<P>
In the first section, choose the Applications link.

<P>
Click on add, and fill in the form.

<P>
Application name should be identical to the name of the directory
you moved into the phpGroupWare install, in this case use headlines

<P>
Application Title is shown in the navigation bar and other places
to refer to the new application. Enter Headlines for this example.

<P>
Enabled can be used to disable an application for all users temporially.
You should normal check the box to enable the application.

<P>
Back in the Administration page, you need to enable the application
for specific users or user groups by editing them, and checking the
new Headlines box that appears in the middle of the account editing
page.

<P>
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.

<P>
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. 

<P>

<H1><A NAME="SECTION00070000000000000000">
5 Trouble Shooting</A>
</H1>

<P>
<B>Warning </B>

<P>
phpGroupWare is still Beta software, expect some bugs along the way.
If you run into a problem not discussed here, contact us through one
of the methods listed on the website.

<P>
<EFBFBD>The phpGroupWare developers can most often be seen hanging out in
<I>#phpGroupWare</I> on <I>irc.openprojects.net</I> if you require
real-time help.

<P>
Also check the FAQ in this directory for additional common questions,
it is available as FAQ.sgml, FAQ.txt and FAQ.html 

<P>

<H2><A NAME="SECTION00071000000000000000">
5.1 It seems to hang when I try to read my mail </A>
</H2>

<P>
This is often a problem if you are using POP3 instead of IMAP, and
you have more than a few hundred messages in your mailbox.

<P>
By default, php is set up to time-out a request that takes over 30
seconds to complete. phpGroupWare must do a lot of work the first
time your POP3 mailbox is opened, and every time you get new mail,
which may take more than the 30 second timeout.

<P>
You can either clean up your mailbox with another mail program, or
add the line

<P>
set_time_limit(0);

<P>
to the top of the phpgwapi/inc/phpgw_msg_pop3.inc.php file, just
before the line class msg extends msg_common

<P>
If you choose to edit the file, be patient when loading a large POP3
mailbox - the author tested against a mailbox with 2500 messages in
it, but it took 15 minutes to load the page. We highly suggest you
use IMAP if you expect to have more than a few hundred messages in
your mailbox. 

<P>

<H2><A NAME="SECTION00072000000000000000">
5.2 When I log in I see the directory listing instead of a web page </A>
</H2>

<P>
You are using Apache, this often means you need to add .php to the
DirectoryIndex line in your httpd.conf file. For example:

<P>
DirectoryIndex index.php index.php3 index.html index.htm index.cgi 

<P>

<H2><A NAME="SECTION00073000000000000000">
5.3 I get garbage that looks like code when I go to the phpGroupWare
URL </A>
</H2>

<P>
This is often because you have php3 installed, which does not map
.php to the PHP engine. For PHP3:

<P>
AddType application/x-httpd-php3 .php3 .php

<P>
For PHP4:

<P>
AddType application/x-httpd-php .php3 .php 

<P>

<H1><A NAME="SECTION00080000000000000000">
6 About this document</A>
</H1>

<P>
The newest version of this document can be found on our website http://www.phpgroupware.org
as lyx source, HTML, or TEXT.

<P>
Comments on this HOWTO should be directed to the phpGroupWare developers
mailing list <I>phpgroupware-developers@lists.sourceforge.net</I> 

<P>
To subscribe, go to <I>http://sourceforge.net/mail/?group_id=7305</I> 

<P>

<H2><A NAME="SECTION00081000000000000000">
6.1 History </A>
</H2>

<P>
This document was started by Joseph Engo reworked by Dan Kuykendall
then edited by Darryl VanDorp 

<P>

<H2><A NAME="SECTION00082000000000000000">
6.2 Version History </A>
</H2>

<P>
Old Version

<P>
Created by Jengo, wasn't in SGML HOWTO format.

<P>
v1.0 (July 6, 2000)

<P>
Built proper SGML version.

<P>
Included the FAQ.

<P>
Other minor additions.

<P>
v1.1 (September 27-29, 2000) - blinky

<P>
Added Testing Install section

<P>
Added Trouble-shooting section

<P>
Added description of application installation

<P>
Changes for the new setup program

<P>
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook
format

<P>
v.0.05 (November 5, 2000) - gnrfan , Completely revamped according
to Seek's idea and intregrated the Developers HOWTO.

<P>
v.0.06 (Jan 10, 2001) - Darryl VanDorp, imported to lyx source reformatted
and touched up some sections

<P>
v.0.07 (Jan 16, 2001) - Darryl VanDorp, added TOC, fixed some Postgresql
setup instructions, added some links to install/compilation instructions
for apache, php and mysql.`

<P>
v.0.08 (Feb 22, 2001) - Darryl VanDorp, added a multipart html export

<H1><A NAME="SECTION00090000000000000000">
About this document ...</A>
</H1>
 <STRONG><B>phpGroupWare Installation</B></STRONG><P>
This document was generated using the
<A HREF="http://www-dsed.llnl.gov/files/programs/unix/latex2html/manual/"><STRONG>LaTeX</STRONG>2<tt>HTML</tt></A> translator Version 99.2beta8 (1.42)
<P>
Copyright &#169; 1993, 1994, 1995, 1996,
<A HREF="http://cbl.leeds.ac.uk/nikos/personal.html">Nikos Drakos</A>, 
Computer Based Learning Unit, University of Leeds.
<BR>
Copyright &#169; 1997, 1998, 1999,
<A HREF="http://www.maths.mq.edu.au/~ross/">Ross Moore</A>, 
Mathematics Department, Macquarie University, Sydney.
<P>
The command line arguments were: <BR>
 <STRONG>latex2html</STRONG> <TT>-no_subdir -split 0 -show_section_numbers /tmp/lyx_tmpdir1982sfZANo/lyx_tmpbuf198227Nfzx/index.tex</TT>
<P>
The translation was initiated by Darryl on 2001-02-22<HR>
<!--Navigation Panel-->
<IMG WIDTH="81" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next_inactive"
 SRC="file:/usr/lib/latex2html/icons/nx_grp_g.png"> 
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/lib/latex2html/icons/up_g.png"> 
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/lib/latex2html/icons/prev_g.png">   
<BR>
<!--End of Navigation Panel-->
<ADDRESS>
Darryl
2001-02-22
</ADDRESS>
</BODY>
</HTML>