diff --git a/doc/FAQ.html b/doc/FAQ.html deleted file mode 100644 index 767c79069c..0000000000 --- a/doc/FAQ.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - phpGroupWare FAQ - - - - -

phpGroupWare FAQ

- -

Dan Kuykendall <dan@kuykendall.org>

v1.0, 15 July 2000 -

- phpGroupWare Frequently Asked Questions. -
-

1. Building and Installing

- -

1.1 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/FAQ.txt b/doc/FAQ.txt deleted file mode 100644 index b515ac84e8..0000000000 --- a/doc/FAQ.txt +++ /dev/null @@ -1,132 +0,0 @@ - phpGroupWare FAQ - Dan Kuykendall - v1.0, 15 July 2000 - - phpGroupWare Frequently Asked Questions. - ______________________________________________________________________ - - Table of Contents - - - 1. Building and Installing - - 1.1 Questions and Answers - - - ______________________________________________________________________ - - 11.. BBuuiillddiinngg aanndd IInnssttaalllliinngg - - 11..11.. QQuueessttiioonnss aanndd AAnnsswweerrss - - 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 <> for patching - anything we do that breaks phpGroupWare on NT. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/HOWTO.html b/doc/HOWTO.html deleted file mode 100644 index ddbe43c496..0000000000 --- a/doc/HOWTO.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - phpGroupWare HOWTO - - - - -

phpGroupWare HOWTO

- -

Joseph Engo <jengo@phpgroupware.org>, - Dan Kuykendall <dan@kuykendall.org>, - Stephen Brown <blinky@phpgroupware.net>

v1.3, 17 October 2000 -

- This document explains how to install and configure phpGroupWare. -
-

1. Introduction

- -

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 available and currently supports MySQL and PostgreSQL. -

1.1 What is phpGroupWare and why should I use it?

- -

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

2. Installation

- -

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

2.2 Tested Systems

- -

Known compatible software -

-

Example configurations that the CVS versions have been up and running on are listed at the end of this document. -We have reports of phpGroupWare working on Windows NT and OS/2, and using Oracle as the database. -

2.3 Obtaining phpGroupWare

- -

While we are still in the Beta phase of phpGroupWare, you may -want to track the CVS copy as closely as possible. The released -versions are more stable, but often contain bugs that have been fixed -in the CVS version. -

Released Versions

- -

The downloads section on the -http://www.phpgroupware.org/ site -contains links to the most recent releases, and several mirror sites -for the releases. -

Developer's version from CVS

- -

If you have never used CVS, you may want to read through the doucmentation -found at -http://www.cvshome.org/. -The CVS pages for the core and apps projects can be found at -phpGroupWare Core CVS, and -phpGroupWare Apps CVS. -Follow the directions for Anonymous CVS access and you should -have the most recent development copy of phpGroupWare in no time. -

2.4 Installing on Tested Systems

- -

After you have met the additional software requirements (working DB, POP3/IMAP server, and PHP), -unpack the tarball in the html directory of your webserver. (eg, /home/httpd/html) -If you want the phpGroupWare install to appear at a URL other than -http://localhost/phpgroupware now is the time to rename the directory or move it -around under your document root. -

2.5 Create a database and user for phpGroupWare

- -

You must create a database for phpGroupWare to use, -and we strongly recommend adding a user that only -has permission to this new database for phpGroupWare's -exclusive use (for security). -

Note the host the database engine is on, user, password and database name, you will need them soon. -

Adding DB and users in MySQL

- -

The quick stepse to get going on mysql are as follows (please consult the offical MySQL -documentation for the details). -

mysqladmin create phpgroupware - creates the blank database -

Go into the mysql command line utility with mysql mysql or use -a tool like phpMyAdmin to update the permission tables. -It is recommended that you add a user with no permissions, then -explicitly grant the user access to the phpgroupware database. -The following SQL is an example, using the DB name of phpgroupware user of phpgwuser and password of somethinghardtoguess: -

-  insert into user(Host,User,Password) values('localhost','phpgwuser',PASSWORD('somethinghardtoguess');
-  insert into db(Host,DB,User,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv,Alter_priv)
-          values('localhost','phpgroupware','phpgwuser','Y','Y','Y','Y','Y','Y','Y')
-  
-
- -you must then reload the grant tables with mysqladmin reload or refresh privledges from the mysql utility. -

Some people find it even easier to use MySQL's grant command instead. Please consult the -MySQL manuall for details on correct syntax. -

PostgereSQL install

- -

This is from gnrfan but has yet to be updated for the recent version of phpGroupWare, although -it should get you started. -

To start the postmaster just type at the console: -$postmaster -i -D /home/[username]/[dataDir] -Now if there is an error then is no datadir intitiated (assuming that postgreSQL is installed). -To do that you have to use initdb to create the dataDIR. Please look in -the documentation of posgreSQL or the manual page for initdb for details. -

If you have not encountered any error than you are ready to roll. -Now create a database which will be used by the phpGroupWare. -To do that type at the console: -$createdb phpgroupware assumming that you would name the database phpgroupware. -

2.6 Configure phpGroupWare

- -

Copy the header.inc.php.sample file to -header.inc.php and edit the file, following the -directions in the comments. -

Then point your browser to phpgroupware/setup/ which will -create (or upgrade) the database tables. -You wil be asked to login, using the password set in -header.inc.php. Setup will attempt to determine what version -of the phpGroupWare database you have installed, and upgrade to the most recent -version. -

NOTE:The developers are concentrating on getting the beta -working, and have not spent a great deal of time building upgrade scripts from the -alpha versions of phpGroupWare. You are advised to backup your existing alpha -database before running the setup script to avoid problems! -

If you get no error messages, continue on to phpgroupware/setup/config.php -to configure phpGroupWare to your system. -

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

-

This file is not required, you can simply disable cron_apps in the admin -> applications section -to clean out the sessions table during 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. -

3. 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. 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 -placing the application directory under the root phpGroupWare directory, -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). -

-

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 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 second 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 inc/phpgwapi/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

- -

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

6. Known working systems

- -

A rough description of some of the hardware and software the developers have -used to develop phpGroupWare on, oh have confirmed working reports from people -in IRC. -

6.1 Seek3r has tested

- -

phpGroupWare.org runs: -Red Hat 6.2, Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL 3.23.10-alpha,Courier-IMAP 0.33+ with qmail 1.03 -

6.2 blinky has tested

- -

phpGroupWare.net runs: -Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1,MySQL 3.23.10-alpha,qmail 1.03 -

dev boxes are variants on: -Red Hat 7.0,mysql-3.23.22-6 (from RH7 RPM), and Sendmail, Courier, or qmail+courier IMAP depending on mood. -

6.3 Jengo has tested

- -

main test box: Red Hat 6.2,Apache/1.3.12,PHP 3.0.16,PostgreSQL 7.2,Sendmail (from RH6.2) -

laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd -

-Also, confirmation through IRC of phpGroupware working on Win2k with IIS5.0, PHP4.0.2 and MySQL just recently -

7. About this document

- -

7.1 New versions

- -

The newest version of this document can be found on our website -http://www.phpgroupware.org as SGML source, HTML, or TEXT. -

7.2 Comments

- -

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

7.3 History

- -

This document was started by Joseph Engo and reworked by Dan Kuykendall. -

7.4 Version History

- -

Old Version -

-

-

v1.0 (July 6, 2000) -

-

-

v1.1 (September 27-29, 2000) - blinky -

-

-

v1.2 (Early October 2000) - blinky -

-

-

7.5 Copyrights and Trademarks

- -

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

7.6 Acknowledgments and Thanks

- -

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. - - diff --git a/doc/HOWTO.sgml b/doc/HOWTO.sgml deleted file mode 100644 index 8046256d40..0000000000 --- a/doc/HOWTO.sgml +++ /dev/null @@ -1,418 +0,0 @@ - - - -

- - phpGroupWare HOWTO - - - Joseph Engo <jengo@phpgroupware.org>, - Dan Kuykendall <dan@kuykendall.org>, - Stephen Brown <blinky@phpgroupware.net> - - - v1.3, 17 October 2000 - - - - This document explains how to install and configure phpGroupWare. - - - -Introduction -

- 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 available and currently supports MySQL and PostgreSQL. -

-What is phpGroupWare and why should I use it? -

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

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

- Known compatible software - - PHP 3.0.15+ or PHP 4.0.x (preferred) - Apache 1.3.x - MySQL 3.22.25 or greater - MySQL 3.23.10 or greater - Courier IMAP 0.33+ for IMAP (optionally with vmailmgr) - qmail 1.03 for SMTP and POP - sendmail for SMTP - - - Example configurations that the CVS versions have been up and running on are listed at the end of this document. - We have reports of phpGroupWare working on Windows NT and OS/2, and using Oracle as the database. -

-Obtaining phpGroupWare -

-While we are still in the Beta phase of phpGroupWare, you may -want to track the CVS copy as closely as possible. The released -versions are more stable, but often contain bugs that have been fixed -in the CVS version. -Released Versions -

-The downloads section on the site -contains links to the most recent releases, and several mirror sites -for the releases. -

-Developer's version from CVS -

-If you have never used CVS, you may want to read through the doucmentation -found at . -The CVS pages for the core and apps projects can be found at -, and -. -Follow the directions for Anonymous CVS access and you should -have the most recent development copy of phpGroupWare in no time. -

- -Installing on Tested Systems -

