forked from extern/egroupware
160 lines
7.4 KiB
HTML
160 lines
7.4 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||
|
<HTML>
|
||
|
<HEAD>
|
||
|
<META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
|
||
|
<TITLE> phpGroupWare HOWTO</TITLE>
|
||
|
|
||
|
|
||
|
</HEAD>
|
||
|
<BODY>
|
||
|
<H1> phpGroupWare HOWTO</H1>
|
||
|
|
||
|
<H2>Joseph Engo <jengo@phpgroupware.org>,
|
||
|
Dan Kuykendall <dan@kuykendall.org></H2> v1.0, 7 July 2000
|
||
|
<P><HR>
|
||
|
<EM> This document explains how to install and configure phpGroupWare.</EM>
|
||
|
<HR>
|
||
|
<H2><A NAME="s1">1. Introduction</A></H2>
|
||
|
|
||
|
<P>phpGroupWare is a web based groupware application that includes integrated features such as
|
||
|
email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system.
|
||
|
<P>It should run on all systems where PHP is avalible and currently supports MySQL and PostgreSQL.
|
||
|
<H2>1.1 What is phpGroupWare and why should I use it?</H2>
|
||
|
|
||
|
<P>phpGroupWare is:
|
||
|
<P>phpGroupWare is a web based groupware application that includes integrated features such as
|
||
|
email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system.
|
||
|
<P>
|
||
|
<P>You should use it if:
|
||
|
<P>You would like a powerful groupware system that can be access from anywhere on the Internet.
|
||
|
For companies with a distributed user base, it's an ideal solution. Oh, and did I mention that its FREE?
|
||
|
<H2><A NAME="s2">2. Installation</A></H2>
|
||
|
|
||
|
<H2>2.1 Requirements</H2>
|
||
|
|
||
|
<P>You will need PHP compiled and installed on your system. You will also need MySQL or PostgreSQL setup.
|
||
|
If you are planning on using the email system, you will need to have an IMAP server installed and IMAP support compiled into PHP.
|
||
|
You can have it installed as an Apache module or command line version, the Apache module is prefered.
|
||
|
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.
|
||
|
<H2>2.2 Tested Systems</H2>
|
||
|
|
||
|
<P>On Linux 2.2.x
|
||
|
<UL>
|
||
|
<LI>PHP 3.0.15+ / PHP 4.0.x</LI>
|
||
|
<LI>Apache 1.3.x</LI>
|
||
|
<LI>MySQL 3.22.25 or PostgreSQL 7.0.x</LI>
|
||
|
<LI>Courier-IMAP 0.33+</LI>
|
||
|
</UL>
|
||
|
<P>We have reports of it working on Windows NT, but no details at this time.
|
||
|
<H2>2.3 Tested Systems</H2>
|
||
|
|
||
|
<P>After you have met the system requirements, unpack the tarball in the html
|
||
|
directory of your webserver. (eg, /home/httpd/html)
|
||
|
<P>The first step is to setup the database and create the tables needed. In the
|
||
|
doc directory there is a file called create_tables.(name of your database)
|
||
|
<H3>Installation with MySQL</H3>
|
||
|
|
||
|
<P>We will assume that you are using the database named phpgroupware.
|
||
|
<P><CODE>$ mysql phpgroupware -u username -p < create_tables.mysql</CODE>
|
||
|
<H3>Installation with PostgreSQL</H3>
|
||
|
|
||
|
<P>We will assume that you are using the database named phpgroupware.
|
||
|
<P><CODE>$ psql -d phpgroupware -U username < create_tables.pgsql</CODE>
|
||
|
<H2>2.4 Configure phpGroupWare</H2>
|
||
|
|
||
|
<P>Change to the inc directory. <BR>
|
||
|
Edit the file called config.inc.php to point to the location of your include files.
|
||
|
<BLOCKQUOTE><CODE>
|
||
|
Some people might prefer to install their include files in a directory which is not world viewable.
|
||
|
For this, you will need to move everything except config.inc.php into another directory
|
||
|
and point config.inc.php to that directory. For most installations, the current location
|
||
|
of these file should be fine.
|
||
|
</CODE></BLOCKQUOTE>
|
||
|
|
||
|
Edit globalconfig.inc.php to reflect your system settings. You can choose which programs
|
||
|
you would like to have available to your system.<BR>
|
||
|
For example, if you do not have access to a IMAP server, you can change
|
||
|
<CODE>$installed["email"] = "Y"; </CODE> to <CODE>$installed["email"] = "N";</CODE><BR>
|
||
|
This would make this program unavaiable to all users regardless of their permissions.
|
||
|
<P>If you are using the email system you will need to create a temporary directory
|
||
|
where file uploads will be stored. For security reasons, you should <CODE>chown
|
||
|
nobody.nobody</CODE> and <CODE>chmod 700</CODE> to that directory. Depending on your system configuration.
|
||
|
Default installs of Apache normally run as the user nobody. You may need your system
|
||
|
administrator to do this for you if you do not have root access.
|
||
|
<P>If you do not have access to root, create this file and run it.
|
||
|
<PRE>
|
||
|
<?php
|
||
|
if (mkdir("/path/to/temp/directory",0700)) {
|
||
|
echo "Directory created successfully";
|
||
|
} else {
|
||
|
echo "Error creating directory";
|
||
|
}
|
||
|
</PRE>
|
||
|
|
||
|
If you have access to cron, you may want to setup the files in the cron
|
||
|
directory.
|
||
|
<P>stalesessions.pl - There are 2 reasons for this file.
|
||
|
<UL>
|
||
|
<LI>Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk. </LI>
|
||
|
<LI>The email system requires plain text passwords which are stored in the sessions table.</LI>
|
||
|
</UL>
|
||
|
<P>This file is not required, you can simply uncomment the lines indicated in session.class in update_dla().
|
||
|
This will require an extra query during every transaction which could cause performance
|
||
|
problems. Also, if there are no logins in a few days, they will sit around and
|
||
|
wait for someone to login before they are deleted. If you go this route, you
|
||
|
will need to edit the number of seconds until they are deleted. It defaults to 2 hours
|
||
|
(7200 secs). If you choose to use the cron program, simply edit the settings
|
||
|
for your database and uncomment the line for your database type.
|
||
|
<P>stale_uploads.pl - This will delete file attachments for messages that where not
|
||
|
completed. If a users browser crashes, internet connection dies, etc, their
|
||
|
files will sit there forever unless deleted. You could add a few lines to
|
||
|
logout.php that will look in the temp directory for any stale uploads and delete
|
||
|
them. But, once again, it becomes a performance issue.
|
||
|
<P>If your config is setup properly you can now login. Point your browser to the
|
||
|
installed location and login with the username <CODE>demo</CODE> and the password is <CODE>1234</CODE><BR>
|
||
|
At this point it would be a good idea to create a new user and delete the old
|
||
|
one.
|
||
|
<H2><A NAME="s3">3. About this document</A></H2>
|
||
|
|
||
|
<H2>3.1 New versions </H2>
|
||
|
|
||
|
<P>The newest version of this document can be found on our website
|
||
|
<A HREF="http://www.phpgroupware.org">http://www.phpgroupware.org</A> as SGML source, HTML, or TEXT.
|
||
|
<H2>3.2 Comments </H2>
|
||
|
|
||
|
<P>Comments on this HOWTO should be directed to the phpGroupWare developers mailing list
|
||
|
<A HREF="mailto:phpgroupware-developers@lists.sourceforge.net">phpgroupware-developers@lists.sourceforge.net</A>.
|
||
|
<P>To subscribe, go to
|
||
|
<A HREF="http://sourceforge.net/mail/?group_id=7305">http://sourceforge.net/mail/?group_id=7305</A><H2>3.3 History </H2>
|
||
|
|
||
|
<P>This document was started by Joseph Engo and reworked by Dan Kuykendall.
|
||
|
<H2>3.4 Version History </H2>
|
||
|
|
||
|
<P>Old Version
|
||
|
<P>
|
||
|
<UL>
|
||
|
<LI>Created by Jengo, wasn't in SGML HOWTO format.</LI>
|
||
|
</UL>
|
||
|
<P>v1.0 (July 6, 2000)
|
||
|
<P>
|
||
|
<UL>
|
||
|
<LI>Built proper SGML version.</LI>
|
||
|
<LI>Included the FAQ.</LI>
|
||
|
<LI>Other minor additions.</LI>
|
||
|
</UL>
|
||
|
<H2>3.5 Copyrights and Trademarks </H2>
|
||
|
|
||
|
<P>Copyright (c) Dan Kuykendall.
|
||
|
Permission is granted to copy, distribute and/or modify this document
|
||
|
under the terms of the GNU Free Documentation License, Version 1.1
|
||
|
or any later version published by the Free Software Foundation
|
||
|
<P>A copy of the license is available at
|
||
|
<A HREF="http://www.gnu.org/copyleft/fdl.txt">GNU Free Documentation License</A>.
|
||
|
<H2>3.6 Acknowledgements and Thanks </H2>
|
||
|
|
||
|
<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.
|
||
|
</BODY>
|
||
|
</HTML>
|