holm/egroupware
1
1
Fork 0
forked from extern/egroupware
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new install docs

Browse Source
This commit is contained in:
seek3r 2001-01-05 09:17:04 +00:00
parent bc71ebf3e0
commit fc530443d0
14 changed files with 1472 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/CHANGELOG Executable file
View File

@ -0,0 +1 @@
See the CHANGELOG in phpgwapi/doc

1
doc/CREDITS Executable file
View File

@ -0,0 +1 @@
See the CREDITS in phpgwapi/doc

342
doc/LICENSE Executable file
View File

@ -0,0 +1,342 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 19yy <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19yy name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

1
doc/README Executable file
View File

@ -0,0 +1 @@
PLEASE SEE THE index.html OR index.txt files.

1
doc/SECURITY Executable file
View File

@ -0,0 +1 @@
See the SECURITY in phpgwapi/doc

357
doc/index.html Normal file
View File

@ -0,0 +1,357 @@
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
<META NAME="Generator" CONTENT="Microsoft Word 97">
<TITLE>phpGroupWare Docs V0</TITLE>
</HEAD>
<BODY>
<P>&nbsp;</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>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P>Table of Contents</P><DIR>
<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>
<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>
<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>
<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>
<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>
<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>
</DIR>
<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>
<DIR>
<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>
<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>
<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>
<FONT SIZE=2><P></FONT><A HREF="#_75">4.4. Setup / Configure phpGroupWare</A>&#9;<A HREF="#_75"><A HREF="#_75">*</A></A></P>
<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>
<DIR>
<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>
<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>
<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>
<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>
<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>
<DIR>
<FONT SIZE=2><P></FONT><A HREF="#_173">6.1. History</A>&#9;<A HREF="#_173"><A HREF="#_173">*</A></A></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>
</DIR>
</DIR>
</DIR>
</DIR>
</DIR>
</DIR>
<P><A NAME="_20"></A></P>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">I. Introduction</P>
</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_WHAT"><B>1. What is phpGroupWare</B></A><B>&#9;</B><A HREF="#ID_WHAT"><A HREF="#ID_WHAT">*</A></A></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>
<P> If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on. </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_WHAT"></A>Chapter 1. What is phpGroupWare</P><DIR>
<DIR>
<DIR>
</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> 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>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_WHY"></A>Chapter 2. Why you should use it</P><DIR>
<DIR>
<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>
</DIR>
</DIR>
<P><A NAME="_31"></A></P>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">II. Installation</P>
</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>
<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>
<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> Since this is still a beta version we do expect some bugs. By carefully reading this document you can easly install phpGroupWare. </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_REQUIREMENTS"></A>Chapter 3. Requirements</P><DIR>
<DIR>
<DIR>
</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>
<B><FONT FACE="Arial"><P><A NAME="_39"></A>3.1. Tested Systems</P>
</B></FONT><P> On Linux 2.2.x </P>
<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>
<DIR>
<DIR>
</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>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="ID_TARBALLINS"></A>4.1. Installing from TarBall</P><DIR>
<DIR>
<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>
<FONT FACE="Courier New" SIZE=3><P>cp phpgroupware-version.tar.gz /home/httpd/html</P>
<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>
<DIR>
<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>
<FONT FACE="Courier New" SIZE=3><P>cd /home/httpd/html</P>
<P>cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware login (just hit enter if prompted for a password)</P>
<P>cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co phpgroupware</P>
<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>
<DIR>
<DIR>
</B></FONT><P> There are a few directories which will need special fie permissions set for phpGroupWare to work properly. </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>
<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>
<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>
<DIR>
<DIR>
</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>
<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>
</DIR>
</DIR>
</DIR>
</FONT><B><FONT FACE="Arial" SIZE=6><P><A NAME="_81"></A>4.5. Testing the install</P><DIR>
<DIR>
<DIR>
</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> At this point it would be a good idea to create a new user with administrative privileges and delete the old one. </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=6><P><A NAME="_87"></A>4.6. Installing additional applications</P><DIR>
<DIR>
<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> 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>
<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>
<DIR>
<DIR>
<DIR>
<DIR>
</FONT><FONT FACE="Arial" SIZE=5><P ALIGN="CENTER">Warning</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>
<P>&nbsp;</P></DIR>
</DIR>
</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> Also check the FAQ in this directory for additional common questions, it is available as FAQ.sgml, FAQ.txt and FAQ.html </P></DIR>
</DIR>
</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>
<DIR>
<DIR>
</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> An preference page to edit the email settings is being developed, and should appear shortly after the first beta release. </P></DIR>
</DIR>
</DIR>
<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>
<DIR>
<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> 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>
<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>
<DIR>
<DIR>
</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>
<FONT FACE="Courier New" SIZE=3><P>DirectoryIndex index.php index.php3 index.html index.htm index.cgi</P>
<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>
<DIR>
<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>
<FONT FACE="Courier New" SIZE=3><P>AddType application/x-httpd-php3 .php3 .php</P>
<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>
<B><FONT FACE="Arial" SIZE=7><P ALIGN="CENTER">VII. About</P>
</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_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> 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> 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>
<P> To subscribe, go to <I>http://sourceforge.net/mail/?group_id=7305</I> (http://sourceforge.net/mail/?group_id=7305) </P></DIR>
</DIR>
</DIR>
<B><FONT FACE="Arial" SIZE=7><P><A NAME="ID_HISTORY"></A>Chapter 6. History of this document</P><DIR>
<DIR>
<DIR>
</FONT><FONT FACE="Arial"><P><A NAME="_173"></A>6.1. History</P>
</B></FONT><P> This document was started by Joseph Engo and reworked by Dan Kuykendall. </P>
<B><FONT FACE="Arial"><P><A NAME="_176"></A>6.2. Version History</P>
</B></FONT><P> Old Version </P>
<FONT SIZE=2><P>•&#9;</FONT>Created by Jengo, wasn't in SGML HOWTO format.</P>
<P> </P>
<P> v1.0 (July 6, 2000) </P>
<P> </P>
<FONT SIZE=2><P>•&#9;</FONT>Built proper SGML version.</P>
<FONT SIZE=2><P>•&#9;</FONT>Included the FAQ.</P>
<FONT SIZE=2><P>•&#9;</FONT>Other minor additions.</P>
<P> </P>
<P> v1.1 (September 27-29, 2000) - blinky </P>
<P> </P>
<FONT SIZE=2><P>•&#9;</FONT>Added Testing Install section</P>
<FONT SIZE=2><P>•&#9;</FONT>Added Trouble-shooting section</P>
<FONT SIZE=2><P>•&#9;</FONT>Added description of application installation</P>
<FONT SIZE=2><P>•&#9;</FONT>Changes for the new setup program</P>
<P> </P>
<P> v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format </P>
<P> v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's idea and intregrated the Developers HOWTO. </P>
<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>
</DIR>
</BODY>
</HTML>