- After you have met the additional software requirements (working DB, POP3/IMAP server, and PHP), - unpack the tarball in the html directory of your webserver. (eg, /home/httpd/html) - If you want the phpGroupWare install to appear at a URL other than - http://localhost/phpgroupware now is the time to rename the directory or move it - around under your document root. -

-Create a database and user for phpGroupWare -

- You must create a database for phpGroupWare to use, - and we strongly recommend adding a user that only - has permission to this new database for phpGroupWare's - exclusive use (for security). - - Note the host the database engine is on, user, password and database name, you will need them soon. - Adding DB and users in MySQL -

The quick stepse to get going on mysql are as follows (please consult the offical MySQL - documentation for the details). - - mysqladmin create phpgroupware - creates the blank database - - Go into the mysql command line utility with mysql mysql or use - a tool like phpMyAdmin to update the permission tables. - It is recommended that you add a user with no permissions, then - explicitly grant the user access to the phpgroupware database. - The following SQL is an example, using the DB name of phpgroupware user of phpgwuser and password of somethinghardtoguess: - - insert into user(Host,User,Password) values('localhost','phpgwuser',PASSWORD('somethinghardtoguess'); - insert into db(Host,DB,User,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv,Alter_priv) - values('localhost','phpgroupware','phpgwuser','Y','Y','Y','Y','Y','Y','Y') - - you must then reload the grant tables with mysqladmin reload or refresh privledges from the mysql utility. - - Some people find it even easier to use MySQL's grant command instead. Please consult the - MySQL manuall for details on correct syntax. -

- PostgereSQL install -

- This is from gnrfan but has yet to be updated for the recent version of phpGroupWare, although - it should get you started. - - To start the postmaster just type at the console: - $postmaster -i -D /home/[username]/[dataDir] - Now if there is an error then is no datadir intitiated (assuming that postgreSQL is installed). - To do that you have to use initdb to create the dataDIR. Please look in - the documentation of posgreSQL or the manual page for initdb for details. - - If you have not encountered any error than you are ready to roll. - Now create a database which will be used by the phpGroupWare. - To do that type at the console: - $createdb phpgroupware assumming that you would name the database phpgroupware. -

-Configure phpGroupWare -

- Copy the header.inc.php.sample file to - header.inc.php and edit the file, following the - directions in the comments. -

- Then point your browser to phpgroupware/setup/ which will - create (or upgrade) the database tables. - You wil be asked to login, using the password set in - header.inc.php. Setup will attempt to determine what version - of the phpGroupWare database you have installed, and upgrade to the most recent - version. - -NOTE:The developers are concentrating on getting the beta - working, and have not spent a great deal of time building upgrade scripts from the - alpha versions of phpGroupWare. You are advised to backup your existing alpha - database before running the setup script to avoid problems! - - If you get no error messages, continue on to phpgroupware/setup/config.php - to configure phpGroupWare to your system. -

- 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. - - - 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. - - Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk. - 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 during 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. -

- -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 -placing the application directory under the root phpGroupWare directory, -and enabling the application through the Administration page. - -For example, this is the process to install the -Headlines application (see 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. - -headlines -Headlines for this example. - -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. - -

-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 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 second 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 inc/phpgwapi/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 -

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

-Known working systems -

- A rough description of some of the hardware and software the developers have - used to develop phpGroupWare on, oh have confirmed working reports from people - in IRC. -

- Seek3r has tested -

- phpGroupWare.org runs: - Red Hat 6.2, Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL 3.23.10-alpha,Courier-IMAP 0.33+ with qmail 1.03 -

- blinky has tested -

- phpGroupWare.net runs: - Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1,MySQL 3.23.10-alpha,qmail 1.03 - - dev boxes are variants on: - Red Hat 7.0,mysql-3.23.22-6 (from RH7 RPM), and Sendmail, Courier, or qmail+courier IMAP depending on mood. -

- Jengo has tested -

- main test box: Red Hat 6.2,Apache/1.3.12,PHP 3.0.16,PostgreSQL 7.2,Sendmail (from RH6.2) - - laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd -

-

- Also, confirmation through IRC of phpGroupware working on Win2k with IIS5.0, PHP4.0.2 and MySQL just recently -

-About this document -New versions -

- The newest version of this document can be found on our website as SGML source, HTML, or TEXT. -

-Comments -

- Comments on this HOWTO should be directed to the phpGroupWare developers mailing list - .

- To subscribe, go to -

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

-

- v1.2 (Early October 2000) - blinky -

-

- - Info about creatign MySQL DB and user - Partial PostgreSQL info from gnrfan - -

-Copyrights and Trademarks -

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

-Acknowledgments and Thanks -

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

-
diff --git a/doc/HOWTO.txt b/doc/HOWTO.txt deleted file mode 100644 index 44ad62a521..0000000000 --- a/doc/HOWTO.txt +++ /dev/null @@ -1,594 +0,0 @@ - phpGroupWare HOWTO - Joseph Engo , Dan Kuykendall - , Stephen Brown - v1.3, 17 October 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 Obtaining phpGroupWare - 2.3.1 Released Versions - 2.3.2 Developer's version from CVS - 2.4 Installing on Tested Systems - 2.5 Create a database and user for phpGroupWare - 2.5.1 Adding DB and users in MySQL - 2.5.2 PostgereSQL install - 2.6 Configure phpGroupWare - - 3. Testing the install - - 4. Installing additional applications - - 5. Trouble-shooting - - 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 - - 6. Known working systems - - 6.1 Seek3r has tested - 6.2 blinky has tested - 6.3 Jengo has tested - - 7. About this document - - 7.1 New versions - 7.2 Comments - 7.3 History - 7.4 Version History - 7.5 Copyrights and Trademarks - 7.6 Acknowledgments 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 available 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 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. - - 22..22.. TTeesstteedd SSyysstteemmss - - Known compatible software - - +o PHP 3.0.15+ or PHP 4.0.x (preferred) - - +o Apache 1.3.x - - +o MySQL 3.22.25 or greater - - +o MySQL 3.23.10 or greater - - +o Courier IMAP 0.33+ for IMAP (optionally with vmailmgr) - - +o qmail 1.03 for SMTP and POP - - +o sendmail for SMTP - - Example configurations that the CVS versions have been up and running - on are listed at the end of this document. We have reports of - phpGroupWare working on Windows NT and OS/2, and using Oracle as the - database. - - 22..33.. OObbttaaiinniinngg pphhppGGrroouuppWWaarree - - While we are still in the Beta phase of phpGroupWare, you may want to - track the CVS copy as closely as possible. The released versions are - more stable, but often contain bugs that have been fixed in the CVS - version. - - 22..33..11.. RReelleeaasseedd VVeerrssiioonnss - - The downloads section on the site - contains links to the most recent releases, and several mirror sites - for the releases. - - - - 22..33..22.. DDeevveellooppeerr''ss vveerrssiioonn ffrroomm CCVVSS - - If you have never used CVS, you may want to read through the - doucmentation found at . The CVS pages for - the core and apps projects can be found at phpGroupWare Core CVS - , and phpGroupWare Apps CVS - . Follow the directions - for AAnnoonnyymmoouuss CCVVSS aacccceessss and you should have the most recent - development copy of phpGroupWare in no time. - - 22..44.. IInnssttaalllliinngg oonn TTeesstteedd SSyysstteemmss - - After you have met the additional software requirements (working DB, - POP3/IMAP server, and PHP), unpack the tarball in the html directory - of your webserver. (eg, /home/httpd/html) If you want the phpGroupWare - install to appear at a URL other than http://localhost/phpgroupware - now is the time to rename the directory or move it around under your - document root. - - 22..55.. CCrreeaattee aa ddaattaabbaassee aanndd uusseerr ffoorr pphhppGGrroouuppWWaarree - - You must create a database for phpGroupWare to use, and we strongly - recommend adding a user that only has permission to this new database - for phpGroupWare's exclusive use (for security). - - Note the host the database engine is on, user, password and database - name, you will need them soon. - - 22..55..11.. - - AAddddiinngg DDBB aanndd uusseerrss iinn MMyySSQQLL - - The quick stepse to get going on mysql are as follows (please consult - the offical MySQL documentation for the details). - - mysqladmin create phpgroupware - creates the blank database - - Go into the mysql command line utility with mysql mysql or use a tool - like phpMyAdmin to update the permission tables. It is recommended - that you add a user with no permissions, then explicitly grant the - user access to the phpgroupware database. The following SQL is an - example, using the DB name of phpgroupware user of phpgwuser and - password of somethinghardtoguess: - - insert into user(Host,User,Password) values('localhost','phpgwuser',PASSWORD('somethinghardtoguess'); - insert into db(Host,DB,User,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv,Alter_priv) - values('localhost','phpgroupware','phpgwuser','Y','Y','Y','Y','Y','Y','Y') - - - - you must then reload the grant tables with mysqladmin reload or - refresh privledges from the mysql utility. - - Some people find it even easier to use MySQL's grant command instead. - Please consult the MySQL manuall for details on correct syntax. - - 22..55..22.. - - PPoossttggeerreeSSQQLL iinnssttaallll - - This is from gnrfan but has yet to be updated for the recent version - of phpGroupWare, although it should get you started. - - To start the postmaster just type at the console: $postmaster -i -D - /home/[username]/[dataDir] Now if there is an error then is no datadir - intitiated (assuming that postgreSQL is installed). To do that you - have to use initdb to create the dataDIR. Please look in the - documentation of posgreSQL or the manual page for initdb for details. - - If you have not encountered any error than you are ready to roll. Now - create a database which will be used by the phpGroupWare. To do that - type at the console: $createdb phpgroupware assumming that you would - name the database phpgroupware. - - 22..66.. CCoonnffiigguurree pphhppGGrroouuppWWaarree - - Copy the header.inc.php.sample file to header.inc.php and edit the - file, following the directions in the comments. - - Then point your browser to phpgroupware/setup/ which will create (or - upgrade) the database tables. You wil be asked to login, using the - password set in header.inc.php. Setup will attempt to determine what - version of the phpGroupWare database you have installed, and upgrade - to the most recent version. - - NNOOTTEE::The developers are concentrating on getting the beta working, and - have not spent a great deal of time building upgrade scripts from the - alpha versions of phpGroupWare. You are advised to backup your - existing alpha database before running the setup script to avoid - problems! - - If you get no error messages, continue on to - phpgroupware/setup/config.php to configure phpGroupWare to your - system. - - 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. - - applications section to clean out the sessions table during - 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. - - 33.. TTeessttiinngg tthhee iinnssttaallll - - 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. - - 44.. IInnssttaalllliinngg aaddddiittiioonnaall aapppplliiccaattiioonnss - - 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 placing the application directory under the root phpGroupWare - directory, and enabling the application through the Administration - page. - - For example, this is the process to install the Headlines application - (see for more on this and other - applications). - - +o 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 - - - - +o Move the headlines directory into your phpGroupWare install - directory. - - +o Log into phpGroupWare as an administrative user, and go to the - Administration page. - - +o In the first section, choose the Applications link - - +o Click on add, and fill in the form. - - AApppplliiccaattiioonn nnaammee - should be identical to the name of the directory you moved into - the phpGroupWare install, in this case use headlines - - AApppplliiccaattiioonn TTiittllee - this is shown in the navigation bar and other places to refer to - the new application. Enter Headlines for this example. - - EEnnaabblleedd - This can be used to disable an application for all users - temporially. You should normal check the box to enable the - application. - - +o 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. - - +o 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. - - +o 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. - - 55.. TTrroouubbllee--sshhoooottiinngg - - WWAARRNNIINNGG!! 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 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 - - - 55..11.. II ggeett ""UUnnaabbllee ttoo ooppeenn mmaaiillbbooxx"" wwhheenn uussiinngg tthhee eemmaaiill aapppplliiccaattiioonn - - 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 second beta release. - - 55..22.. IItt sseeeemmss ttoo hhaanngg wwhheenn II ttrryy ttoo rreeaadd mmyy mmaaiill - - 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 inc/phpgwapi/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. - - - 55..33.. WWhheenn II lloogg iinn II sseeee tthhee ddiirreeccttoorryy lliissttiinngg iinnsstteeaadd ooff aa wweebb ppaaggee - - If 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 - ______________________________________________________________________ - - - - 55..44.. II ggeett ggaarrbbaaggee tthhaatt llooookkss lliikkee ccooddee wwhheenn II ggoo ttoo tthhee pphhppGGrroouuppWWaarree - UURRLL - - 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 - ______________________________________________________________________ - - - - 66.. KKnnoowwnn wwoorrkkiinngg ssyysstteemmss - - A rough description of some of the hardware and software the - developers have used to develop phpGroupWare on, oh have confirmed - working reports from people in IRC. - - 66..11.. - - SSeeeekk33rr hhaass tteesstteedd - - phpGroupWare.org runs: Red Hat 6.2, - Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL 3.23.10-alpha,Courier-IMAP - 0.33+ with qmail 1.03 - - 66..22.. - - bblliinnkkyy hhaass tteesstteedd - - phpGroupWare.net runs: Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 - mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1,MySQL 3.23.10-alpha,qmail 1.03 - - dev boxes are variants on: Red Hat 7.0,mysql-3.23.22-6 (from RH7 RPM), - and Sendmail, Courier, or qmail+courier IMAP depending on mood. - - 66..33.. - - JJeennggoo hhaass tteesstteedd - - main test box: Red Hat 6.2,Apache/1.3.12,PHP 3.0.16,PostgreSQL - 7.2,Sendmail (from RH6.2) - - - laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP - 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd - - - Also, confirmation through IRC of phpGroupware working on Win2k with - IIS5.0, PHP4.0.2 and MySQL just recently - - 77.. AAbboouutt tthhiiss ddooccuummeenntt - - 77..11.. NNeeww vveerrssiioonnss - - The newest version of this document can be found on our website - as SGML source, HTML, or TEXT. - - 77..22.. CCoommmmeennttss - - 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 - - - 77..33.. HHiissttoorryy - - This document was started by Joseph Engo and reworked by Dan - Kuykendall. - - 77..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. - - v1.1 (September 27-29, 2000) - blinky - - - +o Added Testing Install section - - +o Added Trouble-shooting section - - +o Added description of application installation - - +o Changes for the new setup program - - v1.2 (Early October 2000) - blinky - - - +o Info about creatign MySQL DB and user - - +o Partial PostgreSQL info from gnrfan - - 77..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 - . - - 77..66.. AAcckknnoowwlleeddggmmeennttss 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/INSTALL b/doc/INSTALL index c3cc62f90d..3ab422a0b4 100755 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -1,7 +1,5 @@ [ phpGroupWare ] -See the HOWTO for installation instructions. +See the index.html or index.txt for installation instructions. jengo@phpgroupware.org - - diff --git a/doc/README b/doc/README index d93c4c0865..71c6e1fc45 100755 --- a/doc/README +++ b/doc/README @@ -1,63 +1 @@ -** This file is mostly out of date, please see the HOWTO docs ** - -This program was created becuase I needed a more centralize means of conduting -my daily life. I have seen many great programs out there, calendars, todolist, -addressbooks, email, etc... But, there is a very common problem with 95% of -them, they don't like each other. ( The programs, not the people :) If I was -logged into the calendar and wanted to grab a phone number, I would have to -login to another app. Which became a real pain real quick. So, I search high -and low for something that would have all these systems tied in to one. Well, -I didn't find anything I really liked. So, I made my own. ( Isn't that the -driving force of 99% of Open Source apps ? :) - -Before I bore you to death, not all of these programs are written by me. Some, -I wrote my self. Some where downloaded and converted. All apps are released -under the GPL license. I would not use anything but. If you are intrested -in adding/recommending a program to be included in this ditro. Please, send -me the URL. I will not except restrictive licenses. I will only accept GPL -or freeware. If you are intrested in helping out with development, or think -you might be able to help out. Let me know what your plains are. - -You might have noticed there are a few references to programs that can't be -found anywhere in the archive or on the site. Thats becuase there not ready -yet. For example, pop_mail. This is a feature that will be added in the -future. It will give the admin control over who has POP-3 access for virtual -users. Becuase the system does not use nor require the user to have a shell -account on the system, a special POP-3 server is going to be used. It will -verify the user from the accounts table, then allow or disallow access to there -messages. I don't think this feature will be used too often, but, it gives -a nice bit of control for some added flexablity. Currently users that have -access to email will be required to have an account on the server. This will -change in the future. I am looking into other IMAP servers that can verify -logins through the accounts table. This will take some time for me to find the -best solution. - -Some things you should note on how this system works. Think of the navigation -bar as the glue sticking all of these apps together. It is handling the -login portions, session info and account info. If you notice the layout of -the directorys, it can give a good clue to how this system is layied out. - -/phpGroupWare - |- inc [ The common files used by the distro ] - |- addressbook [ File needed by the addressbook only ] - | |- inc [ The include files for the addressbook ] - | \- icons [ Images for the addressbook, unless commonly - | used through out the program ] - |- icons [ Images used throughout the program ] - -I think you can get the idea of it. Another thing that should be noted is the -structure of the database. Yes, it looks pretty odd, but, for the most part -makes a lot of sense. Lets say you didn't need the addressbook. Delete -/phpGroupWare/addressbook and change the settings in /phpGroupWare/config.inc There are -still a few references to it, like in the account table. But, there not used. -This is one of the main reasons I use $dbase->f("con") instead of $dbase->f(0) - -Which brings me to another point, I _try_ to use standared colum names through -out the database. con = control number, owner = the users loginid, -status = that records status. This makes it easier to keep track of what does -what. Refear to CODES in the doc directory. - -BTW: Please, ingnore my very poor spelling and grammer. I am a programmer - not an English teacher. - -Happy hacking :) +PLEASE SEE THE index.html OR index.txt files. diff --git a/doc/html/addressbook.html b/doc/html/addressbook.html new file mode 100644 index 0000000000..1b233eddf4 --- /dev/null +++ b/doc/html/addressbook.html @@ -0,0 +1,131 @@ +Using Addressbook
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
checking EmailUpUsing Calender
\ No newline at end of file diff --git a/doc/html/apidocs.html b/doc/html/apidocs.html new file mode 100644 index 0000000000..2d62d16db3 --- /dev/null +++ b/doc/html/apidocs.html @@ -0,0 +1,145 @@ + API documentation
phpGroupWare Docs V0.05
PrevNext

Chapter 23. API documentation

+ text for the API documentation chapter +

function1(or what ever)

the function you want to include seek. +

PrevHomeNext
add your topic seekUpAbout this document
\ No newline at end of file diff --git a/doc/html/app.html b/doc/html/app.html new file mode 100644 index 0000000000..adb89e2791 --- /dev/null +++ b/doc/html/app.html @@ -0,0 +1,168 @@ +Applications
phpGroupWare Docs V0.05
PrevNext

Chapter 21. Applications

Table of Contents
Installing
Updating

There r many applications been developed for phpGroupWare and there would be more + in the future. So insatallation of these application and as well as the future + applications has been made easy the developers. So what you have to do is to + just go to the Application section. +

PrevHomeNext
Maintaining AccountsUpUpdating
\ No newline at end of file diff --git a/doc/html/apphis.html b/doc/html/apphis.html new file mode 100644 index 0000000000..9b01afdfc7 --- /dev/null +++ b/doc/html/apphis.html @@ -0,0 +1,138 @@ +A short History
phpGroupWare Docs V0.05
PrevNext

Chapter 3. A short History

phpGroupWare started by Jengo (Joseph Engo) as an application to satisfy his girlfriends need for a webbased calendar/todo_list/email. + At the time it was called webdistro when Seek3r (Dan Kuykendall) discovered this promising project. + The two joined up together and between Seek3r's API design and Jengo's programming skills they renamed the project phpGroupWare and started building the application around the phpgwAPI. +

During this period Seek3r took over project management to free Jengo up to do more development. + This duo worked hard to build a sucessful community around the project. Their efforts paid off, and the project is what it is today due to the efforts of the developers who have joined this community. +

PrevHomeNext
Why should you use itUpCopyright
\ No newline at end of file diff --git a/doc/html/book1.html b/doc/html/book1.html new file mode 100644 index 0000000000..c47f5ab71a --- /dev/null +++ b/doc/html/book1.html @@ -0,0 +1,414 @@ +phpGroupWare Docs V0.05

Dedication

Thanks to Joesph Engo for starting phpGroupWare (at the time called webdistro) and the core of this HOWTO. + Thanks to all the developers and users who contribute to making phpGroupWare such a success. +

Table of Contents
I. Introduction
1. What is phpGroupWare
2. Why should you use it
3. A short History
4. Copyright
II. Installation
5. Requirements
Tested Systems
6. Obtaining phpGroupWare
Released Versions
Developer's version from CVS
7. Installation Steps
Installing from TarBall
Installing from CVS
Setup / Configure phpGroupWare
Testing the install
Installing additional applications
8. Trouble Shooting
I get "Unable to open mailbox" when using the email application
It seems to hang when I try to read my mail
When I log in I see the directory listing instead of a web page
I get garbage that looks like code when I go to the phpGroupWare URL
III. Using phpGroupWare
9. Loging into phpgw
10. checking Email
11. Using Addressbook
12. Using Calender
13. Managing Files with file manager
14. Getting Headlines
15. Human Resources
16. Preferences
17. Using todo
18. Using Trouble ticket
IV. Administering phpGroupWare
19. User Accounts
Creating Accounts
Maintaining Accounts
20. Group Accounts
Creating Accounts
Maintaining Accounts
21. Applications
Installing
Updating
V. Developers Documentation
22. Developing Add-On Apps
Requirements
add your topic seek
23. API documentation
function1(or what ever)
VII. About this document
  Next
  Introduction
\ No newline at end of file diff --git a/doc/html/calender.html b/doc/html/calender.html new file mode 100644 index 0000000000..751967e88e --- /dev/null +++ b/doc/html/calender.html @@ -0,0 +1,131 @@ +Using Calender
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Using AddressbookUpManaging Files with file manager
\ No newline at end of file diff --git a/doc/html/checkmail.html b/doc/html/checkmail.html new file mode 100644 index 0000000000..b3bfe6d4be --- /dev/null +++ b/doc/html/checkmail.html @@ -0,0 +1,131 @@ +checking Email
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Loging into phpgwUpUsing Addressbook
\ No newline at end of file diff --git a/doc/html/copyright.html b/doc/html/copyright.html new file mode 100644 index 0000000000..db00894002 --- /dev/null +++ b/doc/html/copyright.html @@ -0,0 +1,147 @@ +Copyright
phpGroupWare Docs V0.05
PrevNext

Chapter 4. Copyright

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

PrevHomeNext
A short HistoryUpInstallation
\ No newline at end of file diff --git a/doc/html/cvsins.html b/doc/html/cvsins.html new file mode 100644 index 0000000000..336f3f729b --- /dev/null +++ b/doc/html/cvsins.html @@ -0,0 +1,160 @@ +Installing from CVS
phpGroupWare Docs V0.05
PrevChapter 7. Installation StepsNext

Installing from CVS

Grabbing a copy from CVS is not as hard as it may seem. You will need to have a cvs client installed. + Then try the following commands: +

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

cvs login (just hit enter when prompted for a password)

cvs checkout phpgroupware

+ If you need to install into a different dirname, you can add ' -d dirname' after 'checkout' and before 'phpgroupware'. + The commands would look like this: +

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

cvs login (just hit enter when prompted for a password)

cvs checkout -d dirname phpgroupware

+

PrevHomeNext
Installation StepsUpSetup / Configure phpGroupWare
\ No newline at end of file diff --git a/doc/html/devaddapp.html b/doc/html/devaddapp.html new file mode 100644 index 0000000000..2215489d3b --- /dev/null +++ b/doc/html/devaddapp.html @@ -0,0 +1,162 @@ +Developing Add-On Apps
phpGroupWare Docs V0.05
PrevNext

Chapter 22. Developing Add-On Apps

text for developin add on apps (seek its your area)

Requirements

text for requirements +

PrevHomeNext
Developers DocumentationUpadd your topic seek
\ No newline at end of file diff --git a/doc/html/etc.html b/doc/html/etc.html new file mode 100644 index 0000000000..23b471df3f --- /dev/null +++ b/doc/html/etc.html @@ -0,0 +1,133 @@ +add your topic seek
phpGroupWare Docs V0.05
PrevChapter 22. Developing Add-On AppsNext

add your topic seek

text for the appropriate topic +

PrevHomeNext
Developing Add-On AppsUpAPI documentation
\ No newline at end of file diff --git a/doc/html/fileman.html b/doc/html/fileman.html new file mode 100644 index 0000000000..ec96fbbf5b --- /dev/null +++ b/doc/html/fileman.html @@ -0,0 +1,131 @@ +Managing Files with file manager
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Using CalenderUpGetting Headlines
\ No newline at end of file diff --git a/doc/html/groupacc.html b/doc/html/groupacc.html new file mode 100644 index 0000000000..c3fb55b2fc --- /dev/null +++ b/doc/html/groupacc.html @@ -0,0 +1,172 @@ +Group Accounts
phpGroupWare Docs V0.05
PrevNext

Chapter 20. Group Accounts

Enter the User Group section. You would see + the current user groups. +

Creating Accounts

Click the Add button. Now fill the form by + selecting the existing users and the persmissions you want to include + in the new group.And you r done. +

PrevHomeNext
Maintaining AccountsUpMaintaining Accounts
\ No newline at end of file diff --git a/doc/html/headlines.html b/doc/html/headlines.html new file mode 100644 index 0000000000..ab6d8f6c2a --- /dev/null +++ b/doc/html/headlines.html @@ -0,0 +1,131 @@ +Getting Headlines
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Managing Files with file managerUpHuman Resources
\ No newline at end of file diff --git a/doc/html/hr.html b/doc/html/hr.html new file mode 100644 index 0000000000..6b87cbd602 --- /dev/null +++ b/doc/html/hr.html @@ -0,0 +1,131 @@ +Human Resources
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Getting HeadlinesUpPreferences
\ No newline at end of file diff --git a/doc/html/installing.html b/doc/html/installing.html new file mode 100644 index 0000000000..8710fb5d81 --- /dev/null +++ b/doc/html/installing.html @@ -0,0 +1,187 @@ +Installation Steps
phpGroupWare Docs V0.05
PrevNext

Chapter 7. Installation Steps

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

The files should be installed in the webserver directory. So all you need to + do is unpack the tar ball and copy the whole directory to the webserver directory +

(eg. /home/httpd/html for default apache configuration in many linux distros). +

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

PrevHomeNext
Obtaining phpGroupWareUpInstalling from CVS
\ No newline at end of file diff --git a/doc/html/logingin.html b/doc/html/logingin.html new file mode 100644 index 0000000000..c8bf808eee --- /dev/null +++ b/doc/html/logingin.html @@ -0,0 +1,144 @@ +Loging into phpgw
phpGroupWare Docs V0.05
PrevNext

Chapter 9. Loging into phpgw

After your setup you can point your browser to index.php in the + installation directory. If the set up was right you can login with user name demo + and the password is 1234> Now it is recommended to + create a new user with administrative privileges and delete the old one. +

PrevHomeNext
Using phpGroupWareUpchecking Email
\ No newline at end of file diff --git a/doc/html/maintaing.html b/doc/html/maintaing.html new file mode 100644 index 0000000000..cfd9909c77 --- /dev/null +++ b/doc/html/maintaing.html @@ -0,0 +1,134 @@ +Maintaining Accounts
phpGroupWare Docs V0.05
PrevChapter 20. Group AccountsNext

Maintaining Accounts

One has always a option to view and edit the groups when ever + needed +

PrevHomeNext
Group AccountsUpApplications
\ No newline at end of file diff --git a/doc/html/maintainu.html b/doc/html/maintainu.html new file mode 100644 index 0000000000..aa85a7c250 --- /dev/null +++ b/doc/html/maintainu.html @@ -0,0 +1,140 @@ +Maintaining Accounts
phpGroupWare Docs V0.05
PrevChapter 19. User AccountsNext

Maintaining Accounts

Maintaining user accounts is also very easy. Just go to the + User Accounts section . Now you can see + the list of the current users and there logins. You + can now either view their ops or can even edit them. + FIXMEAGIN: need i say anything more :->. +

PrevHomeNext
User AccountsUpGroup Accounts
\ No newline at end of file diff --git a/doc/html/obtaining.html b/doc/html/obtaining.html new file mode 100644 index 0000000000..74f2b5de97 --- /dev/null +++ b/doc/html/obtaining.html @@ -0,0 +1,218 @@ +Obtaining phpGroupWare
phpGroupWare Docs V0.05
PrevNext

Chapter 6. Obtaining phpGroupWare

While we are still in the Beta phase of phpGroupWare, you may + want to track the CVS copy as closely as possible. The released + versions are more stable, but often contain bugs that have been fixed + in the CVS version. +

Released Versions

The downloads section on the site + contains links to the most recent releases, and several mirror sites + for the releases. +

Developer's version from CVS

If you have never used CVS, you may want to read through the doucmentation + found at www.cvshome.org + . + The CVS pages for the core and apps projects can be found at + phpGroupWare Core CVS + , and phpGroupWare Apps CVS. + Follow the directions for Anonymous CVS access and you should + have the most recent development copy of phpGroupWare in no time. +

PrevHomeNext
RequirementsUpInstallation Steps
\ No newline at end of file diff --git a/doc/html/p21.html b/doc/html/p21.html new file mode 100644 index 0000000000..ad5ad74f56 --- /dev/null +++ b/doc/html/p21.html @@ -0,0 +1,168 @@ +Introduction
phpGroupWare Docs V0.05
PrevNext

I. Introduction

Do yo have questions on using phpGroupWare , like What? Why? What for? What's in for me? +

Then you should seriously read this doc :-). +

PrevHomeNext
phpGroupWare Docs V0.05 What is phpGroupWare
\ No newline at end of file diff --git a/doc/html/p237.html b/doc/html/p237.html new file mode 100644 index 0000000000..3983af89d1 --- /dev/null +++ b/doc/html/p237.html @@ -0,0 +1,196 @@ +Using phpGroupWare
phpGroupWare Docs V0.05
PrevNext

III. Using phpGroupWare

Using phpGroupWare is a cake walk , thats what people say :-). Reading this doc would + definitely give a head start. If you ever come cross any problem please report to +

