tossed in new files

This commit is contained in:
seek3r 2001-01-12 08:27:27 +00:00
parent 2a880eeaeb
commit fb2047767f
12 changed files with 1429 additions and 1073 deletions

View File

@ -1,357 +1,540 @@
<HTML> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
<HEAD> "http://www.w3.org/TR/REC-html40/loose.dtd">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252"> <html>
<META NAME="Generator" CONTENT="Microsoft Word 97"> <meta name="GENERATOR" content="TtH 2.86">
<TITLE>phpGroupWare Docs V0</TITLE>
</HEAD>
<BODY>
<title> \textbf{phpGroupWare Docs V0.06}</title>
<h1 align="center"><b>phpGroupWare Docs V0.06</b> </h1>
<P>&nbsp;</P> <p>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">phpGroupWare Docs V0.05</P>
</B></FONT><P>&nbsp;</P>
<B><FONT FACE="Arial" SIZE=6><P ALIGN="CENTER">Joseph Engo</P>
<P ALIGN="CENTER">Dan Kuykendall</P>
</B></FONT>
<B><FONT FACE="Arial"><P>phpGroupWare Docs V0.05</P>
</B></FONT><P>by&nbsp;Joseph Engo and Dan Kuykendall</P>
<B><FONT FACE="Arial" SIZE=7><P>Dedication</P><DIR>
<DIR>
<DIR>
</B></FONT><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></DIR> <h3 align="center"><b>Joseph Engo</b> </h3>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P>Table of Contents</P><DIR> <p>
<DIR>
<DIR>
<DIR>
</B></FONT><FONT SIZE=2><P></FONT><A HREF="#_20"><B>I. Introduction</B></A><B>&#9;</B><A HREF="#_20"><A HREF="#_20">*</A></A></P><DIR> <h3 align="center"><b>Dan Kuykendall</b> </h3>
<FONT SIZE=2><P></FONT><A HREF="#ID_WHAT">1. What is phpGroupWare</A>&#9;<A HREF="#ID_WHAT"><A HREF="#ID_WHAT">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_WHY">2. Why you should use it</A>&#9;<A HREF="#ID_WHY"><A HREF="#ID_WHY">*</A></A></P></DIR> $Id$
<FONT SIZE=2><P></FONT><A HREF="#_31"><B>II. Installation</B></A><B>&#9;</B><A HREF="#_31"><A HREF="#_31">*</A></A></P><DIR> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_REQUIREMENTS">3. Requirements</A>&#9;<A HREF="#ID_REQUIREMENTS"><A HREF="#ID_REQUIREMENTS">*</A></A></P><DIR> <h2>Dedication </h2>
<DIR>
<FONT SIZE=2><P></FONT><A HREF="#_39">3.1. Tested Systems</A>&#9;<A HREF="#_39"><A HREF="#_39">*</A></A></P></DIR> <p>
</DIR> 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.
<FONT SIZE=2><P></FONT><A HREF="#ID_INSTALLING">4. Obtaining and Installing phpGroupWare</A>&#9;<A HREF="#ID_INSTALLING"><A HREF="#ID_INSTALLING">*</A></A></P><DIR> <p>
<DIR> <h2><a name="tth_sEc1">
1</a>&nbsp;&nbsp;What is phpGroupWare </h2>
<FONT SIZE=2><P></FONT><A HREF="#ID_TARBALLINS">4.1. Installing from TarBall</A>&#9;<A HREF="#ID_TARBALLINS"><A HREF="#ID_TARBALLINS">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_CVSINS">4.2. Installing from CVS</A>&#9;<A HREF="#ID_CVSINS"><A HREF="#ID_CVSINS">*</A></A></P> phpGroupWare is a web based GroupWare system. It comes with serveral
<FONT SIZE=2><P></FONT><A HREF="#ID_FILEPERMS">4.3. Setting File Permissions</A>&#9;<A HREF="#ID_FILEPERMS"><A HREF="#ID_FILEPERMS">*</A></A></P> core apps for email, calendar, todo list, address book, file manager,
<FONT SIZE=2><P></FONT><A HREF="#_75">4.4. Setup / Configure phpGroupWare</A>&#9;<A HREF="#_75"><A HREF="#_75">*</A></A></P> and a notepad.
<FONT SIZE=2><P></FONT><A HREF="#_81">4.5. Testing the install</A>&#9;<A HREF="#_81"><A HREF="#_81">*</A></A></P>
<FONT SIZE=2><P></FONT><A HREF="#_87">4.6. Installing additional applications</A>&#9;<A HREF="#_87"><A HREF="#_87">*</A></A></P></DIR>
</DIR>
<FONT SIZE=2><P></FONT><A HREF="#ID_TROUBLE">5. Trouble Shooting</A>&#9;<A HREF="#ID_TROUBLE"><A HREF="#ID_TROUBLE">*</A></A></P><DIR> <p>
<DIR> 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.
<FONT SIZE=2><P></FONT><A HREF="#ID_TROB1">5.1. I get "Unable to open mailbox" when using the email application</A>&#9;<A HREF="#ID_TROB1"><A HREF="#ID_TROB1">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_TROB2">5.2. It seems to hang when I try to read my mail</A>&#9;<A HREF="#ID_TROB2"><A HREF="#ID_TROB2">*</A></A></P> <h2><a name="tth_sEc2">
<FONT SIZE=2><P></FONT><A HREF="#ID_TROB3">5.3. When I log in I see the directory listing instead of a web page</A>&#9;<A HREF="#ID_TROB3"><A HREF="#ID_TROB3">*</A></A></P> 2</a>&nbsp;&nbsp;Why you should use it </h2>
<FONT SIZE=2><P></FONT><A HREF="#ID_TROB4">5.4. I get garbage that looks like code when I go to the phpGroupWare URL</A>&#9;<A HREF="#ID_TROB4"><A HREF="#ID_TROB4">*</A></A></P></DIR>
</DIR>
</DIR>
<FONT SIZE=2><P></FONT><A HREF="#_159"><B>VII. About</B></A><B>&#9;</B><A HREF="#_159"><A HREF="#_159">*</A></A></P><DIR> <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?
<FONT SIZE=2><P></FONT><A HREF="#ID_HISTORY">6. History of this document</A>&#9;<A HREF="#ID_HISTORY"><A HREF="#ID_HISTORY">*</A></A></P><DIR> <p>
<DIR> <h2><a name="tth_sEc3">
3</a>&nbsp;&nbsp;Installation</h2>
<FONT SIZE=2><P></FONT><A HREF="#_173">6.1. History</A>&#9;<A HREF="#_173"><A HREF="#_173">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#_176">6.2. Version History</A>&#9;<A HREF="#_176"><A HREF="#_176">*</A></A></P></DIR> Installation and Configuration of phpGroupWare has never been easier.
</DIR> Just point and click, yeah it's very easy.
</DIR>
</DIR>
</DIR>
</DIR>
</DIR>
<P><A NAME="_20"></A></P> <p>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">I. Introduction</P> Since this is still a beta version we do expect some bugs. By carefully
</FONT><FONT FACE="Arial" SIZE=6><P>Table of Contents</P><DIR> reading this document you can easly install phpGroupWare.
<DIR>
<DIR>
<DIR>
</B></FONT><FONT SIZE=2><P></FONT><A HREF="#ID_WHAT"><B>1. What is phpGroupWare</B></A><B>&#9;</B><A HREF="#ID_WHAT"><A HREF="#ID_WHAT">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_WHY"><B>2. Why you should use it</B></A><B>&#9;</B><A HREF="#ID_WHY"><A HREF="#ID_WHY">*</A></A></P></DIR> <h3><a name="tth_sEc3.1">
3.1</a>&nbsp;&nbsp;Requirements </h3>
<P> If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on. </P></DIR> <p>
</DIR> You will need PHP compiled and installed on your system. You will
</DIR> 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.
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_WHAT"></A>Chapter 1. What is phpGroupWare</P><DIR> <p>
<DIR> <h3><a name="tth_sEc3.2">
<DIR> 3.2</a>&nbsp;&nbsp;Tested Systems </h3>
</B></FONT><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> <p>
<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></DIR> On Linux 2.2.x, 2.4.x
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_WHY"></A>Chapter 2. Why you should use it</P><DIR> <p>
<DIR> PHP 3.0.15+ / PHP 4.0.x
<DIR>
</B></FONT><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></DIR> <p>
</DIR> Apache 1.3.x
</DIR>
<P><A NAME="_31"></A></P> <p>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">II. Installation</P> MySQL 3.22.25 or PostgreSQL 7.0.x
</FONT><FONT FACE="Arial" SIZE=6><P>Table of Contents</P><DIR>
<DIR>
<DIR>
<DIR>
</B></FONT><FONT SIZE=2><P></FONT><A HREF="#ID_REQUIREMENTS"><B>3. Requirements</B></A><B>&#9;</B><A HREF="#ID_REQUIREMENTS"><A HREF="#ID_REQUIREMENTS">*</A></A></P> <p>
<FONT SIZE=2><P></FONT><A HREF="#ID_INSTALLING"><B>4. Obtaining and Installing phpGroupWare</B></A><B>&#9;</B><A HREF="#ID_INSTALLING"><A HREF="#ID_INSTALLING">*</A></A></P> Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access
<FONT SIZE=2><P></FONT><A HREF="#ID_TROUBLE"><B>5. Trouble Shooting</B></A><B>&#9;</B><A HREF="#ID_TROUBLE"><A HREF="#ID_TROUBLE">*</A></A></P></DIR>
<P> Installation and Configuration of phpGroupWare has never been easier. Just point and click, yeah its very easy :-). </P> <p>
<P> Since this is still a beta version we do expect some bugs. By carefully reading this document you can easly install phpGroupWare. </P></DIR> We have reports of it working on Windows NT and OS/2, and using Oracle
</DIR> as the database.
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_REQUIREMENTS"></A>Chapter 3. Requirements</P><DIR> <p>
<DIR> <h2><a name="tth_sEc4">
<DIR> 4</a>&nbsp;&nbsp;Obtaining and Installing phpGroupWare </h2>
</B></FONT><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> <p>
<B><FONT FACE="Arial"><P><A NAME="_39"></A>3.1. Tested Systems</P> After you have met the system requirements, You can install it from
</B></FONT><P> On Linux 2.2.x </P> the TarBall or you can get it directly from CVS.
<FONT SIZE=2><P>&#9;</FONT>PHP 3.0.15+ / PHP 4.0.x</P>
<FONT SIZE=2><P>&#9;</FONT>Apache 1.3.x</P>
<FONT SIZE=2><P>&#9;</FONT>MySQL 3.22.25 or PostgreSQL 7.0.x</P>
<FONT SIZE=2><P>&#9;</FONT>Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access</P>
<P> We have reports of it working on Windows NT and OS/2, and using Oracle as the database.</P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_INSTALLING"></A>Chapter 4. Obtaining and Installing phpGroupWare</P><DIR> <p>
<DIR> <h3><a name="tth_sEc4.1">
<DIR> 4.1</a>&nbsp;&nbsp;Installing from TarBall </h3>
</B></FONT><P> After you have met the system requirements, You can install it from the TarBall or you can get it directly from CVS. </P></DIR> <p>
</DIR> Installing from a TarBall is very easy. The files should be installed
</DIR> in the webserver directory. Example steps (please adjust to your servers
config):
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TARBALLINS"></A>4.1. Installing from TarBall</P><DIR> <p>
<DIR> cp phpgroupware-version.tar.gz /home/httpd/html
<DIR>
</B></FONT><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> <p>
<FONT FACE="Courier New" SIZE=3><P>cp phpgroupware-version.tar.gz /home/httpd/html</P> cd /home/httpd/html
<P>cd /home/httpd/html</P>
<P>tar zxf phpgroupware-version.tar.gz</P>
<P> </P>
</FONT><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>
<P> You can get current releases of phpGroupWare at the phpGroupware <I>website</I> (http://www.phpgroupware.org/downloads.php). </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_CVSINS"></A>4.2. Installing from CVS</P><DIR> <p>
<DIR> tar zxf phpgroupware-version.tar.gz
<DIR>
</B></FONT><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> <p>
<FONT FACE="Courier New" SIZE=3><P>cd /home/httpd/html</P> You may have to get required permissions to do this. Contact your
<P>cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware login (just hit enter if prompted for a password)</P> system administrator if you dont have the permission to write to your
<P>cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co phpgroupware</P> webserver directory.
<P> </P>
</FONT><P> or if you prefer using CVSROOT: </P>
<FONT FACE="Courier New" SIZE=3><P>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'</P>
<P>cvs login (just hit enter if prompted for a password)</P>
<P>cvs co headlines</P>
<P> </P>
</FONT><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></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_FILEPERMS"></A>4.3. Setting File Permissions</P><DIR> <p>
<DIR> You can get current releases of phpGroupWare at the phpGroupware <em>website</em>
<DIR> (<a href="http://www.phpgroupware.org/downloads.php"><tt>http://www.phpgroupware.org/downloads.php</tt></a>).
</B></FONT><P> There are a few directories which will need special fie permissions set for phpGroupWare to work properly. </P> <p>
<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> <h3><a name="tth_sEc4.2">
<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> 4.2</a>&nbsp;&nbsp;Installing from CVS </h3>
<FONT FACE="Courier New" SIZE=3><P>chown nobody:nobody</P>
<P>chmod 700 /home/httpd/html/phpgroupware/files</P>
<P> </P>
</FONT><P> </P>
<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>
<FONT FACE="Courier New" SIZE=3><P>If you want to do it:</P>
<P>chown :nobody /home/httpd/html/phpgroupware</P>
<P>chmod 770</P>
<P> </P>
</FONT><P> </P>
<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></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="_75"></A>4.4. Setup / Configure phpGroupWare</P><DIR> <p>
<DIR> Installing from a CVS is fairly easy. The files should be checked
<DIR> out in the webserver directory. Example steps (please adjust to your
servers config):
</B></FONT><P> 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. </P><DIR> <p>
cd /home/httpd/html
<B><FONT FACE="Arial" SIZE=3><P>Note: </B>You are advised to backup your existing alpha database before running the setup script to avoid problems!</P></DIR> <p>
</DIR> cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
</DIR> login (just hit enter if prompted for a password)
</DIR>
</FONT><B><FONT FACE="Arial" SIZE=6><P><A NAME="_81"></A>4.5. Testing the install</P><DIR> <p>
<DIR> cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
<DIR> co phpgroupware
</B></FONT><P> If your config is setup properly you can now login. Point your browser to the installed location and login with the username <FONT FACE="Courier New" SIZE=3>demo</FONT> and the password is <FONT FACE="Courier New" SIZE=3>1234</FONT> </P> <p>
<P> At this point it would be a good idea to create a new user with administrative privileges and delete the old one. </P></DIR> or if you prefer using CVSROOT:
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="_87"></A>4.6. Installing additional applications</P><DIR> <p>
<DIR> export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'
<DIR>
</B></FONT><P> Once you have the core phpGroupWare install up and running, you may want to download and install additional applications. </P> <p>
<P> You should consult any <FONT FACE="Courier New" SIZE=3>README</FONT> or <FONT FACE="Courier New" SIZE=3>INSTALL</FONT> 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 <FONT FACE="Courier New" SIZE=3>lang.sql</FONT>) </P> cvs login (just hit enter if prompted for a password)
<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>
<P> For example, this is the process to install the Headlines application (see <I>http://sourceforge.net/phpgwapps/</I> (http://sourceforge.net/phpgwapps/) for more on this and other applications). </P>
<FONT SIZE=2><P>&#9;</FONT>Download the .tar.gz file for the application, or check out the source with cvs with </P>
<FONT FACE="Courier New" SIZE=3><P> export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'</P>
<P> cvs login (just hit enter if prompted for a password)</P>
<P> cvs co headlines</P>
<P> </P>
</FONT><FONT SIZE=2><P>&#9;</FONT>Move the <FONT FACE="Courier New" SIZE=3>headlines</FONT> directory into your phpGroupWare install directory.</P>
<FONT SIZE=2><P>&#9;</FONT>Log into phpGroupWare as an administrative user, and go to the Administration page. </P>
<FONT SIZE=2><P>&#9;</FONT>In the first section, choose the <FONT FACE="Courier New" SIZE=3>Applications</FONT> link. </P>
<FONT SIZE=2><P>&#9;</FONT>Click on add, and fill in the form.</P>
<P> Application name should be identical to the name of the directory you moved into the phpGroupWare install, in this case use <FONT FACE="Courier New" SIZE=3>headlines</FONT> </P>
<P> Application Title is shown in the navigation bar and other places to refer to the new application. Enter <FONT FACE="Courier New" SIZE=3>Headlines</FONT> for this example. </P>
<P> Enabled can be used to disable an application for all users temporially. You should normal check the box to enable the application. </P>
<FONT SIZE=2><P>&#9;</FONT>Back in the Administration page, you need to enable the application for specific users or user groups by editing them, and checking the new <FONT FACE="Courier New" SIZE=3>Headlines</FONT> box that appears in the middle of the account editing page.</P>
<FONT SIZE=2><P>&#9;</FONT>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>
<FONT SIZE=2><P>&#9;</FONT>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>
<P> </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_TROUBLE"></A>Chapter 5. Trouble Shooting</P><DIR> <p>
<DIR> cvs co phpgroupware
<DIR>
<DIR>
<DIR>
</FONT><FONT FACE="Arial" SIZE=5><P ALIGN="CENTER">Warning</P> <p>
</B></FONT><FONT FACE="Arial" SIZE=3><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> 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>&nbsp;</P></DIR> <p>
</DIR> <h3><a name="tth_sEc4.3">
4.3</a>&nbsp;&nbsp;Setting File Permissions </h3>
</FONT><P> 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> <p>
<P> Also check the FAQ in this directory for additional common questions, it is available as FAQ.sgml, FAQ.txt and FAQ.html </P></DIR> There are a few directories which will need special fie permissions
</DIR> set for phpGroupWare to work properly.
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TROB1"></A>5.1. I get "Unable to open mailbox" when using the email application</P><DIR> <p>
<DIR> Temp Directory (Required) - This can be /tmp for simplicity, but it
<DIR> is required for several apps to function properly. Simply make sure
that the webserver can add/delete files in it.
</B></FONT><P> 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. </P> <p>
<P> An preference page to edit the email settings is being developed, and should appear shortly after the first beta release. </P></DIR> Files Directory (Required) - This can be should be the files dir under
</DIR> the phpgroupware dir. You will need to give the webserver account
</DIR> owndership of this directory.
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TROB2"></A>5.2. It seems to hang when I try to read my mail</P><DIR> <p>
<DIR> chown nobody:nobody
<DIR>
</B></FONT><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> <p>
<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> chmod 700 /home/httpd/html/phpgroupware/files
<P> You can either clean up your mailbox with another mail program, or add the line </P>
<FONT FACE="Courier New" SIZE=3><P>set_time_limit(0);</P>
<P> </P>
</FONT><P> to the top of the phpgwapi/inc/phpgw_msg_pop3.inc.php file, just before the line <FONT FACE="Courier New" SIZE=3>class msg extends msg_common</FONT> </P>
<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></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TROB3"></A>5.3. When I log in I see the directory listing instead of a web page</P><DIR> <p>
<DIR> Root Directory (Not recommended) - If you give the webserver account
<DIR> 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.
</B></FONT><P>You are using Apache, this often means you need to add <FONT FACE="Courier New" SIZE=3>.php</FONT> to the <FONT FACE="Courier New" SIZE=3>DirectoryIndex</FONT> line in your httpd.conf file. For example: </P> <p>
<FONT FACE="Courier New" SIZE=3><P>DirectoryIndex index.php index.php3 index.html index.htm index.cgi</P> If you want to do it:
<P> </P>
</FONT><P> </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TROB4"></A>5.4. I get garbage that looks like code when I go to the phpGroupWare URL</P><DIR> <p>
<DIR> chown :nobody /home/httpd/html/phpgroupware
<DIR>
</B></FONT><P> This is often because you have php3 installed, which does not map <FONT FACE="Courier New" SIZE=3>.php</FONT> to the PHP engine. For PHP3: </P> <p>
<FONT FACE="Courier New" SIZE=3><P>AddType application/x-httpd-php3 .php3 .php</P> chmod 770
<P> </P>
</FONT><P>For PHP4: </P>
<FONT FACE="Courier New" SIZE=3><P>AddType application/x-httpd-php .php3 .php</P>
<P> </P>
</FONT><P> </P></DIR>
</DIR>
</DIR>
<P><A NAME="_159"></A></P> <p>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">VII. About</P> You may have to get required permissions to do this. Contact your
</FONT><FONT FACE="Arial" SIZE=6><P>Table of Contents</P><DIR> system administrator if you dont have the permission to write to your
<DIR> webserver directory.
<DIR>
<DIR>
</B></FONT><FONT SIZE=2><P></FONT><A HREF="#ID_HISTORY"><B>6. History of this document</B></A><B>&#9;</B><A HREF="#ID_HISTORY"><A HREF="#ID_HISTORY">*</A></A></P></DIR> <p>
<h3><a name="tth_sEc4.4">
4.4</a>&nbsp;&nbsp;Setup the database</h3>
<P> The newest version of this document can be found on our website <I>www.phpgroupware.org</I> (http://www.phpgroupware.org) as SGML source, HTML, or TEXT. </P> <p>
<P> Comments on this HOWTO should be directed to the phpGroupWare developers mailing list <I>phpgroupware-developers@lists.sourceforge.net</I> (mailto:phpgroupware-developers@lists.sourceforge.net) </P> <h4><a name="tth_sEc4.4.1">
<P> To subscribe, go to <I>http://sourceforge.net/mail/?group_id=7305</I> (http://sourceforge.net/mail/?group_id=7305) </P></DIR> 4.4.1</a>&nbsp;&nbsp;Mysql (assuming an existing and working Mysql install)</h4>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_HISTORY"></A>Chapter 6. History of this document</P><DIR> <p>
<DIR>
<DIR>
</FONT><FONT FACE="Arial"><P><A NAME="_173"></A>6.1. History</P> <ul><p>
</B></FONT><P> This document was started by Joseph Engo and reworked by Dan Kuykendall. </P> <li> Mandrake or Redhat: /etc/rc.d/init.d/mysqld start</li>
<B><FONT FACE="Arial"><P><A NAME="_176"></A>6.2. Version History</P> <p>
</B></FONT><P> Old Version </P> <li> other: /usr/local/mysql/bin/safe_mysqld &amp;</li>
<FONT SIZE=2><P>&#9;</FONT>Created by Jengo, wasn't in SGML HOWTO format.</P> <p>
<P> </P> <li> create the empty database: mysqldadmin -u someuser create phpgroupware
<P> v1.0 (July 6, 2000) </P> -p</li>
<P> </P> <p>
<FONT SIZE=2><P>&#9;</FONT>Built proper SGML version.</P> <li> login to mysql: mysql -u someuser -p</li>
<FONT SIZE=2><P>&#9;</FONT>Included the FAQ.</P> <p>
<FONT SIZE=2><P>&#9;</FONT>Other minor additions.</P> <li> issue the following at the mysql prompt:</li>
<P> </P> <p>
<P> v1.1 (September 27-29, 2000) - blinky </P> <li> grant all on phpgroupware.* to phpgroupware@localhost identified
<P> </P> by ``somepassword'';</li>
<FONT SIZE=2><P>&#9;</FONT>Added Testing Install section</P> </ul>
<FONT SIZE=2><P>&#9;</FONT>Added Trouble-shooting section</P> For more detailed user documentation on Mysql see their website :
<FONT SIZE=2><P>&#9;</FONT>Added description of application installation</P> <a href="http://www.mysql.com"><tt>http://www.mysql.com</tt></a>
<FONT SIZE=2><P>&#9;</FONT>Changes for the new setup program</P>
<P> </P> <p>
<P> v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format </P> <h4><a name="tth_sEc4.4.2">
<P> v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's idea and intregrated the Developers HOWTO. </P> 4.4.2</a>&nbsp;&nbsp;Postgresql (assuming an existing and working Postgresql install)</h4>
<P> v 0.xx (Somewhere in the near future) - gnrfan, Trail map comming up on how to hack and learn about coding phpGroupWare(core) and its apps too :-). </P></DIR>
</DIR> <p>
</DIR> To create the required database in Postgresql make sure postgresql
</BODY> is started:
</HTML>
<p>
<ul><p>
<li> Mandrake or Redhat : /etc/rc.d/init.d/postgresql start</li>
<p>
<li> others: pg_ctl -D /path/to/database/dir -p /path/to/postmaster start</li>
<p>
<li> create the empty database: createdb phpgroupware</li>
</ul>
For more detailed user documentation on Postgresql see their website
: <a href="http://www.postgresql.org"><tt>http://www.postgresql.org</tt></a>
<p>
<h3><a name="tth_sEc4.5">
4.5</a>&nbsp;&nbsp;Setup / Configure phpGroupWare </h3>
<p>
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.
<p>
<b>Note:</b> You are advised to backup your existing alpha database
before running the setup script to avoid problems!
<p>
<h3><a name="tth_sEc4.6">
4.6</a>&nbsp;&nbsp;Testing the install </h3>
<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>
<h3><a name="tth_sEc4.7">
4.7</a>&nbsp;&nbsp;Installing additional applications </h3>
<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 <a href="http://www.sourceforge.net/projects/phpgwapps"><tt>http://www.sourceforge.net/projects/phpgwapps</tt></a> 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>
<h2><a name="tth_sEc5">
5</a>&nbsp;&nbsp;Trouble Shooting</h2>
<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>
 The phpGroupWare developers can most often be seen hanging out in
<em>#phpGroupWare</em> on <em>irc.openprojects.net</em> 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>
<h3><a name="tth_sEc5.1">
5.1</a>&nbsp;&nbsp;It seems to hang when I try to read my mail </h3>
<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>
<h3><a name="tth_sEc5.2">
5.2</a>&nbsp;&nbsp;When I log in I see the directory listing instead of a web page </h3>
<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>
<h3><a name="tth_sEc5.3">
5.3</a>&nbsp;&nbsp;I get garbage that looks like code when I go to the phpGroupWare
URL </h3>
<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>
<h2><a name="tth_sEc6">
6</a>&nbsp;&nbsp;About this document</h2>
<p>
The newest version of this document can be found on our website <a href="http://www.phpgroupware.org"><tt>http://www.phpgroupware.org</tt></a>
as lyx source, HTML, or TEXT.
<p>
Comments on this HOWTO should be directed to the phpGroupWare developers
mailing list <em>phpgroupware-developers@lists.sourceforge.net</em>
<p>
To subscribe, go to <em><a href="http://sourceforge.net/mail/?group"><tt>http://sourceforge.net/mail/?group</tt></a>_id=7305</em>
<p>
<h3><a name="tth_sEc6.1">
6.1</a>&nbsp;&nbsp;History </h3>
<p>
This document was started by Joseph Engo reworked by Dan Kuykendall
then hacked again by Darryl VanDorp
<p>
<h3><a name="tth_sEc6.2">
6.2</a>&nbsp;&nbsp;Version History </h3>
<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
<br /><br /><hr /><small>File translated from
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 2.86.<br />On 10 Jan 2001, 23:02.</small>
</html>

616
doc/index.lyx Normal file
View File

@ -0,0 +1,616 @@
#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 2.17
\textclass article
\begin_preamble
\usepackage{fullpage, graphicx, url}
\setlength{\parskip}{1ex}
\setlength{\parindent}{0ex}
\title{phpGroupWare Docs V0}
\end_preamble
\language english
\inputencoding auto
\fontscheme default
\graphics default
\paperfontsize 10
\spacing single
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default
\layout Title
\series bold
phpGroupWare Docs V0.06
\layout Author
\series bold
Joseph Engo
\layout Author
\series bold
Dan Kuykendall
\series default
\layout Standard
$Id$
\layout Section*
Dedication
\layout Standard
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.
\layout Section
What is phpGroupWare
\layout Standard
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.
\layout Standard
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.
\layout Section
Why you should use it
\layout Standard
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?
\layout Section
Installation
\layout Standard
Installation and Configuration of phpGroupWare has never been easier.
Just point and click, yeah it's very easy.
\layout Standard
Since this is still a beta version we do expect some bugs.
By carefully reading this document you can easly install phpGroupWare.
\layout Subsection
Requirements
\layout Standard
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.
\layout Subsection
Tested Systems
\layout Standard
On Linux 2.2.x, 2.4.x
\layout Standard
PHP 3.0.15+ / PHP 4.0.x
\layout Standard
Apache 1.3.x
\layout Standard
MySQL 3.22.25 or PostgreSQL 7.0.x
\layout Standard
Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access
\layout Standard
We have reports of it working on Windows NT and OS/2, and using Oracle as
the database.
\layout Section
Obtaining and Installing phpGroupWare
\layout Standard
After you have met the system requirements, You can install it from the
TarBall or you can get it directly from CVS.
\layout Subsection
Installing from TarBall
\layout Standard
Installing from a TarBall is very easy.
The files should be installed in the webserver directory.
Example steps (please adjust to your servers config):
\layout Standard
cp phpgroupware-version.tar.gz /home/httpd/html
\layout Standard
cd /home/httpd/html
\layout Standard
tar zxf phpgroupware-version.tar.gz
\layout Standard
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.
\layout Standard
You can get current releases of phpGroupWare at the phpGroupware
\emph on
website
\emph default
(
\latex latex
\backslash
url{http://www.phpgroupware.org/downloads.php}
\latex default
).
\layout Subsection
Installing from CVS
\layout Standard
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):
\layout Standard
cd /home/httpd/html
\layout Standard
cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
login (just hit enter if prompted for a password)
\layout Standard
cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
co phpgroupware
\layout Standard
or if you prefer using CVSROOT:
\layout Standard
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgro
upware'
\layout Standard
cvs login (just hit enter if prompted for a password)
\layout Standard
cvs co phpgroupware
\layout Standard
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.
\layout Subsection
Setting File Permissions
\layout Standard
There are a few directories which will need special fie permissions set
for phpGroupWare to work properly.
\layout Standard
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.
\layout Standard
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.
\layout Standard
chown nobody:nobody
\layout Standard
chmod 700 /home/httpd/html/phpgroupware/files
\layout Standard
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.
\layout Standard
If you want to do it:
\layout Standard
chown :nobody /home/httpd/html/phpgroupware
\layout Standard
chmod 770
\layout Standard
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.
\layout Subsection
Setup the database
\layout Subsubsection
Mysql (assuming an existing and working Mysql install)
\layout Itemize
Mandrake or Redhat: /etc/rc.d/init.d/mysqld start
\layout Itemize
other: /usr/local/mysql/bin/safe_mysqld &
\layout Itemize
create the empty database: mysqldadmin -u someuser create phpgroupware -p
\layout Itemize
login to mysql: mysql -u someuser -p
\layout Itemize
issue the following at the mysql prompt:
\layout Itemize
grant all on phpgroupware.* to phpgroupware@localhost identified by
\begin_inset Quotes eld
\end_inset
somepassword
\begin_inset Quotes erd
\end_inset
;
\layout Standard
For more detailed user documentation on Mysql see their website :
\begin_inset LatexCommand \htmlurl{http://www.mysql.com}
\end_inset
\layout Subsubsection
Postgresql (assuming an existing and working Postgresql install)
\layout Standard
To create the required database in Postgresql make sure postgresql is started:
\layout Itemize
Mandrake or Redhat : /etc/rc.d/init.d/postgresql start
\layout Itemize
others: pg_ctl -D /path/to/database/dir -p /path/to/postmaster start
\layout Itemize
create the empty database: createdb phpgroupware
\layout Standard
For more detailed user documentation on Postgresql see their website :
\begin_inset LatexCommand \htmlurl{http://www.postgresql.org}
\end_inset
\layout Subsection
Setup / Configure phpGroupWare
\layout Standard
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.
\layout Standard
\series bold
Note:
\series default
You are advised to backup your existing alpha database before running the
setup script to avoid problems!
\layout Subsection
Testing the install
\layout Standard
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
\layout Standard
At this point it would be a good idea to create a new user with administrative
privileges and delete the old one.
\layout Subsection
Installing additional applications
\layout Standard
Once you have the core phpGroupWare install up and running, you may want
to download and install additional applications.
\layout Standard
You should consult any README or INSTALL files that come with the new applicatio
n 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)
\layout Standard
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.
\layout Standard
For example, this is the process to install the Headlines application:
\layout Standard
(see
\begin_inset LatexCommand \htmlurl{http://www.sourceforge.net/projects/phpgwapps}
\end_inset
for more applications)
\layout Standard
Download the .tar.gz file for the application, or check out the source with
cvs with
\layout Standard
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwa
pps'
\layout Standard
cvs login (just hit enter if prompted for a password)
\layout Standard
cvs co headlines
\layout Standard
Move the headlines directory into your phpGroupWare install directory.
\layout Standard
Log into phpGroupWare as an administrative user, and go to the Administration
page.
\layout Standard
In the first section, choose the Applications link.
\layout Standard
Click on add, and fill in the form.
\layout Standard
Application name should be identical to the name of the directory you moved
into the phpGroupWare install, in this case use headlines
\layout Standard
Application Title is shown in the navigation bar and other places to refer
to the new application.
Enter Headlines for this example.
\layout Standard
Enabled can be used to disable an application for all users temporially.
You should normal check the box to enable the application.
\layout Standard
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.
\layout Standard
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.
\layout Standard
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.
\layout Section
Trouble Shooting
\layout Standard
\series bold
Warning
\layout Standard
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.
\layout Standard
 The phpGroupWare developers can most often be seen hanging out in
\emph on
#phpGroupWare
\emph default
on
\emph on
irc.openprojects.net
\emph default
if you require real-time help.
\layout Standard
Also check the FAQ in this directory for additional common questions, it
is available as FAQ.sgml, FAQ.txt and FAQ.html
\layout Subsection
It seems to hang when I try to read my mail
\layout Standard
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.
\layout Standard
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.
\layout Standard
You can either clean up your mailbox with another mail program, or add the
line
\layout Standard
set_time_limit(0);
\layout Standard
to the top of the phpgwapi/inc/phpgw_msg_pop3.inc.php file, just before the
line class msg extends msg_common
\layout Standard
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.
\layout Subsection
When I log in I see the directory listing instead of a web page
\layout Standard
You are using Apache, this often means you need to add .php to the DirectoryIndex
line in your httpd.conf file.
For example:
\layout Standard
DirectoryIndex index.php index.php3 index.html index.htm index.cgi
\layout Subsection
I get garbage that looks like code when I go to the phpGroupWare URL
\layout Standard
This is often because you have php3 installed, which does not map .php to
the PHP engine.
For PHP3:
\layout Standard
AddType application/x-httpd-php3 .php3 .php
\layout Standard
For PHP4:
\layout Standard
AddType application/x-httpd-php .php3 .php
\layout Section
About this document
\layout Standard
The newest version of this document can be found on our website
\begin_inset LatexCommand \htmlurl{http://www.phpgroupware.org}
\end_inset
as lyx source, HTML, or TEXT.
\layout Standard
Comments on this HOWTO should be directed to the phpGroupWare developers
mailing list
\emph on
phpgroupware-developers@lists.sourceforge.net
\emph default
\layout Standard
To subscribe, go to
\emph on
\latex latex
\backslash
url{http://sourceforge.net/mail/?group}
\latex default
_id=7305
\emph default
\layout Subsection
History
\layout Standard
This document was started by Joseph Engo reworked by Dan Kuykendall then
hacked again by Darryl VanDorp
\layout Subsection
Version History
\layout Standard
Old Version
\layout Standard
Created by Jengo, wasn't in SGML HOWTO format.
\layout Standard
v1.0 (July 6, 2000)
\layout Standard
Built proper SGML version.
\layout Standard
Included the FAQ.
\layout Standard
Other minor additions.
\layout Standard
v1.1 (September 27-29, 2000) - blinky
\layout Standard
Added Testing Install section
\layout Standard
Added Trouble-shooting section
\layout Standard
Added description of application installation
\layout Standard
Changes for the new setup program
\layout Standard
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format
\layout Standard
v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's
idea and intregrated the Developers HOWTO.
\layout Standard
v.0.06 (Jan 10, 2001) - Darryl VanDorp, imported to lyx source reformatted
and touched up some sections
\the_end

BIN
doc/index.pdf Normal file

Binary file not shown.

View File

@ -1,334 +1,391 @@
phpGroupWare Docs V0.06
phpGroupWare Docs V0.05
Joseph Engo Joseph Engo
Dan Kuykendall
Dan Kuykendall
phpGroupWare Docs V0.05 $Id$
by Joseph Engo and Dan Kuykendall
Dedication Dedication
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.
Table of Contents Thanks to Joesph Engo for starting phpGroupWare (at the time
I. Introduction 000 called webdistro) and the core of this HOWTO. Thanks to
1. What is phpGroupWare 000 all the developers and users who contribute to making phpGroupWare
2. Why you should use it 000 such a success.
II. Installation 000
3. Requirements 000
3.1. Tested Systems 000
4. Obtaining and Installing phpGroupWare 000
4.1. Installing from TarBall 000
4.2. Installing from CVS 000
4.3. Setting File Permissions 000
4.4. Setup / Configure phpGroupWare 000
4.5. Testing the install 000
4.6. Installing additional applications 000
5. Trouble Shooting 000
5.1. I get "Unable to open mailbox" when using the email application 000
5.2. It seems to hang when I try to read my mail 000
5.3. When I log in I see the directory listing instead of a web page 000
5.4. I get garbage that looks like code when I go to the phpGroupWare URL 000
VII. About 000
6. History of this document 000
6.1. History 000
6.2. Version History 000
1 What is phpGroupWare
I. Introduction phpGroupWare is a web based GroupWare system. It comes with
Table of Contents serveral core apps for email, calendar, todo list, address
1. What is phpGroupWare 000 book, file manager, and a notepad.
2. Why you should use it 000
If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on.
Chapter 1. What is phpGroupWare It also provides a framework for add-on applications to integrate
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. seamlessly in phpGroupWare. Some samples are a bookmark
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. 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.
Chapter 2. Why you should use it 2 Why you should use it
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?
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?
II. Installation 3 Installation
Table of Contents
3. Requirements 000
4. Obtaining and Installing phpGroupWare 000
5. Trouble Shooting 000
Installation and Configuration of phpGroupWare has never been easier. Just point and click, yeah its very easy :-).
Since this is still a beta version we do expect some bugs. By carefully reading this document you can easly install phpGroupWare.
Chapter 3. Requirements Installation and Configuration of phpGroupWare has never
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. been easier. Just point and click, yeah it's very easy.
3.1. Tested Systems
On Linux 2.2.x Since this is still a beta version we do expect some bugs.
• PHP 3.0.15+ / PHP 4.0.x By carefully reading this document you can easly install
• Apache 1.3.x phpGroupWare.
• MySQL 3.22.25 or PostgreSQL 7.0.x
• Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access 3.1 Requirements
We have reports of it working on Windows NT and OS/2, and using Oracle as the database.
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.
3.2 Tested Systems
On Linux 2.2.x, 2.4.x
PHP 3.0.15+ / PHP 4.0.x
Apache 1.3.x
MySQL 3.22.25 or PostgreSQL 7.0.x
Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access
We have reports of it working on Windows NT and OS/2, and
using Oracle as the database.
4 Obtaining and Installing phpGroupWare
After you have met the system requirements, You can install
it from the TarBall or you can get it directly from CVS.
4.1 Installing from TarBall
Installing from a TarBall is very easy. The files should
be installed in the webserver directory. Example steps (please
adjust to your servers config):
Chapter 4. Obtaining and Installing phpGroupWare
After you have met the system requirements, You can install it from the TarBall or you can get it directly from CVS.
4.1. Installing from TarBall
Installing from a TarBall is very easy. The files should be installed in the webserver directory. Example steps (please adjust to your servers config):
cp phpgroupware-version.tar.gz /home/httpd/html cp phpgroupware-version.tar.gz /home/httpd/html
cd /home/httpd/html cd /home/httpd/html
tar zxf phpgroupware-version.tar.gz tar zxf phpgroupware-version.tar.gz
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. You may have to get required permissions to do this. Contact
You can get current releases of phpGroupWare at the phpGroupware website (http://www.phpgroupware.org/downloads.php). your system administrator if you dont have the permission
4.2. Installing from CVS to write to your webserver directory.
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):
You can get current releases of phpGroupWare at the phpGroupware
website ().
4.2 Installing from CVS
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):
cd /home/httpd/html 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 cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
login (just hit enter if prompted for a password)
or if you prefer using CVSROOT:
cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware
co phpgroupware
or if you prefer using CVSROOT:
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware' export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'
cvs login (just hit enter if prompted for a password)
cvs co headlines cvs login (just hit enter if prompted for a password)
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. cvs co phpgroupware
4.3. Setting File Permissions
There are a few directories which will need special fie permissions set for phpGroupWare to work properly. You may have to get required permissions to do this. Contact
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. your system administrator if you dont have the permission
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. to write to your webserver directory.
4.3 Setting File Permissions
There are a few directories which will need special fie permissions
set for phpGroupWare to work properly.
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.
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.
chown nobody:nobody chown nobody:nobody
chmod 700 /home/httpd/html/phpgroupware/files chmod 700 /home/httpd/html/phpgroupware/files
Root Directory (Not recommended) - If you give the webserver
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. 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.
If you want to do it: If you want to do it:
chown :nobody /home/httpd/html/phpgroupware chown :nobody /home/httpd/html/phpgroupware
chmod 770 chmod 770
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.
4.4. Setup / Configure phpGroupWare
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.
Note: You are advised to backup your existing alpha database before running the setup script to avoid problems!
4.5. Testing the install
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.6. Installing additional applications
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 copying the application directory into the phpGroupWare install location, and enabling the application through the Administration page.
For example, this is the process to install the Headlines application (see http://sourceforge.net/phpgwapps/ (http://sourceforge.net/phpgwapps/) for more on this and other applications).
• 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
• Move the headlines directory into your phpGroupWare install directory.
• Log into phpGroupWare as an administrative user, and go to the Administration page.
• In the first section, choose the Applications link.
• Click on add, and fill in the form.
Application name should be identical to the name of the directory you moved into the phpGroupWare install, in this case use headlines
Application Title is shown in the navigation bar and other places to refer to the new application. Enter Headlines for this example.
Enabled can be used to disable an application for all users temporially. You should normal check the box to enable the application.
• 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.
• 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.
• 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.
Chapter 5. Trouble Shooting You may have to get required permissions to do this. Contact
Warning your system administrator if you dont have the permission
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. to write to your webserver directory.
4.4 Setup the database
4.4.1 Mysql (assuming an existing and working Mysql install)
* Mandrake or Redhat: /etc/rc.d/init.d/mysqld start
* other: /usr/local/mysql/bin/safe_mysqld &
* create the empty database: mysqldadmin -u someuser create
phpgroupware -p
* login to mysql: mysql -u someuser -p
* issue the following at the mysql prompt:
* grant all on phpgroupware.* to phpgroupware@localhost identified
by "somepassword";
For more detailed user documentation on Mysql see their website
: [http://www.mysql.com]
4.4.2 Postgresql (assuming an existing and working Postgresql
install)
To create the required database in Postgresql make sure postgresql
is started:
* Mandrake or Redhat : /etc/rc.d/init.d/postgresql start
* others: pg_ctl -D /path/to/database/dir -p /path/to/postmaster
start
* create the empty database: createdb phpgroupware
For more detailed user documentation on Postgresql see their
website : [http://www.postgresql.org]
4.5 Setup / Configure phpGroupWare
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.
Note: You are advised to backup your existing alpha database
before running the setup script to avoid problems!
4.6 Testing the install
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.7 Installing additional applications
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 copying the application directory into the phpGroupWare
install location, and enabling the application through the
Administration page.
For example, this is the process to install the Headlines
application:
(see [http://www.sourceforge.net/projects/phpgwapps]
for more applications)
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
Move the headlines directory into your phpGroupWare install
directory.
Log into phpGroupWare as an administrative user, and go to
the Administration page.
In the first section, choose the Applications link.
Click on add, and fill in the form.
Application name should be identical to the name of the directory
you moved into the phpGroupWare install, in this case use
headlines
Application Title is shown in the navigation bar and other
places to refer to the new application. Enter Headlines
for this example.
Enabled can be used to disable an application for all users
temporially. You should normal check the box to enable the
application.
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.
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.
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 Trouble Shooting
Warning
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 most 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.1 It seems to hang when I try to read my mail
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
The phpGroupWare developers can most 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.1. I get "Unable to open mailbox" when using the email application
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.2. It seems to hang when I try to read my mail
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); set_time_limit(0);
to the top of the phpgwapi/inc/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.3. When I log in I see the directory listing instead of a web page
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.4. I get garbage that looks like code when I go to the phpGroupWare URL
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
to the top of the phpgwapi/inc/phpgw_msg_pop3.inc.php file,
just before the line class msg extends msg_common
VII. About If you choose to edit the file, be patient when loading a
Table of Contents large POP3 mailbox - the author tested against a mailbox
6. History of this document 000 with 2500 messages in it, but it took 15 minutes to load
The newest version of this document can be found on our website www.phpgroupware.org (http://www.phpgroupware.org) as SGML source, HTML, or TEXT. the page. We highly suggest you use IMAP if you expect to
Comments on this HOWTO should be directed to the phpGroupWare developers mailing list phpgroupware-developers@lists.sourceforge.net (mailto:phpgroupware-developers@lists.sourceforge.net) have more than a few hundred messages in your mailbox.
To subscribe, go to http://sourceforge.net/mail/?group_id=7305 (http://sourceforge.net/mail/?group_id=7305)
Chapter 6. History of this document 5.2 When I log in I see the directory listing instead of a
6.1. History web page
This document was started by Joseph Engo and reworked by Dan Kuykendall.
6.2. Version History
Old Version
• Created by Jengo, wasn't in SGML HOWTO format.
v1.0 (July 6, 2000)
• Built proper SGML version.
• Included the FAQ.
• Other minor additions.
v1.1 (September 27-29, 2000) - blinky
• Added Testing Install section
• Added Trouble-shooting section
• Added description of application installation
• Changes for the new setup program
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format
v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's idea and intregrated the Developers HOWTO.
v 0.xx (Somewhere in the near future) - gnrfan, Trail map comming up on how to hack and learn about coding phpGroupWare(core) and its apps too :-).
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.3 I get garbage that looks like code when I go to the phpGroupWare
URL
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 About this document
The newest version of this document can be found on our website
[http://www.phpgroupware.org] as lyx source, HTML, or TEXT.
Comments on this HOWTO should be directed to the phpGroupWare
developers mailing list phpgroupware-developers@lists.sourceforge.net
To subscribe, go to _id=7305
6.1 History
This document was started by Joseph Engo reworked by Dan
Kuykendall then hacked again by Darryl VanDorp
6.2 Version History
Old Version
Created by Jengo, wasn't in SGML HOWTO format.
v1.0 (July 6, 2000)
Built proper SGML version.
Included the FAQ.
Other minor additions.
v1.1 (September 27-29, 2000) - blinky
Added Testing Install section
Added Trouble-shooting section
Chapter 1. What is phpGroupWare Added description of application installation
Chapter 1. What is phpGroupWare Changes for the new setup program
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO
to DocBook format
v.0.05 (November 5, 2000) - gnrfan , Completely revamped
according to Seek's idea and intregrated the Developers
HOWTO.
Chapter 2. Why you should use it
Chapter 2. Why you should use it
Chapter 3. Requirements
Chapter 3. Requirements
Chapter 4. Obtaining and Installing phpGroupWare
Chapter 4. Obtaining and Installing phpGroupWare
Chapter 5. Trouble Shooting
Chapter 5. Trouble Shooting
Chapter 6. History of this document
Chapter 6. History of this document
v.0.06 (Jan 10, 2001) - Darryl VanDorp, imported to lyx source
reformatted and touched up some sections

View File

@ -1,65 +0,0 @@
<!doctype linuxdoc system>
<!-- LinuxDoc file was created by hand by <Dan Kuykendall> Sat July 15 -->
<article>
<title>
phpGroupWare FAQ
</title>
<author>
Dan Kuykendall &lt;dan@kuykendall.org&gt;
</author>
<date>
v1.0, 15 July 2000
</date>
<abstract>
phpGroupWare Frequently Asked Questions.
</abstract>
<toc>
<sect>Building and Installing
<sect1>Questions and Answers
<p>
Q: When I try to send file attachments, I get errors about safe mode being
effect.<newline>
A: I ran into this problem after I installed Aeromail for the first time.<newline>
Try chown root.root for all files in your /phpGroupWare directory. I don't know
why this is needed. Any ideas ?
<p>
Q: Why don't you just use the session class from phplib? Why not use cookies
to hold the sessionid?<newline>
A: I personally don't like using cookies for something like this.<newline>
However, the session management is currently being abstracted for the applications.
This means that switching to cookies will be possible for those that are interested.
<p>
Q: When I do a search, it returns the results but they have the wrong date.<newline>
A: Becuase of the way the tables are set up to handle repeating events,
I need to rewrite the query. I have not had a chance to play around with it
<p>
Q: When I view the calendar, I get tons of SQL errors.<newline>
A: Make sure all users on the system belong to a group. That should clear up
any problems. This is something that needs to be fixed.
<p>
Q: Will phpGroupWare run on PHP4 ?<newline>
A: Yes. It runs on both PHP3 and PHP4.
<p>
Q: Will phpGroupWare work with SSL ?<newline>
A: Sure, why not ? I am running it with mod_ssl and have had no problems.
Since there are no references to http:// or https:// there should not be
any problems with it.
<p>
Q: Does phpGroupWare work on any other databases ?<newline>
A: Right now, no. I have been playing around with support for mSQL, but, that
will take some time. Other databases are completly unknown at this point,
support for Oracle, MS-SQL, and others are planned for the future.
<p>
Q: I am having problems installing on PostgreSQL 6.x.<newline>
A: phpGroupWare is being developed with version 7.x. I tried installing it on
6.x and ran into a bunch of probelms. Unless you plan on toying around
with it, your better off with 7.x.
<p>
Q: Will phpGroupWare work with Windows?<newline>
A: Yes, there several people who are using it.<newline>
Thanks Vincent Larchet <&lt;vinz@users.sourceforge.net&gt;> for patching anything
we do that breaks phpGroupWare on NT.
</p>
</article>

View File

@ -1,72 +0,0 @@
<part label="VII">
<title>About</title>
<partintro>
<para>
The newest version of this document can be found on our website <ulink url="http://www.phpgroupware.org">
<citetitle>www.phpgroupware.org</citetitle></ulink> as SGML source, HTML, or TEXT.
</para>
<para>
Comments on this HOWTO should be directed to the phpGroupWare developers mailing list
<ulink url="mailto:phpgroupware-developers@lists.sourceforge.net">
<citetitle>phpgroupware-developers@lists.sourceforge.net</citetitle></ulink>
</para>
<para>
To subscribe, go to <ulink url="http://sourceforge.net/mail/?group_id=7305">
<citetitle>http://sourceforge.net/mail/?group_id=7305</citetitle></ulink>
</para>
</partintro>
<chapter id="history">
<title>History of this document</title>
<simplesect>
<title>History</title>
<para>
This document was started by Joseph Engo and reworked by Dan Kuykendall.
</para>
</simplesect>
<simplesect>
<title>Version History</title>
<para>
Old Version
<itemizedlist mark=bullet>
<listitem>
<para>Created by Jengo, wasn't in SGML HOWTO format.</para>
</listitem>
</itemizedlist>
</para>
<para>
v1.0 (July 6, 2000)
</para>
<para>
<itemizedlist mark=bullet>
<listitem><para>Built proper SGML version.</para></listitem>
<listitem><para>Included the FAQ.</para></listitem>
<listitem><para>Other minor additions.</para></listitem>
</itemizedlist>
</para>
<para>
v1.1 (September 27-29, 2000) - blinky
</para>
<para>
<itemizedlist mark=bullet>
<listitem><para>Added Testing Install section</para></listitem>
<listitem><para>Added Trouble-shooting section</para></listitem>
<listitem><para>Added description of application installation</para></listitem>
<listitem><para>Changes for the new setup program</para></listitem>
</itemizedlist>
</para>
<para>
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format
</para>
<para>
v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's
idea and intregrated the Developers HOWTO.
</para>
<para>
v 0.xx (Somewhere in the near future) - gnrfan, Trail map comming up on
how to hack and learn about coding phpGroupWare(core) and its
apps too :-).
</para>
</simplesect>
</chapter>
</part>

View File

@ -1,40 +0,0 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY installation SYSTEM "installation.sgml">
<!ENTITY about SYSTEM "about.sgml">
<!ENTITY requirements SYSTEM "requirements.sgml">
<!ENTITY installing SYSTEM "install.sgml">
<!ENTITY trouble SYSTEM "trouble.sgml">
]>
<book>
<title>phpGroupWare Docs V0.05</title>
<bookinfo>
<authorgroup>
<author>
<firstname>Joseph</firstname><surname>Engo</surname>
<authorblurb>
<para>jengo@phpgroupware.org</para>
</authorblurb>
<contrib><comment>the founder and active of phpgroupware</comment></contrib>
</author>
<author>
<firstname>Dan</firstname><surname>Kuykendall</surname>
<authorblurb>
<para>&lt;dan@kuykendall.org&gt</para>
</authorblurb>
<contrib><comment>the active developer of phpGroupWare</comment></contrib>
</author>
</authorgroup>
</bookinfo>
<dedication>
<para>
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.
</para>
</dedication>
&introduction;
&installation;
&about;
</book>

View File

@ -1,170 +0,0 @@
<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>

View File

@ -1,19 +0,0 @@
<part label="II">
<title>Installation</title>
<partintro>
<para>
Installation and Configuration of phpGroupWare has never been easier. Just point and click,
yeah its very easy :-).
</para>
<para>
Since this is still a beta version we do expect some bugs.
By carefully reading this document you can easly install phpGroupWare.
</para>
</partintro>
&requirements;
&installing;
&trouble;
</part>

View File

@ -1,27 +0,0 @@
<part label="I">
<title>Introduction</title>
<partintro>
<para>
If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on.
</para>
</partintro>
<chapter id="what">
<title>What is phpGroupWare</title>
<para>
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.
</para>
<para>
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.
</para>
</chapter>
<chapter id="why">
<title>Why you should use it</title>
<para>
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?
</para>
</chapter>
</part>

View File

@ -1,22 +0,0 @@
<chapter id="requirements">
<title>Requirements</title>
<para>
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.
</para>
<simplesect>
<title>Tested Systems</title>
<para>
On Linux 2.2.x
<itemizedlist mark=bullet>
<listitem><para>PHP 3.0.15+ / PHP 4.0.x</para></listitem>
<listitem><para>Apache 1.3.x</para></listitem>
<listitem><para>MySQL 3.22.25 or PostgreSQL 7.0.x</para></listitem>
<listitem><para>Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access</para></listitem>
</itemizedlist>
We have reports of it working on Windows NT and OS/2, and using Oracle as the database.</para>
</simplesect>
</chapter>

View File

@ -1,85 +0,0 @@
<chapter id="trouble">
<title>Trouble Shooting</title>
<warning>
<para>
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.
</para>
</warning>
<para>
The phpGroupWare developers can most often be seen hanging out in <emphasis>#phpGroupWare</emphasis>
on <emphasis>irc.openprojects.net</emphasis> if you require real-time help.
</para>
<para>
Also check the FAQ in this directory for additional common questions,
it is available as FAQ.sgml, FAQ.txt and FAQ.html
</para>
<sect1 id="trob1">
<title>I get "Unable to open mailbox" when using the email application</title>
<para>
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.
</para>
<para>
An preference page to edit the email settings is being developed, and should
appear shortly after the first beta release.
</para>
</sect1>
<sect1 id="trob2">
<title>It seems to hang when I try to read my mail</title>
<para>
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.
</para>
<para>
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.
</para>
<para>
You can either clean up your mailbox with another mail program, or
add the line
<programlisting>
set_time_limit(0);
</programlisting>
to the top of the phpgwapi/inc/phpgw_msg_pop3.inc.php file, just before
the line <classname>class msg extends msg_common</classname>
</para>
<para>
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.
</para>
</sect1>
<sect1 id="trob3">
<title>When I log in I see the directory listing instead of a web page</title>
<para>You are using Apache, this often means you need to add
<classname>.php</classname> to the <classname>DirectoryIndex</classname> line in your httpd.conf file.
For example:
<programlisting>
DirectoryIndex index.php index.php3 index.html index.htm index.cgi
</programlisting>
</para>
</sect1>
<sect1 id="trob4">
<title>I get garbage that looks like code when I go to the phpGroupWare URL</title>
<para>
This is often because you have php3 installed,
which does not map <classname>.php</classname> to the PHP engine.
For PHP3:
<programlisting>
AddType application/x-httpd-php3 .php3 .php
</programlisting>
For PHP4:
<programlisting>
AddType application/x-httpd-php .php3 .php
</programlisting>
</para>
</sect1>
</chapter>