  phpGroupWare HOWTO
  Joseph Engo <jengo@phpgroupware.org>, Dan Kuykendall
  <dan@kuykendall.org>
  v1.1, 28 September 2000

  This document explains how to install and configure phpGroupWare.
  ______________________________________________________________________

  Table of Contents


  1. Introduction

     1.1 What is phpGroupWare and why should I use it?

  2. Installation

     2.1 Requirements
     2.2 Tested Systems
     2.3 Obtaining phpGroupWare
        2.3.1 Released Versions
        2.3.2 Developer's version from CVS
     2.4 Installing on Tested Systems
     2.5 Create a database and user for phpGroupWare
     2.6 Configure phpGroupWare

  3. Testing the install

  4. Installing additional applications

  5. Trouble-shooting

     5.1 I get "Unable to open mailbox" when using the email application
     5.2 It seems to hang when I try to read my mail
     5.3 When I log in I see the directory listing instead of a web page
     5.4 I get garbage that looks like code when I go to the phpGroupWare URL

  6. About this document

     6.1 New versions
     6.2 Comments
     6.3 History
     6.4 Version History
     6.5 Copyrights and Trademarks
     6.6 Acknowledgments and Thanks


  ______________________________________________________________________

  11..  IInnttrroodduuccttiioonn

  phpGroupWare is a web based groupware application that includes
  integrated features such as email, calendar, todo list, address book,
  file manager, headline news, and a trouble ticket system.

  It should run on all systems where PHP is available and currently
  supports MySQL and PostgreSQL.

  11..11..  WWhhaatt iiss pphhppGGrroouuppWWaarree aanndd wwhhyy sshhoouulldd II uussee iitt??

  phpGroupWare is:

  phpGroupWare is a web based groupware application that includes
  integrated features such as email, calendar, todo list, address book,
  file manager, headline news, and a trouble ticket system.

  You should use it if:

  You would like a powerful groupware system that can be access from
  anywhere on the Internet.  For companies with a distributed user base,
  it's an ideal solution. Oh, and did I mention that its FREE?

  22..  IInnssttaallllaattiioonn

  22..11..  RReeqquuiirreemmeennttss

  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.

  22..22..  TTeesstteedd SSyysstteemmss

  On Linux 2.2.x

  +o  PHP 3.0.15+ / PHP 4.0.x

  +o  Apache 1.3.x

  +o  MySQL 3.22.25 or PostgreSQL 7.0.x

  +o  Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access

  We have reports of phpGroupWare working on Windows NT and OS/2, and
  using Oracle as the database.

  22..33..  OObbttaaiinniinngg pphhppGGrroouuppWWaarree

  While we are still in the Beta phase of phpGroupWare, you may want to
  track the CVS copy as closely as possible. The released versions are
  more stable, but often contain bugs that have been fixed in the CVS
  version.

  22..33..11..  RReelleeaasseedd VVeerrssiioonnss

  The downloads section on the  <http://www.phpgroupware.org/> site
  contains links to the most recent releases, and several mirror sites
  for the releases.

  22..33..22..  DDeevveellooppeerr''ss vveerrssiioonn ffrroomm CCVVSS

  If you have never used CVS, you may want to read through the
  doucmentation found at  <http://www.cvshome.org/>.  The CVS pages for
  the core and apps projects can be found at phpGroupWare Core CVS
  <http://sourceforge.net/cvs/?group_id=7305>, and phpGroupWare Apps CVS
  <http://sourceforge.net/cvs/?group_id=9787>.  Follow the directions
  for AAnnoonnyymmoouuss CCVVSS aacccceessss and you should have the most recent
  development copy of phpGroupWare in no time.

  22..44..  IInnssttaalllliinngg oonn TTeesstteedd SSyysstteemmss

  After you have met the system requirements, unpack the tarball in the
  html directory of your webserver. (eg, /home/httpd/html)

  22..55..  CCrreeaattee aa ddaattaabbaassee aanndd uusseerr ffoorr pphhppGGrroouuppWWaarree

  You must create a database for phpGroupWare to use, and we strongly
  recommend adding a user that only has permission to this new database
  for phpGroupWare's exclusive use (for security).

  Note the host the database engine is on, user, password and database
  name, you will need them soon.

  22..66..  CCoonnffiigguurree pphhppGGrroouuppWWaarree

  Copy the header.inc.php.sample file to header.inc.php and edit the
  file, following the directions in the comments.

  Then point your browser to phpgroupware/setup/ which will create (or
  upgrade) the database tables.  You wil be asked to login, using the
  password set in header.inc.php. Setup will attempt to determine what
  version of the phpGroupWare database you have installed, and upgrade
  to the most recent version.

  NNOOTTEE::The developers are concentrating on getting the beta working, and
  have not spent a great deal of time building upgrade scripts from the
  alpha versions of phpGroupWare. You are advised to backup your
  existing alpha database before running the setup script to avoid
  problems!

  If you get no error messages, continue on to
  phpgroupware/setup/config.php to configure phpGroupWare to your
  system.

  If you are using the email system you will need to create a temporary
  directory where file uploads will be stored.  For security reasons,
  you should chown nobody.nobody and chmod 700 to that directory.
  Depending on your system configuration.  Default installs of Apache
  normally run as the user nobody.  You may need your system
  administrator to do this for you if you do not have root access.

  If you do not have access to root, create this file and run it.

    <?php
      if (mkdir("/path/to/temp/directory",0700)) {
        echo "Directory created successfully";
      } else {
        echo "Error creating directory";
      }


  If you have access to cron, you may want to setup the files in the
  cron directory.

  stalesessions.pl - There are 2 reasons for this file.

  +o  Users always forget to logout. This way the session doesn't sit
     around forever, creating a possible security risk.

  +o  The email system requires plain text passwords which are stored in
     the sessions table.

  This file is not required, you can simply disable cron_apps in the
  admin -> applications section to clean out the sessions table during
  login and logout.

  stale_uploads.pl - This will delete file attachments for messages that
  where not completed.  If a users browser crashes, Internet connection
  dies, etc, their files will sit there forever unless deleted.  You
  could add a few lines to logout.php that will look in the temp
  directory for any stale uploads and delete them.  But, once again, it
  becomes a performance issue.


  33..  TTeessttiinngg tthhee iinnssttaallll

  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
  At this point it would be a good idea to create a new user with
  administrative privileges and delete the old one.

  44..  IInnssttaalllliinngg aaddddiittiioonnaall aapppplliiccaattiioonnss

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

  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)

  You install the new application within the phpGroupWare install tree
  by placing the application directory under the root phpGroupWare
  directory, and enabling the application through the Administration
  page.

  For example, this is the process to install the Headlines application
  (see  <http://sourceforge.net/phpgwapps/> for more on this and other
  applications).

  +o  Download the .tar.gz file for the application, or check out the
     source with cvs with

     export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'
     cvs login   (just hit enter if prompted for a password)
     cvs co headlines


  +o  Move the headlines directory into your phpGroupWare install
     directory.

  +o  Log into phpGroupWare as an administrative user, and go to the
     Administration page.

  +o  In the first section, choose the Applications link

  +o  Click on add, and fill in the form.

     AApppplliiccaattiioonn nnaammee
        should be identical to the name of the directory you moved into
        the phpGroupWare install, in this case use headlines

     AApppplliiccaattiioonn TTiittllee
        this is shown in the navigation bar and other places to refer to
        the new application. Enter Headlines for this example.

     EEnnaabblleedd
        This can be used to disable an application for all users
        temporially. You should normal check the box to enable the
        application.

  +o  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.

  +o  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.

  +o  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.

  55..  TTrroouubbllee--sshhoooottiinngg

  WWAARRNNIINNGG!! 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.

  The phpGroupWare developers can often be seen hanging out in
  #phpGroupWare on irc.openprojects.net if you require real-time help.

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


  55..11..  II ggeett ""UUnnaabbllee ttoo ooppeenn mmaaiillbbooxx"" wwhheenn uussiinngg tthhee eemmaaiill aapppplliiccaattiioonn

  At the time of this writing (2000-09-27) you must use the same
  username and password in phpGroupWare that you use to log into your
  mail server. If you change your password and it still isn't working,
  try logging out of phpGroupWare (the rightmost icon in the navigation
  bar) and then log back in.

  An preference page to edit the email settings is being developed, and
  should appear shortly after the first beta release.

  55..22..  IItt sseeeemmss ttoo hhaanngg wwhheenn II ttrryy ttoo rreeaadd mmyy mmaaiill

  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.

  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.

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

  ______________________________________________________________________
  set_time_limit(0);
  ______________________________________________________________________


  to the top of the inc/phpgwapi/phpgw_msg_pop3.inc.php file, just
  before the line

  class msg extends msg_common


  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.


  55..33..  WWhheenn II lloogg iinn II sseeee tthhee ddiirreeccttoorryy lliissttiinngg iinnsstteeaadd ooff aa wweebb ppaaggee

  If you are using Apache, this often means you need to add .php to the
  DirectoryIndex line in your httpd.conf file.

  For example:

  ______________________________________________________________________
  DirectoryIndex index.php index.php3 index.html index.htm index.cgi
  ______________________________________________________________________


  55..44..  II ggeett ggaarrbbaaggee tthhaatt llooookkss lliikkee ccooddee wwhheenn II ggoo ttoo tthhee pphhppGGrroouuppWWaarree
  UURRLL

  This is often because you have php3 installed, which does not map .php
  to the PHP engine.

  For PHP3:

  ______________________________________________________________________
  AddType             application/x-httpd-php3 .php3 .php
  ______________________________________________________________________


  For PHP4:

  ______________________________________________________________________
  AddType             application/x-httpd-php .php3 .php
  ______________________________________________________________________


  66..  AAbboouutt tthhiiss ddooccuummeenntt

  66..11..  NNeeww vveerrssiioonnss

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

  66..22..  CCoommmmeennttss

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

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

  66..33..  HHiissttoorryy

  This document was started by Joseph Engo and reworked by Dan
  Kuykendall.

  66..44..  VVeerrssiioonn HHiissttoorryy

  Old Version


  +o  Created by Jengo, wasn't in SGML HOWTO format.

  v1.0 (July 6, 2000)


  +o  Built proper SGML version.

  +o  Included the FAQ.

  +o  Other minor additions.

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


  +o  Added Testing Install section

  +o  Added Trouble-shooting section

  +o  Added description of application installation

  +o  Changes for the new setup program

  66..55..  CCooppyyrriigghhttss aanndd TTrraaddeemmaarrkkss

  Copyright (c)  Dan Kuykendall.  Permission is granted to copy,
  distribute and/or modify this document under the terms of the GNU Free
  Documentation License, Version 1.1 or any later version published by
  the Free Software Foundation

  A copy of the license is available at GNU Free Documentation License
  <http://www.gnu.org/copyleft/fdl.txt>.

  66..66..  AAcckknnoowwlleeddggmmeennttss aanndd TThhaannkkss

  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.