PrevHomeNext
I get garbage that looks like code when I go to the phpGroupWare URL Loging into phpgw
\ No newline at end of file diff --git a/doc/html/p274.html b/doc/html/p274.html new file mode 100644 index 0000000000..c015923f1f --- /dev/null +++ b/doc/html/p274.html @@ -0,0 +1,162 @@ +Administering phpGroupWare
phpGroupWare Docs V0.05
PrevNext

IV. Administering phpGroupWare

To administer phpGroupWare you need not be a PHP hacker. All you need to do is again just + point and click. And hey just a bit of typing too. :). You need to login to phpGroupWare + and click the Administration image. +

Table of Contents
19. User Accounts
20. Group Accounts
21. Applications
PrevHomeNext
Using Trouble ticket User Accounts
\ No newline at end of file diff --git a/doc/html/p312.html b/doc/html/p312.html new file mode 100644 index 0000000000..693bfd0854 --- /dev/null +++ b/doc/html/p312.html @@ -0,0 +1,157 @@ +Developers Documentation
phpGroupWare Docs V0.05
PrevNext

V. Developers Documentation

This documentation is for developers who want to hack into the core of the + phpGroupWare. Please follow this documentation carefully before u take a jump into + the code :) +

PrevHomeNext
Updating Developing Add-On Apps
\ No newline at end of file diff --git a/doc/html/p331.html b/doc/html/p331.html new file mode 100644 index 0000000000..e90b6ee110 --- /dev/null +++ b/doc/html/p331.html @@ -0,0 +1,267 @@ +About this document
phpGroupWare Docs V0.05
Prev 

