diff --git a/doc/index.html b/doc/index.html index 7217ac281b..d551563a1f 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,357 +1,540 @@ - - - - -phpGroupWare Docs V0 - - + + + + + + + \textbf{phpGroupWare Docs V0.06} + +

phpGroupWare Docs V0.06

-

 

-

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.

- - +

Joseph Engo

-

Table of Contents

 - - - +

-

I. Introduction *

+

Dan Kuykendall

-

1. What is phpGroupWare *

-

2. Why you should use it *

 +

+$Id$ -

II. Installation *

+

-

3. Requirements *

- +

Dedication

-

3.1. Tested Systems *

 - +

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

4. Obtaining and Installing phpGroupWare *

- +

+

+1  What is phpGroupWare

-

4.1. Installing from TarBall *

-

4.2. Installing from CVS *

-

4.3. Setting File Permissions *

-

4.4. Setup / Configure phpGroupWare *

-

4.5. Testing the install *

-

4.6. Installing additional applications *

 - +

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

5. Trouble Shooting *

- +

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

5.1. I get "Unable to open mailbox" when using the email application *

-

5.2. It seems to hang when I try to read my mail *

-

5.3. When I log in I see the directory listing instead of a web page *

-

5.4. I get garbage that looks like code when I go to the phpGroupWare URL *

 - - +

+

+2  Why you should use it

-

VII. About *

+

+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? -

6. History of this document *

- +

+

+3  Installation

-

6.1. History *

-

6.2. Version History *

 - - - - - - +

+Installation and Configuration of phpGroupWare has never been easier. +Just point and click, yeah it's very easy. -

-

I. Introduction

-

Table of Contents

 - - - +

+Since this is still a beta version we do expect some bugs. By carefully +reading this document you can easly install phpGroupWare. -

1. What is phpGroupWare *

-

2. Why you should use it *

 +

+

+3.1  Requirements

-

If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on.

- - +

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

Chapter 1. What is phpGroupWare

- - +

+

+3.2  Tested Systems

-

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.

- - +

+On Linux 2.2.x, 2.4.x -

Chapter 2. Why you should use it

- - +

+PHP 3.0.15+ / PHP 4.0.x -

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?

- - +

+Apache 1.3.x -

-

II. Installation

-

Table of Contents

 - - - +

+MySQL 3.22.25 or PostgreSQL 7.0.x -

3. Requirements *

-

4. Obtaining and Installing phpGroupWare *

-

5. Trouble Shooting *

 +

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

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.

- - +

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

Chapter 3. Requirements

- - +

+

+4  Obtaining and Installing phpGroupWare

-

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.

 - - +

+After you have met the system requirements, You can install it from +the TarBall or you can get it directly from CVS. -

Chapter 4. Obtaining and Installing phpGroupWare

- - +

+

+4.1  Installing from TarBall

-

After you have met the system requirements, You can install it from the TarBall or you can get it directly from CVS.

- - +

+Installing from a TarBall is very easy. The files should be installed +in the webserver directory. Example steps (please adjust to your servers +config): -

4.1. Installing from TarBall

- - +

+cp phpgroupware-version.tar.gz /home/httpd/html -

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).

- - +

+cd /home/httpd/html -

4.2. Installing from CVS

- - +

+tar zxf phpgroupware-version.tar.gz -

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.

- - +

+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

- - +

+You can get current releases of phpGroupWare at the phpGroupware website +(http://www.phpgroupware.org/downloads.php). -

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.2  Installing from CVS

-

4.4. Setup / Configure phpGroupWare

 - - +

+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): -

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.

+

+cd /home/httpd/html -

Note: You are advised to backup your existing alpha database before running the setup script to avoid problems!

 - - - +

+cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware +login (just hit enter if prompted for a password) -

4.5. Testing the install

- - +

+cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware +co phpgroupware -

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.

- - +

+or if you prefer using CVSROOT: -

4.6. Installing additional applications

- - +

+export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware' -

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.

-

 - - +

+cvs login (just hit enter if prompted for a password) -

Chapter 5. Trouble Shooting

- - - - +

+cvs co phpgroupware -

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.

+

+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

-

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

- - +

+There are a few directories which will need special fie permissions +set for phpGroupWare to work properly. -

5.1. I get "Unable to open mailbox" when using the email application

- - +

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

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.

- - +

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

5.2. It seems to hang when I try to read my mail

- - +

+chown nobody:nobody -

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.

- - +

+chmod 700 /home/httpd/html/phpgroupware/files -

5.3. When I log in I see the directory listing instead of a web page

- - +

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

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

-

-

 - - +

+If you want to do it: -

5.4. I get garbage that looks like code when I go to the phpGroupWare URL

- - +

+chown :nobody /home/httpd/html/phpgroupware -

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

-

-

 - - +

+chmod 770 -

-

VII. About

-

Table of Contents

 - - - +

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

6. History of this document *

 +

+

+4.4  Setup the database

-

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)

- - +

+

+4.4.1  Mysql (assuming an existing and working Mysql install)

-

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 :-).

- - - - + +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: + +

+ +

+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 + +

+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.2  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.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 http://sourceforge.net/mail/?group_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 + +

+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.06 (Jan 10, 2001) - Darryl VanDorp, imported to lyx source reformatted +and touched up some sections + +

