egroupware/doc/HOWTO.txt
2000-09-07 21:10:17 +00:00

265 lines
7.2 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

phpGroupWare HOWTO
Joseph Engo <jengo@phpgroupware.org>, Dan Kuykendall
<dan@kuykendall.org>
v1.0, 7 July 2000
This document explains how to install and configure phpGroupWare.
______________________________________________________________________
Table of Contents
1. Introduction
1.1 What is phpGroupWare and why should I use it?
2. Installation
2.1 Requirements
2.2 Tested Systems
2.3 Tested Systems
2.3.1 Installation with MySQL
2.3.2 Installation with PostgreSQL
2.4 Configure phpGroupWare
3. About this document
3.1 New versions
3.2 Comments
3.3 History
3.4 Version History
3.5 Copyrights and Trademarks
3.6 Acknowledgements and Thanks
______________________________________________________________________
11.. IInnttrroodduuccttiioonn
phpGroupWare is a web based groupware application that includes
integrated features such as email, calendar, todo list, address book,
file manager, headline news, and a trouble ticket system.
It should run on all systems where PHP is avalible and currently
supports MySQL and PostgreSQL.
11..11.. WWhhaatt iiss pphhppGGrroouuppWWaarree aanndd wwhhyy sshhoouulldd II uussee iitt??
phpGroupWare is:
phpGroupWare is a web based groupware application that includes
integrated features such as email, calendar, todo list, address book,
file manager, headline news, and a trouble ticket system.
You should use it if:
You would like a powerful groupware system that can be access from
anywhere on the Internet. For companies with a distributed user base,
it's an ideal solution. Oh, and did I mention that its FREE?
22.. IInnssttaallllaattiioonn
22..11.. RReeqquuiirreemmeennttss
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.
22..22.. TTeesstteedd SSyysstteemmss
On Linux 2.2.x
+o PHP 3.0.15+ / PHP 4.0.x
+o Apache 1.3.x
+o MySQL 3.22.25 or PostgreSQL 7.0.x
+o Courier-IMAP 0.33+
We have reports of it working on Windows NT and OS/2.
22..33.. TTeesstteedd SSyysstteemmss
After you have met the system requirements, unpack the tarball in the
html directory of your webserver. (eg, /home/httpd/html)
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)
22..33..11.. IInnssttaallllaattiioonn wwiitthh MMyySSQQLL
We will assume that you are using the database named phpgroupware.
$ mysql phpgroupware -u username -p < create_tables.mysql Then add the
language entries (used for translation purposes).
$ mysql phpgroupware -u username -p < lang.sql
22..33..22.. IInnssttaallllaattiioonn wwiitthh PPoossttggrreeSSQQLL
We will assume that you are using the database named phpgroupware.
$ psql -d phpgroupware -U username < create_tables.pgsql Then add the
language entries (used for translation purposes).
$ psql -d phpgroupware -U username < lang.sql
22..44.. CCoonnffiigguurree pphhppGGrroouuppWWaarree
Change to the inc directory.
Edit globalconfig.inc.php to reflect your system settings.
If you are using the email system you will need to create a temporary
directory where file uploads will be stored. For security reasons,
you should chown nobody.nobody and chmod 700 to that directory.
Depending on your system configuration. Default installs of Apache
normally run as the user nobody. You may need your system
administrator to do this for you if you do not have root access.
If you do not have access to root, create this file and run it.
<?php
if (mkdir("/path/to/temp/directory",0700)) {
echo "Directory created successfully";
} else {
echo "Error creating directory";
}
If you have access to cron, you may want to setup the files in the
cron directory.
stalesessions.pl - There are 2 reasons for this file.
+o Users always forget to logout. This way the session doesn't sit
around forever, creating a possible security risk.
+o The email system requires plain text passwords which are stored in
the sessions table.
This file is not required, you can simply disable cron_apps in the
admin -> applications section to clean out the sessions table durring
login and logout.
stale_uploads.pl - This will delete file attachments for messages that
where not completed. If a users browser crashes, internet connection
dies, etc, their files will sit there forever unless deleted. You
could add a few lines to logout.php that will look in the temp
directory for any stale uploads and delete them. But, once again, it
becomes a performance issue.
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 and delete
the old one.
33.. AAbboouutt tthhiiss ddooccuummeenntt
33..11.. NNeeww vveerrssiioonnss
The newest version of this document can be found on our website
<http://www.phpgroupware.org> as SGML source, HTML, or TEXT.
33..22.. CCoommmmeennttss
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>
33..33.. HHiissttoorryy
This document was started by Joseph Engo and reworked by Dan
Kuykendall.
33..44.. VVeerrssiioonn HHiissttoorryy
Old Version
+o Created by Jengo, wasn't in SGML HOWTO format.
v1.0 (July 6, 2000)
+o Built proper SGML version.
+o Included the FAQ.
+o Other minor additions.
33..55.. CCooppyyrriigghhttss aanndd TTrraaddeemmaarrkkss
Copyright (c) Dan Kuykendall. Permission is granted to copy,
distribute and/or modify this document under the terms of the GNU Free
Documentation License, Version 1.1 or any later version published by
the Free Software Foundation
A copy of the license is available at GNU Free Documentation License
<http://www.gnu.org/copyleft/fdl.txt>.
33..66.. AAcckknnoowwlleeddggeemmeennttss aanndd TThhaannkkss
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.