VII. About this document

The newest version of this document can be found on our website www.phpgroupware.org + as SGML source, HTML, or TEXT. +

Comments

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

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

PrevHome 
API documentation  
\ No newline at end of file diff --git a/doc/html/p43.html b/doc/html/p43.html new file mode 100644 index 0000000000..3951b912b4 --- /dev/null +++ b/doc/html/p43.html @@ -0,0 +1,173 @@ +Installation
phpGroupWare Docs V0.05
PrevNext

II. Installation

Installation/Upgrade and Configuration of phpGroupWare has been made as easy as possible. 
+Most of the work is point and click. 
+By carefully reading this document you can easly install phpGroupWare.

+

Since this is still a beta version we do expect some bugs. +

PrevHomeNext
Copyright Requirements
\ No newline at end of file diff --git a/doc/html/pref.html b/doc/html/pref.html new file mode 100644 index 0000000000..4ee79a17a4 --- /dev/null +++ b/doc/html/pref.html @@ -0,0 +1,131 @@ +Preferences
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Human ResourcesUpUsing todo
\ No newline at end of file diff --git a/doc/html/requirements.html b/doc/html/requirements.html new file mode 100644 index 0000000000..9846819ea0 --- /dev/null +++ b/doc/html/requirements.html @@ -0,0 +1,201 @@ +Requirements
phpGroupWare Docs V0.05
PrevNext