334
doc/index.txt Normal file
View File

@ -0,0 +1,334 @@
phpGroupWare Docs V0.05
Joseph Engo
Dan Kuykendall
phpGroupWare Docs V0.05
by Joseph Engo and Dan Kuykendall
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
I. Introduction 000
1. What is phpGroupWare 000
2. Why you should use it 000
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
I. Introduction
Table of Contents
1. What is phpGroupWare 000
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
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.
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.
Chapter 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?
II. 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
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.1. Tested Systems
On Linux 2.2.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.
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
cd /home/httpd/html
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 can get current releases of phpGroupWare at the phpGroupware website (http://www.phpgroupware.org/downloads.php).
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
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
or if you prefer using CVSROOT:
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'
cvs login (just hit enter if prompted for a password)
cvs co headlines
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.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
chmod 700 /home/httpd/html/phpgroupware/files
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.
If you want to do it:
chown :nobody /home/httpd/html/phpgroupware
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
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. 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);
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
VII. About
Table of Contents
6. History of this document 000
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.
Comments on this HOWTO should be directed to the phpGroupWare developers mailing list phpgroupware-developers@lists.sourceforge.net (mailto:phpgroupware-developers@lists.sourceforge.net)
To subscribe, go to http://sourceforge.net/mail/?group_id=7305 (http://sourceforge.net/mail/?group_id=7305)
Chapter 6. History of this document
6.1. History
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 :-).
Chapter 1. What is phpGroupWare
Chapter 1. What is phpGroupWare
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

72
doc/sgml/about.sgml Normal file
View File

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

40
doc/sgml/index.sgml Normal file
View File

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

170
doc/sgml/install.sgml Normal file
View File

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

19
doc/sgml/installation.sgml Normal file
View File

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

27
doc/sgml/introduction.sgml Normal file
View File

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

22
doc/sgml/requirements.sgml Normal file
View File

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

85
doc/sgml/trouble.sgml Normal file
View File

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