File translated from +TEX +by +TTH, +version 2.86.
On 10 Jan 2001, 23:02. + diff --git a/doc/index.lyx b/doc/index.lyx new file mode 100644 index 0000000000..56dd5a7593 --- /dev/null +++ b/doc/index.lyx @@ -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 diff --git a/doc/index.pdf b/doc/index.pdf new file mode 100644 index 0000000000..268fe45b3b Binary files /dev/null and b/doc/index.pdf differ diff --git a/doc/index.txt b/doc/index.txt index 5fc7b1eee7..fb67223cff 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,334 +1,391 @@ +phpGroupWare Docs V0.06 -phpGroupWare Docs V0.05 - Joseph Engo -Dan Kuykendall +Dan Kuykendall -phpGroupWare Docs V0.05 -by Joseph Engo and Dan Kuykendall +$Id$ -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. + Dedication -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 +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. +1 What is phpGroupWare -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. +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. -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. +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? +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. +3 Installation -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. +Installation and Configuration of phpGroupWare has never +been easier. Just point and click, yeah it's very easy. + +Since this is still a beta version we do expect some bugs. +By carefully reading this document you can easly install +phpGroupWare. + +3.1 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.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 + 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): + +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 (). + +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: + +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. + +cvs login (just hit enter if prompted for a password) + +cvs co phpgroupware + +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. + +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. +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 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); - - 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 -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) +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. -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 :-). - +5.2 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.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 - - - - - - -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.05 (November 5, 2000) - gnrfan , Completely revamped +according to Seek's idea and intregrated the Developers +HOWTO. +v.0.06 (Jan 10, 2001) - Darryl VanDorp, imported to lyx source +reformatted and touched up some sections diff --git a/doc/sgml/FAQ.sgml b/doc/sgml/FAQ.sgml deleted file mode 100644 index 5bd0c91442..0000000000 --- a/doc/sgml/FAQ.sgml +++ /dev/null @@ -1,65 +0,0 @@ - - - -
- - phpGroupWare FAQ - - - Dan Kuykendall <dan@kuykendall.org> - - - v1.0, 15 July 2000 - - - phpGroupWare Frequently Asked Questions. - - - -Building and Installing -Questions and Answers -

-Q: When I try to send file attachments, I get errors about safe mode being - effect. -A: I ran into this problem after I installed Aeromail for the first time. - Try chown root.root for all files in your /phpGroupWare directory. I don't know - why this is needed. Any ideas ? -

-Q: Why don't you just use the session class from phplib? Why not use cookies - to hold the sessionid? -A: I personally don't like using cookies for something like this. - 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. -

-Q: When I do a search, it returns the results but they have the wrong date. -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 -

-Q: When I view the calendar, I get tons of SQL errors. -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. -

-Q: Will phpGroupWare run on PHP4 ? -A: Yes. It runs on both PHP3 and PHP4. -

-Q: Will phpGroupWare work with SSL ? -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. -

-Q: Does phpGroupWare work on any other databases ? -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. -

-Q: I am having problems installing on PostgreSQL 6.x. -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. -

-Q: Will phpGroupWare work with Windows? -A: Yes, there several people who are using it. - Thanks Vincent Larchet <<vinz@users.sourceforge.net>> for patching anything - we do that breaks phpGroupWare on NT. -

-
diff --git a/doc/sgml/about.sgml b/doc/sgml/about.sgml deleted file mode 100644 index a938a5274e..0000000000 --- a/doc/sgml/about.sgml +++ /dev/null @@ -1,72 +0,0 @@ - - About - - - The newest version of this document can be found on our website - 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 - - - To subscribe, go to - http://sourceforge.net/mail/?group_id=7305 - - - - History of this document - - History - - This document was started by Joseph Engo and reworked by Dan Kuykendall. - - - - 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 :-). - - - - \ No newline at end of file diff --git a/doc/sgml/index.sgml b/doc/sgml/index.sgml deleted file mode 100644 index 05a0059b57..0000000000 --- a/doc/sgml/index.sgml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - -]> - - phpGroupWare Docs V0.05 - - - - JosephEngo - - jengo@phpgroupware.org - - the founder and active of phpgroupware - - - DanKuykendall - - <dan@kuykendall.org> - - the active developer of phpGroupWare - - - - - - 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. - - - -&introduction; -&installation; -&about; - - diff --git a/doc/sgml/install.sgml b/doc/sgml/install.sgml deleted file mode 100644 index bd0d703ebe..0000000000 --- a/doc/sgml/install.sgml +++ /dev/null @@ -1,170 +0,0 @@ - - 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. - - - 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. - - - - - 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. - - - - - 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. - - - - - 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! - - - - - 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. - - - - 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/ 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. - - - - diff --git a/doc/sgml/installation.sgml b/doc/sgml/installation.sgml deleted file mode 100644 index e62e0f6cce..0000000000 --- a/doc/sgml/installation.sgml +++ /dev/null @@ -1,19 +0,0 @@ - - - Installation - - - 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. - - - - -&requirements; -&installing; -&trouble; - diff --git a/doc/sgml/introduction.sgml b/doc/sgml/introduction.sgml deleted file mode 100644 index b6f3c4a687..0000000000 --- a/doc/sgml/introduction.sgml +++ /dev/null @@ -1,27 +0,0 @@ - - Introduction - - - If you wondering what phpGroupWare is, why you should use it, and how to do so. Then read on. - - - - 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. - - - - 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? - - - diff --git a/doc/sgml/requirements.sgml b/doc/sgml/requirements.sgml deleted file mode 100644 index 751362d5d5..0000000000 --- a/doc/sgml/requirements.sgml +++ /dev/null @@ -1,22 +0,0 @@ - - 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. - - - 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. - - diff --git a/doc/sgml/trouble.sgml b/doc/sgml/trouble.sgml deleted file mode 100644 index 33b53b3b42..0000000000 --- a/doc/sgml/trouble.sgml +++ /dev/null @@ -1,85 +0,0 @@ - - Trouble Shooting - - - 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 - - - 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. - - - - 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. - - - - 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 - - - - - 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 - - - - \ No newline at end of file