Chapter 5. Requirements

You will need PHP compiled and installed on your system. You will also need MySQL, PostgreSQL or Oracle 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, or a POP3 server installed. + You can have it installed as an Apache module or CGI mode for other web servers, 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

Seek3r has tested: +

  • phpGroupWare.org runs: Red Hat 6.2, Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL 3.23.10-alpha,Courier-IMAP 0.33+ with qmail 1.03

+ + Blinky has tested: +

  • phpGroupWare.net runs: Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1, MySQL 3.23.10-alpha,qmail 1.03

  • dev boxes are variants on: Red Hat 7.0,mysql-3.23.22-6 (from RH7 RPM), and Sendmail, Courier, or qmail+courier IMAP depending on mood.

+ + + Jengo has tested: +

  • main test box: Red Hat 6.2,Apache 1.3.12,PHP 3.0.16,PostgreSQL 7.2,Sendmail (from RH6.2)

  • laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd

  • Test box: Win2k with IIS5.0, PHP4.0.2 and MySQL

+ There are installations on Windows NT and OS/2, and using MySQL or Oracle as the database. +

PrevHomeNext
InstallationUpObtaining phpGroupWare
\ No newline at end of file diff --git a/doc/html/tobtick.html b/doc/html/tobtick.html new file mode 100644 index 0000000000..c1c2466192 --- /dev/null +++ b/doc/html/tobtick.html @@ -0,0 +1,131 @@ +Using Trouble ticket
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
Using todoUpAdministering phpGroupWare
\ No newline at end of file diff --git a/doc/html/todo.html b/doc/html/todo.html new file mode 100644 index 0000000000..f2d059b4f7 --- /dev/null +++ b/doc/html/todo.html @@ -0,0 +1,131 @@ +Using todo
phpGroupWare Docs V0.05
PrevNext
PrevHomeNext
PreferencesUpUsing Trouble ticket
\ No newline at end of file diff --git a/doc/html/trob2.html b/doc/html/trob2.html new file mode 100644 index 0000000000..41e301bc64 --- /dev/null +++ b/doc/html/trob2.html @@ -0,0 +1,169 @@ +It seems to hang when I try to read my mail
phpGroupWare Docs V0.05
PrevChapter 8. Trouble ShootingNext

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 inc/phpgwapi/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. +

PrevHomeNext
Trouble ShootingUpWhen I log in I see the directory listing instead of a web page
\ No newline at end of file diff --git a/doc/html/trob3.html b/doc/html/trob3.html new file mode 100644 index 0000000000..732c3b0603 --- /dev/null +++ b/doc/html/trob3.html @@ -0,0 +1,155 @@ +When I log in I see the directory listing instead of a web page
phpGroupWare Docs V0.05
PrevChapter 8. Trouble ShootingNext

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

PrevHomeNext
It seems to hang when I try to read my mailUpI get garbage that looks like code when I go to the phpGroupWare URL
\ No newline at end of file diff --git a/doc/html/trob4.html b/doc/html/trob4.html new file mode 100644 index 0000000000..b1ae692b24 --- /dev/null +++ b/doc/html/trob4.html @@ -0,0 +1,167 @@ +I get garbage that looks like code when I go to the phpGroupWare URL
phpGroupWare Docs V0.05
PrevChapter 8. Trouble ShootingNext

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

PrevHomeNext
When I log in I see the directory listing instead of a web pageUpUsing phpGroupWare
\ No newline at end of file diff --git a/doc/html/troubleshoot.html b/doc/html/troubleshoot.html new file mode 100644 index 0000000000..f98ff62f12 --- /dev/null +++ b/doc/html/troubleshoot.html @@ -0,0 +1,222 @@ +Trouble Shooting
phpGroupWare Docs V0.05
PrevNext

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

PrevHomeNext
Installing additional applicationsUpIt seems to hang when I try to read my mail
\ No newline at end of file diff --git a/doc/html/updata.html b/doc/html/updata.html new file mode 100644 index 0000000000..98ecc687f7 --- /dev/null +++ b/doc/html/updata.html @@ -0,0 +1,132 @@ +Updating
phpGroupWare Docs V0.05
PrevChapter 21. ApplicationsNext
PrevHomeNext
ApplicationsUpDevelopers Documentation
\ No newline at end of file diff --git a/doc/html/useracc.html b/doc/html/useracc.html new file mode 100644 index 0000000000..93ebe4621d --- /dev/null +++ b/doc/html/useracc.html @@ -0,0 +1,179 @@ +User Accounts
phpGroupWare Docs V0.05
PrevNext

