phpGroupWare is a web based groupware application that includes integrated features such as email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system. -
It should run on all systems where PHP is avalible and currently supports MySQL and PostgreSQL. +
It should run on all systems where PHP is available and currently supports MySQL and PostgreSQL.
phpGroupWare is: @@ -34,7 +34,7 @@ For companies with a distributed user base, it's an ideal solution. Oh, and did
You will need PHP compiled and installed on your system. You will also need MySQL or PostgreSQL setup. If you are planning on using the email system, you will need to have an IMAP server installed and IMAP support compiled into PHP. -You can have it installed as an Apache module or command line version, the Apache module is prefered. +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.
We have reports of it working on Windows NT and OS/2. +
We have reports of it working on Windows NT and OS/2, and using Oracle as the database.
After you have met the system requirements, unpack the tarball in the html @@ -67,8 +68,13 @@ Then add the language entries (used for translation purposes).
$ psql -d phpgroupware -U username < lang.sql
Copy the header.inc.php.sample file to
+header.inc.php and edit the file, following the
+directions in the comments.
Change to the inc directory.
-Edit globalconfig.inc.php to reflect your system settings.
+Copy globalconfig.inc.php.sample to globalconfig.inc.php
+and edit it to reflect your system settings, again following the
+comments in the file.
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.
@@ -92,31 +98,156 @@ directory.
This file is not required, you can simply disable cron_apps in the admin -> applications section -to clean out the sessions table durring login and logout. +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 +completed. If a users browser crashes, Internet connection dies, etc, their files will sit there forever unless deleted. You could add a few lines to logout.php that will look in the temp directory for any stale uploads and delete them. But, once again, it becomes a performance issue. +
If your config is setup properly you can now login. Point your browser to the
installed location and login with the username demo and the password is 1234
-At this point it would be a good idea to create a new user and delete the old
-one.
-
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). +
+export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps' +cvs login (just hit enter if prompted for a password) +cvs co headlines ++ +
headlines directory into your phpGroupWare
+install directory.
+Applications link
+should be identical to the name
+of the directory you moved into the phpGroupWare install, in this case use headlines
+
this is shown in the navigation bar and other places to refer to the
+new application. Enter Headlines for this example.
+
This can be used to disable an application for all users temporially. You +should normal check the box to enable the application. +
Headlines box that appears
+in the middle of the account editing page.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 +
+
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. +
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); ++
+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. +
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 ++
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 ++
+AddType application/x-httpd-php .php3 .php ++
The newest version of this document can be found on our website http://www.phpgroupware.org as SGML source, HTML, or TEXT. -
Comments on this HOWTO should be directed to the phpGroupWare developers mailing list phpgroupware-developers@lists.sourceforge.net.
To subscribe, go to -http://sourceforge.net/mail/?group_id=7305
This document was started by Joseph Engo and reworked by Dan Kuykendall. -
Old Version
@@ -130,7 +261,14 @@ one.
v1.1 (September 27, 2000) - blinky +
+
Copyright (c) Dan Kuykendall. Permission is granted to copy, distribute and/or modify this document @@ -138,7 +276,7 @@ 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. -
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 index 642346aa74..997f54f2ea 100644 --- a/doc/HOWTO.sgml +++ b/doc/HOWTO.sgml @@ -21,7 +21,7 @@
phpGroupWare is a web based groupware application that includes integrated features such as email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system. -
It should run on all systems where PHP is avalible and currently supports MySQL and PostgreSQL. +
It should run on all systems where PHP is available and currently supports MySQL and PostgreSQL.
@@ -38,7 +38,7 @@
You will need PHP compiled and installed on your system. You will also need MySQL or PostgreSQL setup. If you are planning on using the email system, you will need to have an IMAP server installed and IMAP support compiled into PHP. - You can have it installed as an Apache module or command line version, the Apache module is prefered. + 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.
@@ -50,9 +50,10 @@@@ -77,9 +78,15 @@ $ psql -d phpgroupware -U username < lang.sql
+ Copy the header.inc.php.sample file to + header.inc.php and edit the file, following the + directions in the comments.
Change to the inc directory.
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
@@ -106,18 +113,138 @@
This file is not required, you can simply disable cron_apps in the admin -> applications section
- to clean out the sessions table durring login and logout.
+ 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
+ completed. If a users browser crashes, Internet connection dies, etc, their
files will sit there forever unless deleted. You could add a few lines to
logout.php that will look in the temp directory for any stale uploads and delete
them. But, once again, it becomes a performance issue.
+
If your config is setup properly you can now login. Point your browser to the
installed location and login with the username demo and the password is 1234
+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
+ 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.
+ 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
+ If you are using Apache, this often means you need to add
+.php to the DirectoryIndex line in your httpd.conf file.
+
+For example:
+ This is often because you have php3 installed, which does not map .php to the PHP engine.
+
+For PHP3:
+
+ v1.1 (September 27, 2000) - blinky
+
+
Copyright (c) Dan Kuykendall.
@@ -164,7 +301,7 @@ name="http://sourceforge.net/mail/?group_id=7305">
A copy of the license is available at
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
index b8a8b06d68..f3fa204666 100644
--- a/doc/HOWTO.txt
+++ b/doc/HOWTO.txt
@@ -22,14 +22,25 @@
2.3.2 Installation with PostgreSQL
2.4 Configure phpGroupWare
- 3. About this document
+ 3. Testing the install
- 3.1 New versions
- 3.2 Comments
- 3.3 History
- 3.4 Version History
- 3.5 Copyrights and Trademarks
- 3.6 Acknowledgements and Thanks
+ 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. About this document
+
+ 6.1 New versions
+ 6.2 Comments
+ 6.3 History
+ 6.4 Version History
+ 6.5 Copyrights and Trademarks
+ 6.6 Acknowledgments and Thanks
______________________________________________________________________
@@ -40,7 +51,7 @@
integrated features such as email, calendar, todo list, address book,
file manager, headline news, and a trouble ticket system.
- It should run on all systems where PHP is avalible and currently
+ 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??
@@ -52,6 +63,7 @@
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
@@ -66,7 +78,7 @@
also need MySQL or PostgreSQL setup. If you are planning on using the
email system, you will need to have an IMAP server installed and IMAP
support compiled into PHP. You can have it installed as an Apache
- module or command line version, the Apache module is prefered. We
+ 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.
@@ -83,7 +95,10 @@
+o Courier-IMAP 0.33+
- We have reports of it working on Windows NT and OS/2.
+ +o qmail 1.03 (using the qmail POP3 server)
+
+ We have reports of it working on Windows NT and OS/2, and using Oracle
+ as the database.
22..33.. TTeesstteedd SSyysstteemmss
@@ -112,10 +127,18 @@
$ psql -d phpgroupware -U username < lang.sql
+
+
+
22..44.. CCoonnffiigguurree pphhppGGrroouuppWWaarree
+ Copy the header.inc.php.sample file to header.inc.php and edit the
+ file, following the directions in the comments.
+
Change to the inc directory.
- Edit globalconfig.inc.php to reflect your system settings.
+ Copy globalconfig.inc.php.sample to globalconfig.inc.php and edit it
+ to reflect your system settings, again following the comments in the
+ file.
If you are using the email system you will need to create a temporary
directory where file uploads will be stored. For security reasons,
@@ -126,10 +149,6 @@
If you do not have access to root, create this file and run it.
-
-
-
-
applications section to clean out the sessions table durring
+ 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
+ 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 and delete
- the old one.
+ At this point it would be a good idea to create a new user with
+ administrative privileges and delete the old one.
- 33.. AAbboouutt tthhiiss ddooccuummeenntt
+ 44.. IInnssttaalllliinngg aaddddiittiioonnaall aapppplliiccaattiioonnss
- 33..11.. NNeeww vveerrssiioonnss
+ 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
+set_time_limit(0);
+
+to the top of the inc/phpgwapi/phpgw_msg_pop3.inc.php file, just before
+the line
+DirectoryIndex index.php index.php3 index.html index.htm index.cgi
+
+
+AddType application/x-httpd-php3 .php3 .php
+
+For PHP4:
+
+AddType application/x-httpd-php .php3 .php
+