Chapter 19. User Accounts

In phpGroupWare it is very easy to maintain User Accounts. You can easily add , remove or + set previleges to the user accordingly. +

Creating Accounts

+ To create a user account goto User Accounts section + of Administration and the click the + Add button. Now a form would be displayed. + FIXME : should i explain the process :-). After submiting the form you would be sent + back to the accounts page and you can now see the new user you have just created. + Isn't it easy !!! +

PrevHomeNext
Administering phpGroupWareUpMaintaining Accounts
\ No newline at end of file diff --git a/doc/html/what.html b/doc/html/what.html new file mode 100644 index 0000000000..e958e35607 --- /dev/null +++ b/doc/html/what.html @@ -0,0 +1,134 @@ +What is phpGroupWare
phpGroupWare Docs V0.05
PrevNext

Chapter 1. What is phpGroupWare

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 installed and has access to a SQL server (MySQL ,PostgreSQL or Oracle). +

PrevHomeNext
IntroductionUpWhy should you use it
\ No newline at end of file diff --git a/doc/html/why.html b/doc/html/why.html new file mode 100644 index 0000000000..68275a0388 --- /dev/null +++ b/doc/html/why.html @@ -0,0 +1,135 @@ +Why should you use it
phpGroupWare Docs V0.05
PrevNext

Chapter 2. Why should you use it

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

PrevHomeNext
What is phpGroupWareUpA short History
\ No newline at end of file diff --git a/doc/html/x112.html b/doc/html/x112.html new file mode 100644 index 0000000000..eca20fb9c2 --- /dev/null +++ b/doc/html/x112.html @@ -0,0 +1,342 @@ +Setup / Configure phpGroupWare
phpGroupWare Docs V0.05
PrevChapter 7. Installation StepsNext

Setup / Configure phpGroupWare

The config file

Copy the header.inc.php.sample file to + header.inc.php and edit the file, following the + directions in the comments. +

Create database in MySQL

An empty database will be needed for phpGroupWare. Here are the instructions for doing so with MySQL. + First create the database: +

mysqladmin create phpgroupware -p

+ Then login to the mysql: +

mysql -p

+ Finally grant the needed security rights: +

grant all on phpgroupware.* to phpgroupware@localhost identified by "some_password";

+

Create database in PostreSQL

An empty database will be needed for phpGroupWare. Here are the instructions for doing so with PostgreSQL. + Create the database: +

postmaster -i -D /home/[username]/[dataDir]

+ You will probably need to review PostgreSQL documentation for futher details. +

The Setup Program

Then point your browser to phpgroupware/setup/ which will + create (or upgrade) the database tables. + You wil be asked to login, using the password set in + header.inc.php. Setup will attempt to determine what version + of the phpGroupWare database you have installed, and upgrade to the most recent + version. +

Note
 

The developers are concentrating on getting the beta + working, and have not spent a great deal of time building upgrade scripts from the + alpha versions of phpGroupWare. You are advised to backup your existing alpha + database before running the setup script to avoid problems! +

If you get no error messages, continue on to phpgroupware/setup/config.php + to configure phpGroupWare to your system. +

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";
+}
+?
+

The phpGroupWare Daemon

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

  • Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk.

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

PrevHomeNext
Installing from CVSUpTesting the install
\ No newline at end of file diff --git a/doc/html/x156.html b/doc/html/x156.html new file mode 100644 index 0000000000..1ce559a328 --- /dev/null +++ b/doc/html/x156.html @@ -0,0 +1,142 @@ +Testing the install
phpGroupWare Docs V0.05
PrevChapter 7. Installation StepsNext

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

PrevHomeNext
Setup / Configure phpGroupWareUpInstalling additional applications
\ No newline at end of file diff --git a/doc/html/x161.html b/doc/html/x161.html new file mode 100644 index 0000000000..60572ff3fd --- /dev/null +++ b/doc/html/x161.html @@ -0,0 +1,273 @@ +Installing additional applications
phpGroupWare Docs V0.05
PrevChapter 7. Installation StepsNext

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

+

PrevHomeNext
Testing the installUpTrouble Shooting
\ No newline at end of file diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000000..b0ad3a6b3b --- /dev/null +++ b/doc/index.html @@ -0,0 +1,2011 @@ +phpGroupWare Docs V0.05

Dedication

Thanks to Joesph Engo for starting phpGroupWare (at the time called webdistro) and the core of this HOWTO. + Thanks to all the developers and users who contribute to making phpGroupWare such a success. +

Table of Contents
I. Introduction
1. What is phpGroupWare
2. Why should you use it
3. A short History
4. Copyright
II. Installation
5. Requirements
Tested Systems
6. Obtaining phpGroupWare
Released Versions
Developer's version from CVS
7. Installation Steps
Installing from TarBall
Installing from CVS
Setup / Configure phpGroupWare
Testing the install
Installing additional applications
8. Trouble Shooting
I get "Unable to open mailbox" when using the email application
It seems to hang when I try to read my mail
When I log in I see the directory listing instead of a web page
I get garbage that looks like code when I go to the phpGroupWare URL
III. Using phpGroupWare
9. Loging into phpgw
10. checking Email
11. Using Addressbook
12. Using Calender
13. Managing Files with file manager
14. Getting Headlines
15. Human Resources
16. Preferences
17. Using todo
18. Using Trouble ticket
IV. Administering phpGroupWare
19. User Accounts
Creating Accounts
Maintaining Accounts
20. Group Accounts
Creating Accounts
Maintaining Accounts
21. Applications
Installing
Updating
V. Developers Documentation
22. Developing Add-On Apps
Requirements
add your topic seek
23. API documentation
function1(or what ever)
VII. About this document

I. Introduction

Do yo have questions on using phpGroupWare , like What? Why? What for? What's in for me? +

Then you should seriously read this doc :-). +

Chapter 1. What is phpGroupWare

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 installed and has access to a SQL server (MySQL ,PostgreSQL or Oracle). +

Chapter 2. Why should you use it

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

Chapter 3. A short History

phpGroupWare started by Jengo (Joseph Engo) as an application to satisfy his girlfriends need for a webbased calendar/todo_list/email. + At the time it was called webdistro when Seek3r (Dan Kuykendall) discovered this promising project. + The two joined up together and between Seek3r's API design and Jengo's programming skills they renamed the project phpGroupWare and started building the application around the phpgwAPI. +

During this period Seek3r took over project management to free Jengo up to do more development. + This duo worked hard to build a sucessful community around the project. Their efforts paid off, and the project is what it is today due to the efforts of the developers who have joined this community. +

Chapter 4. Copyright

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

II. Installation

Installation/Upgrade and Configuration of phpGroupWare has been made as easy as possible. 
+Most of the work is point and click. 
+By carefully reading this document you can easly install phpGroupWare.

+

Since this is still a beta version we do expect some bugs. +

Chapter 5. Requirements

You will need PHP compiled and installed on your system. You will also need MySQL, PostgreSQL or Oracle 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, or a POP3 server installed. + You can have it installed as an Apache module or CGI mode for other web servers, 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

Seek3r has tested: +

  • phpGroupWare.org runs: Red Hat 6.2, Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL 3.23.10-alpha,Courier-IMAP 0.33+ with qmail 1.03

+ + Blinky has tested: +

  • phpGroupWare.net runs: Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1, MySQL 3.23.10-alpha,qmail 1.03

  • dev boxes are variants on: Red Hat 7.0,mysql-3.23.22-6 (from RH7 RPM), and Sendmail, Courier, or qmail+courier IMAP depending on mood.

+ + + Jengo has tested: +

  • main test box: Red Hat 6.2,Apache 1.3.12,PHP 3.0.16,PostgreSQL 7.2,Sendmail (from RH6.2)

  • laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd

  • Test box: Win2k with IIS5.0, PHP4.0.2 and MySQL

+ There are installations on Windows NT and OS/2, and using MySQL or Oracle as the database. +

Chapter 6. Obtaining phpGroupWare

While we are still in the Beta phase of phpGroupWare, you may + want to track the CVS copy as closely as possible. The released + versions are more stable, but often contain bugs that have been fixed + in the CVS version. +

Released Versions

The downloads section on the site + contains links to the most recent releases, and several mirror sites + for the releases. +

Developer's version from CVS

If you have never used CVS, you may want to read through the doucmentation + found at www.cvshome.org + . + The CVS pages for the core and apps projects can be found at + phpGroupWare Core CVS + , and phpGroupWare Apps CVS. + Follow the directions for Anonymous CVS access and you should + have the most recent development copy of phpGroupWare in no time. +

Chapter 7. Installation Steps

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

The files should be installed in the webserver directory. So all you need to + do is unpack the tar ball and copy the whole directory to the webserver directory +

(eg. /home/httpd/html for default apache configuration in many linux distros). +

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

Installing from CVS

Grabbing a copy from CVS is not as hard as it may seem. You will need to have a cvs client installed. + Then try the following commands: +

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

cvs login (just hit enter when prompted for a password)

cvs checkout phpgroupware

+ If you need to install into a different dirname, you can add ' -d dirname' after 'checkout' and before 'phpgroupware'. + The commands would look like this: +

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

cvs login (just hit enter when prompted for a password)

cvs checkout -d dirname phpgroupware

+

Setup / Configure phpGroupWare

The config file

Copy the header.inc.php.sample file to + header.inc.php and edit the file, following the + directions in the comments. +

Create database in MySQL

An empty database will be needed for phpGroupWare. Here are the instructions for doing so with MySQL. + First create the database: +

mysqladmin create phpgroupware -p

+ Then login to the mysql: +

mysql -p

+ Finally grant the needed security rights: +

grant all on phpgroupware.* to phpgroupware@localhost identified by "some_password";

+

Create database in PostreSQL

An empty database will be needed for phpGroupWare. Here are the instructions for doing so with PostgreSQL. + Create the database: +

postmaster -i -D /home/[username]/[dataDir]

+ You will probably need to review PostgreSQL documentation for futher details. +

The Setup Program

Then point your browser to phpgroupware/setup/ which will + create (or upgrade) the database tables. + You wil be asked to login, using the password set in + header.inc.php. Setup will attempt to determine what version + of the phpGroupWare database you have installed, and upgrade to the most recent + version. +

Note
 

The developers are concentrating on getting the beta + working, and have not spent a great deal of time building upgrade scripts from the + alpha versions of phpGroupWare. You are advised to backup your existing alpha + database before running the setup script to avoid problems! +

If you get no error messages, continue on to phpgroupware/setup/config.php + to configure phpGroupWare to your system. +

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";
+}
+?
+

The phpGroupWare Daemon

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

  • Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk.

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

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

+

Chapter 8. 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 inc/phpgwapi/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
+
+

III. Using phpGroupWare

Using phpGroupWare is a cake walk , thats what people say :-). Reading this doc would + definitely give a head start. If you ever come cross any problem please report to +

Chapter 9. Loging into phpgw

After your setup you can point your browser to index.php in the + installation directory. If the set up was right you can login with user name demo + and the password is 1234> Now it is recommended to + create a new user with administrative privileges and delete the old one. +

IV. Administering phpGroupWare

To administer phpGroupWare you need not be a PHP hacker. All you need to do is again just + point and click. And hey just a bit of typing too. :). You need to login to phpGroupWare + and click the Administration image. +

Table of Contents
19. User Accounts
20. Group Accounts
21. Applications

Chapter 19. User Accounts

In phpGroupWare it is very easy to maintain User Accounts. You can easily add , remove or + set previleges to the user accordingly. +

Creating Accounts

+ To create a user account goto User Accounts section + of Administration and the click the + Add button. Now a form would be displayed. + FIXME : should i explain the process :-). After submiting the form you would be sent + back to the accounts page and you can now see the new user you have just created. + Isn't it easy !!! +

Maintaining Accounts

Maintaining user accounts is also very easy. Just go to the + User Accounts section . Now you can see + the list of the current users and there logins. You + can now either view their ops or can even edit them. + FIXMEAGIN: need i say anything more :->. +

Chapter 20. Group Accounts

Enter the User Group section. You would see + the current user groups. +

Creating Accounts

Click the Add button. Now fill the form by + selecting the existing users and the persmissions you want to include + in the new group.And you r done. +

Maintaining Accounts

One has always a option to view and edit the groups when ever + needed +

Chapter 21. Applications

There r many applications been developed for phpGroupWare and there would be more + in the future. So insatallation of these application and as well as the future + applications has been made easy the developers. So what you have to do is to + just go to the Application section. +

V. Developers Documentation

This documentation is for developers who want to hack into the core of the + phpGroupWare. Please follow this documentation carefully before u take a jump into + the code :) +

Chapter 22. Developing Add-On Apps

text for developin add on apps (seek its your area)

Requirements

text for requirements +

add your topic seek

text for the appropriate topic +

Chapter 23. API documentation

+ text for the API documentation chapter +

function1(or what ever)

the function you want to include seek. +

VII. About this document

The newest version of this document can be found on our website www.phpgroupware.org + as SGML source, HTML, or TEXT. +

Comments

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

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/index.txt b/doc/index.txt new file mode 100644 index 0000000000..22a84e0559 --- /dev/null +++ b/doc/index.txt @@ -0,0 +1,706 @@ + +phpGroupWare Docs V0.05 + +Dan Kuykendall + +Joseph Engo + _________________________________________________________________ + _________________________________________________________________ + +Dedication + + Thanks to Joesph Engo for starting phpGroupWare (at the time called + webdistro) and the core of this HOWTO. Thanks to all the developers + and users who contribute to making phpGroupWare such a success. + + Table of Contents + I. Introduction + + 1. What is phpGroupWare + 2. Why should you use it + 3. A short History + 4. Copyright + + II. Installation + + 5. Requirements + + Tested Systems + + 6. Obtaining phpGroupWare + + Released Versions + Developer's version from CVS + + 7. Installation Steps + + Installing from TarBall + Installing from CVS + Setup / Configure phpGroupWare + Testing the install + Installing additional applications + + 8. Trouble Shooting + + I get "Unable to open mailbox" when using the email + application + + It seems to hang when I try to read my mail + When I log in I see the directory listing instead of a web + page + + I get garbage that looks like code when I go to the + phpGroupWare URL + + III. Using phpGroupWare + + 9. Loging into phpgw + 10. checking Email + 11. Using Addressbook + 12. Using Calender + 13. Managing Files with file manager + 14. Getting Headlines + 15. Human Resources + 16. Preferences + 17. Using todo + 18. Using Trouble ticket + + IV. Administering phpGroupWare + + 19. User Accounts + + Creating Accounts + Maintaining Accounts + + 20. Group Accounts + + Creating Accounts + Maintaining Accounts + + 21. Applications + + Installing + Updating + + V. Developers Documentation + + 22. Developing Add-On Apps + + Requirements + add your topic seek + + 23. API documentation + + function1(or what ever) + + VII. About this document + +I. Introduction + + Do yo have questions on using phpGroupWare , like What? Why? What for? + What's in for me? + + Then you should seriously read this doc :-). + + Table of Contents + 1. What is phpGroupWare + 2. Why should you use it + 3. A short History + 4. Copyright + _________________________________________________________________ + +Chapter 1. What is phpGroupWare + + 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 installed and has access to a SQL + server (MySQL ,PostgreSQL or Oracle). + _________________________________________________________________ + +Chapter 2. Why should you use it + + 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? + _________________________________________________________________ + +Chapter 3. A short History + + phpGroupWare started by Jengo (Joseph Engo) as an application to + satisfy his girlfriends need for a webbased calendar/todo_list/email. + At the time it was called webdistro when Seek3r (Dan Kuykendall) + discovered this promising project. The two joined up together and + between Seek3r's API design and Jengo's programming skills they + renamed the project phpGroupWare and started building the application + around the phpgwAPI. + + During this period Seek3r took over project management to free Jengo + up to do more development. This duo worked hard to build a sucessful + community around the project. Their efforts paid off, and the project + is what it is today due to the efforts of the developers who have + joined this community. + _________________________________________________________________ + +Chapter 4. Copyright + + 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 Making + TeXWork + +II. Installation + + Installation/Upgrade and Configuration of phpGroupWare has been made a + s easy as possible. + Most of the work is point and click. + By carefully reading this document you can easly install phpGroupWare. + + Since this is still a beta version we do expect some bugs. + + Table of Contents + 5. Requirements + 6. Obtaining phpGroupWare + 7. Installation Steps + 8. Trouble Shooting + _________________________________________________________________ + +Chapter 5. Requirements + + You will need PHP compiled and installed on your system. You will also + need MySQL, PostgreSQL or Oracle 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, or a POP3 + server installed. You can have it installed as an Apache module or CGI + mode for other web servers, 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 + + Seek3r has tested: + + * phpGroupWare.org runs: Red Hat 6.2, + Apache/1.3.12,PHP/4.0.2,mod_perl/1.21,MySQL + 3.23.10-alpha,Courier-IMAP 0.33+ with qmail 1.03 + + Blinky has tested: + + * phpGroupWare.net runs: Red Hat 6.2,Apache/1.3.14 PHP/4.0.3pl1 + mod_ssl/2.7.1 OpenSSL/0.9.6 PHP4.03.pl1, MySQL 3.23.10-alpha,qmail + 1.03 + * dev boxes are variants on: Red Hat 7.0,mysql-3.23.22-6 (from RH7 + RPM), and Sendmail, Courier, or qmail+courier IMAP depending on + mood. + + Jengo has tested: + + * main test box: Red Hat 6.2,Apache 1.3.12,PHP 3.0.16,PostgreSQL + 7.2,Sendmail (from RH6.2) + * laptop is rh 6.1, apache 1.3.?, MySQL and PostgreSQL 7.0 w/ PHP + 3.0.16, its a P-90 w/ 40 mb ram and a 800 mb hd + * Test box: Win2k with IIS5.0, PHP4.0.2 and MySQL + + There are installations on Windows NT and OS/2, and using MySQL or + Oracle as the database. + _________________________________________________________________ + +Chapter 6. Obtaining phpGroupWare + + While we are still in the Beta phase of phpGroupWare, you may want to + track the CVS copy as closely as possible. The released versions are + more stable, but often contain bugs that have been fixed in the CVS + version. + _________________________________________________________________ + +Released Versions + + The downloads section on the site contains links to the most recent + releases, and several mirror sites for the releases. + _________________________________________________________________ + +Developer's version from CVS + + If you have never used CVS, you may want to read through the + doucmentation found at www.cvshome.org . The CVS pages for the core + and apps projects can be found at phpGroupWare Core CVS , and + phpGroupWare Apps CVS. Follow the directions for Anonymous CVS access + and you should have the most recent development copy of phpGroupWare + in no time. + _________________________________________________________________ + +Chapter 7. Installation Steps + + 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 + + The files should be installed in the webserver directory. So all you + need to do is unpack the tar ball and copy the whole directory to the + webserver directory + + (eg. /home/httpd/html for default apache configuration in many linux + distros). + + 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. + _________________________________________________________________ + +Installing from CVS + + Grabbing a copy from CVS is not as hard as it may seem. You will need + to have a cvs client installed. Then try the following commands: + + export + CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/ + phpgroupware' + cvs login (just hit enter when prompted for a password) + cvs checkout phpgroupware + If you need to install into a different dirname, you can add ' -d + dirname' after 'checkout' and before 'phpgroupware'. The commands + would look like this: + + export + CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/ + phpgroupware' + cvs login (just hit enter when prompted for a password) + cvs checkout -d dirname phpgroupware + _________________________________________________________________ + +Setup / Configure phpGroupWare + +The config file + + Copy the header.inc.php.sample file to header.inc.php and edit the + file, following the directions in the comments. + _________________________________________________________________ + +Create database in MySQL + + An empty database will be needed for phpGroupWare. Here are the + instructions for doing so with MySQL. First create the database: + + mysqladmin create phpgroupware -p + Then login to the mysql: + + mysql -p + Finally grant the needed security rights: + + grant all on phpgroupware.* to phpgroupware@localhost identified by + "some_password"; + _________________________________________________________________ + +Create database in PostreSQL + + An empty database will be needed for phpGroupWare. Here are the + instructions for doing so with PostgreSQL. Create the database: + + postmaster -i -D /home/[username]/[dataDir] + You will probably need to review PostgreSQL documentation for futher + details. + _________________________________________________________________ + +The Setup Program + + Then point your browser to phpgroupware/setup/ which will create (or + upgrade) the database tables. You wil be asked to login, using the + password set in header.inc.php. Setup will attempt to determine what + version of the phpGroupWare database you have installed, and upgrade + to the most recent version. + + Note: The developers are concentrating on getting the beta working, + and have not spent a great deal of time building upgrade scripts + from the alpha versions of phpGroupWare. You are advised to backup + your existing alpha database before running the setup script to + avoid problems! + + If you get no error messages, continue on to + phpgroupware/setup/config.php to configure phpGroupWare to your + system. + + 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"; +} +? + + _________________________________________________________________ + +The phpGroupWare Daemon + + 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. + + * Users always forget to logout. This way the session doesn't sit + around forever, creating a possible security risk. + * 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 during + 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. + _________________________________________________________________ + +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:/cvsr + oot/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 8. 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 + _________________________________________________________________ + +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 inc/phpgwapi/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 + +III. Using phpGroupWare + + Using phpGroupWare is a cake walk , thats what people say :-). Reading + this doc would definitely give a head start. If you ever come cross + any problem please report to + + Table of Contents + 9. Loging into phpgw + 10. checking Email + 11. Using Addressbook + 12. Using Calender + 13. Managing Files with file manager + 14. Getting Headlines + 15. Human Resources + 16. Preferences + 17. Using todo + 18. Using Trouble ticket + _________________________________________________________________ + +Chapter 9. Loging into phpgw + + After your setup you can point your browser to index.php in the + installation directory. If the set up was right you can login with + user name demo and the password is 1234> Now it is recommended to + create a new user with administrative privileges and delete the old + one. + _________________________________________________________________ + +Chapter 10. checking Email + _________________________________________________________________ + +Chapter 11. Using Addressbook + _________________________________________________________________ + +Chapter 12. Using Calender + _________________________________________________________________ + +Chapter 13. Managing Files with file manager + _________________________________________________________________ + +Chapter 14. Getting Headlines + _________________________________________________________________ + +Chapter 15. Human Resources + _________________________________________________________________ + +Chapter 16. Preferences + _________________________________________________________________ + +Chapter 17. Using todo + _________________________________________________________________ + +Chapter 18. Using Trouble ticket + +IV. Administering phpGroupWare + + To administer phpGroupWare you need not be a PHP hacker. All you need + to do is again just point and click. And hey just a bit of typing too. + :). You need to login to phpGroupWare and click the Administration + image. + + Table of Contents + 19. User Accounts + 20. Group Accounts + 21. Applications + _________________________________________________________________ + +Chapter 19. User Accounts + + In phpGroupWare it is very easy to maintain User Accounts. You can + easily add , remove or set previleges to the user accordingly. + _________________________________________________________________ + +Creating Accounts + + To create a user account goto User Accounts section of Administration + and the click the Add button. Now a form would be displayed. FIXME : + should i explain the process :-). After submiting the form you would + be sent back to the accounts page and you can now see the new user you + have just created. Isn't it easy !!! + _________________________________________________________________ + +Maintaining Accounts + + Maintaining user accounts is also very easy. Just go to the User + Accounts section . Now you can see the list of the current users and + there logins. You can now either view their ops or can even edit them. + FIXMEAGIN: need i say anything more :->. + _________________________________________________________________ + +Chapter 20. Group Accounts + + Enter the User Group section. You would see the current user groups. + _________________________________________________________________ + +Creating Accounts + + Click the Add button. Now fill the form by selecting the existing + users and the persmissions you want to include in the new group.And + you r done. + _________________________________________________________________ + +Maintaining Accounts + + One has always a option to view and edit the groups when ever needed + _________________________________________________________________ + +Chapter 21. Applications + + There r many applications been developed for phpGroupWare and there + would be more in the future. So insatallation of these application and + as well as the future applications has been made easy the developers. + So what you have to do is to just go to the Application section. + _________________________________________________________________ + +Installing + _________________________________________________________________ + +Updating + +V. Developers Documentation + + This documentation is for developers who want to hack into the core of + the phpGroupWare. Please follow this documentation carefully before u + take a jump into the code :) + + Table of Contents + 22. Developing Add-On Apps + 23. API documentation + _________________________________________________________________ + +Chapter 22. Developing Add-On Apps + + text for developin add on apps (seek its your area) + _________________________________________________________________ + +Requirements + + text for requirements + _________________________________________________________________ + +add your topic seek + + text for the appropriate topic + _________________________________________________________________ + +Chapter 23. API documentation + + text for the API documentation chapter + _________________________________________________________________ + +function1(or what ever) + + the function you want to include seek. + +VII. About this document + + The newest version of this document can be found on our website + www.phpgroupware.org as SGML source, HTML, or TEXT. + _________________________________________________________________ + +Comments + + 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 + + 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 :-). diff --git a/doc/FAQ.sgml b/doc/sgml/FAQ.sgml similarity index 100% rename from doc/FAQ.sgml rename to doc/sgml/FAQ.sgml diff --git a/doc/sgml/README b/doc/sgml/README new file mode 100755 index 0000000000..d93c4c0865 --- /dev/null +++ b/doc/sgml/README @@ -0,0 +1,63 @@ +** This file is mostly out of date, please see the HOWTO docs ** + +This program was created becuase I needed a more centralize means of conduting +my daily life. I have seen many great programs out there, calendars, todolist, +addressbooks, email, etc... But, there is a very common problem with 95% of +them, they don't like each other. ( The programs, not the people :) If I was +logged into the calendar and wanted to grab a phone number, I would have to +login to another app. Which became a real pain real quick. So, I search high +and low for something that would have all these systems tied in to one. Well, +I didn't find anything I really liked. So, I made my own. ( Isn't that the +driving force of 99% of Open Source apps ? :) + +Before I bore you to death, not all of these programs are written by me. Some, +I wrote my self. Some where downloaded and converted. All apps are released +under the GPL license. I would not use anything but. If you are intrested +in adding/recommending a program to be included in this ditro. Please, send +me the URL. I will not except restrictive licenses. I will only accept GPL +or freeware. If you are intrested in helping out with development, or think +you might be able to help out. Let me know what your plains are. + +You might have noticed there are a few references to programs that can't be +found anywhere in the archive or on the site. Thats becuase there not ready +yet. For example, pop_mail. This is a feature that will be added in the +future. It will give the admin control over who has POP-3 access for virtual +users. Becuase the system does not use nor require the user to have a shell +account on the system, a special POP-3 server is going to be used. It will +verify the user from the accounts table, then allow or disallow access to there +messages. I don't think this feature will be used too often, but, it gives +a nice bit of control for some added flexablity. Currently users that have +access to email will be required to have an account on the server. This will +change in the future. I am looking into other IMAP servers that can verify +logins through the accounts table. This will take some time for me to find the +best solution. + +Some things you should note on how this system works. Think of the navigation +bar as the glue sticking all of these apps together. It is handling the +login portions, session info and account info. If you notice the layout of +the directorys, it can give a good clue to how this system is layied out. + +/phpGroupWare + |- inc [ The common files used by the distro ] + |- addressbook [ File needed by the addressbook only ] + | |- inc [ The include files for the addressbook ] + | \- icons [ Images for the addressbook, unless commonly + | used through out the program ] + |- icons [ Images used throughout the program ] + +I think you can get the idea of it. Another thing that should be noted is the +structure of the database. Yes, it looks pretty odd, but, for the most part +makes a lot of sense. Lets say you didn't need the addressbook. Delete +/phpGroupWare/addressbook and change the settings in /phpGroupWare/config.inc There are +still a few references to it, like in the account table. But, there not used. +This is one of the main reasons I use $dbase->f("con") instead of $dbase->f(0) + +Which brings me to another point, I _try_ to use standared colum names through +out the database. con = control number, owner = the users loginid, +status = that records status. This makes it easier to keep track of what does +what. Refear to CODES in the doc directory. + +BTW: Please, ingnore my very poor spelling and grammer. I am a programmer + not an English teacher. + +Happy hacking :)