mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-12-25 16:19:00 +01:00
Updated HOWTO to answer some of the FAQ in #phpGroupWare, and
explain the installation process in more detail.
This commit is contained in:
sjb4891
parent
51fcd9558a
commit
f8deba56ec
168
doc/HOWTO.html
168
doc/HOWTO.html
@ -18,7 +18,7 @@
|
||||
|
||||
<P>phpGroupWare is a web based groupware application that includes integrated features such as
|
||||
email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system.
|
||||
<P>It should run on all systems where PHP is avalible and currently supports MySQL and PostgreSQL.
|
||||
<P>It should run on all systems where PHP is available and currently supports MySQL and PostgreSQL.
|
||||
<H2>1.1 What is phpGroupWare and why should I use it?</H2>
|
||||
|
||||
<P>phpGroupWare is:
|
||||
@ -34,7 +34,7 @@ For companies with a distributed user base, it's an ideal solution. Oh, and did
|
||||
|
||||
<P>You will need PHP compiled and installed on your system. You will also need MySQL or PostgreSQL setup.
|
||||
If you are planning on using the email system, you will need to have an IMAP server installed and IMAP support compiled into PHP.
|
||||
You can have it installed as an Apache module or command line version, the Apache module is prefered.
|
||||
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.
|
||||
<H2>2.2 Tested Systems</H2>
|
||||
@ -45,8 +45,9 @@ Windows is supported, but there is no documentation for it currently.
|
||||
<LI>Apache 1.3.x</LI>
|
||||
<LI>MySQL 3.22.25 or PostgreSQL 7.0.x</LI>
|
||||
<LI>Courier-IMAP 0.33+</LI>
|
||||
<LI>qmail 1.03 (using the qmail POP3 server)</LI>
|
||||
</UL>
|
||||
<P>We have reports of it working on Windows NT and OS/2.
|
||||
<P>We have reports of it working on Windows NT and OS/2, and using Oracle as the database.
|
||||
<H2>2.3 Tested Systems</H2>
|
||||
|
||||
<P>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).
|
||||
<P><CODE>$ psql -d phpgroupware -U username < lang.sql</CODE>
|
||||
<H2>2.4 Configure phpGroupWare</H2>
|
||||
|
||||
<P>Copy the <CODE>header.inc.php.sample</CODE> file to
|
||||
<CODE>header.inc.php</CODE> and edit the file, following the
|
||||
directions in the comments.
|
||||
<P>Change to the inc directory. <BR>
|
||||
Edit globalconfig.inc.php to reflect your system settings.
|
||||
Copy <CODE>globalconfig.inc.php.sample</CODE> to <CODE>globalconfig.inc.php</CODE>
|
||||
and edit it to reflect your system settings, again following the
|
||||
comments in the file.
|
||||
<P>If you are using the email system you will need to create a temporary directory
|
||||
where file uploads will be stored. For security reasons, you should <CODE>chown
|
||||
nobody.nobody</CODE> and <CODE>chmod 700</CODE> to that directory. Depending on your system configuration.
|
||||
@ -92,31 +98,156 @@ directory.
|
||||
<LI>The email system requires plain text passwords which are stored in the sessions table.</LI>
|
||||
</UL>
|
||||
<P>This file is not required, you can simply 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.
|
||||
<P>stale_uploads.pl - This will delete file attachments for messages that where not
|
||||
completed. If a users browser crashes, internet connection dies, etc, their
|
||||
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.
|
||||
<H2><A NAME="s3">3. Testing the install</A></H2>
|
||||
|
||||
<P>If your config is setup properly you can now login. Point your browser to the
|
||||
installed location and login with the username <CODE>demo</CODE> and the password is <CODE>1234</CODE><BR>
|
||||
At this point it would be a good idea to create a new user and delete the old
|
||||
one.
|
||||
<H2><A NAME="s3">3. About this document</A></H2>
|
||||
At this point it would be a good idea to create a new user with administrative privileges and
|
||||
delete the old one.
|
||||
<H2><A NAME="s4">4. Installing additional applications</A></H2>
|
||||
|
||||
<H2>3.1 New versions </H2>
|
||||
<P>Once you have the core phpGroupWare install up and running,
|
||||
you may want to download and install additional applications.
|
||||
<P>You should consult any <CODE>README</CODE> or <CODE>INSTALL</CODE>
|
||||
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 <CODE>lang.sql</CODE>)
|
||||
<P>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.
|
||||
<P>For example, this is the process to install the
|
||||
Headlines application (see
|
||||
<A HREF="http://sourceforge.net/phpgwapps/">http://sourceforge.net/phpgwapps/</A> for
|
||||
more on this and other applications).
|
||||
<UL>
|
||||
<LI>Download the .tar.gz file for the application, or check out the source
|
||||
with cvs with
|
||||
<PRE>
|
||||
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'
|
||||
cvs login (just hit enter if prompted for a password)
|
||||
cvs co headlines
|
||||
</PRE>
|
||||
|
||||
</LI>
|
||||
<LI>Move the <CODE>headlines</CODE> directory into your phpGroupWare
|
||||
install directory.
|
||||
</LI>
|
||||
<LI>Log into phpGroupWare as an administrative user, and go to the Administration page.
|
||||
</LI>
|
||||
<LI>In the first section, choose the <CODE>Applications</CODE> link
|
||||
</LI>
|
||||
<LI>Click on add, and fill in the form.
|
||||
<DL>
|
||||
<DT><B>Application name</B><DD><P>should be identical to the name
|
||||
of the directory you moved into the phpGroupWare install, in this case use <CODE>headlines</CODE>
|
||||
<DT><B>Application Title</B><DD><P>this is shown in the navigation bar and other places to refer to the
|
||||
new application. Enter <CODE>Headlines</CODE> for this example.
|
||||
<DT><B>Enabled</B><DD><P>This can be used to disable an application for all users temporially. You
|
||||
should normal check the box to enable the application.
|
||||
</DL>
|
||||
</LI>
|
||||
<LI>Back in the Administration page, you need to enable the application for specific users
|
||||
or user groups by editing them, and checking the new <CODE>Headlines</CODE> box that appears
|
||||
in the middle of the account editing page.</LI>
|
||||
<LI>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.</LI>
|
||||
<LI>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.</LI>
|
||||
</UL>
|
||||
<H2><A NAME="s5">5. Trouble-shooting</A></H2>
|
||||
|
||||
<P><B>WARNING!</B> 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.
|
||||
<P>The phpGroupWare developers can often be seen hanging out in #phpGroupWare
|
||||
on irc.openprojects.net if you require real-time help.
|
||||
<P>Also check the FAQ in this directory for additional common questions,
|
||||
it is available as FAQ.sgml, FAQ.txt and FAQ.html
|
||||
<P>
|
||||
<H2>5.1 I get "Unable to open mailbox" when using the email application</H2>
|
||||
|
||||
<P>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.
|
||||
<P>An preference page to edit the email settings is being developed, and should
|
||||
appear shortly after the first beta release.
|
||||
<H2>5.2 It seems to hang when I try to read my mail</H2>
|
||||
|
||||
<P>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.
|
||||
<P>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.
|
||||
<P>You can either clean up your mailbox with another mail program, or
|
||||
add the line
|
||||
<HR>
|
||||
<PRE>
|
||||
set_time_limit(0);
|
||||
</PRE>
|
||||
<HR>
|
||||
|
||||
to the top of the inc/phpgwapi/phpgw_msg_pop3.inc.php file, just before
|
||||
the line
|
||||
<PRE>
|
||||
class msg extends msg_common
|
||||
</PRE>
|
||||
|
||||
<P>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.
|
||||
<H2>5.3 When I log in I see the directory listing instead of a web page</H2>
|
||||
|
||||
<P>If you are using Apache, this often means you need to add
|
||||
<CODE>.php</CODE> to the <CODE>DirectoryIndex</CODE> line in your httpd.conf file.
|
||||
<P>For example:
|
||||
<HR>
|
||||
<PRE>
|
||||
DirectoryIndex index.php index.php3 index.html index.htm index.cgi
|
||||
</PRE>
|
||||
<HR>
|
||||
<H2>5.4 I get garbage that looks like code when I go to the phpGroupWare URL</H2>
|
||||
|
||||
<P>This is often because you have php3 installed, which does not map <CODE>.php</CODE> to the PHP engine.
|
||||
<P>For PHP3:
|
||||
<HR>
|
||||
<PRE>
|
||||
AddType application/x-httpd-php3 .php3 .php
|
||||
</PRE>
|
||||
<HR>
|
||||
|
||||
For PHP4:
|
||||
<HR>
|
||||
<PRE>
|
||||
AddType application/x-httpd-php .php3 .php
|
||||
</PRE>
|
||||
<HR>
|
||||
<H2><A NAME="s6">6. About this document</A></H2>
|
||||
|
||||
<H2>6.1 New versions </H2>
|
||||
|
||||
<P>The newest version of this document can be found on our website
|
||||
<A HREF="http://www.phpgroupware.org">http://www.phpgroupware.org</A> as SGML source, HTML, or TEXT.
|
||||
<H2>3.2 Comments </H2>
|
||||
<H2>6.2 Comments </H2>
|
||||
|
||||
<P>Comments on this HOWTO should be directed to the phpGroupWare developers mailing list
|
||||
<A HREF="mailto:phpgroupware-developers@lists.sourceforge.net">phpgroupware-developers@lists.sourceforge.net</A>.
|
||||
<P>To subscribe, go to
|
||||
<A HREF="http://sourceforge.net/mail/?group_id=7305">http://sourceforge.net/mail/?group_id=7305</A><H2>3.3 History </H2>
|
||||
<A HREF="http://sourceforge.net/mail/?group_id=7305">http://sourceforge.net/mail/?group_id=7305</A><H2>6.3 History </H2>
|
||||
|
||||
<P>This document was started by Joseph Engo and reworked by Dan Kuykendall.
|
||||
<H2>3.4 Version History </H2>
|
||||
<H2>6.4 Version History </H2>
|
||||
|
||||
<P>Old Version
|
||||
<P>
|
||||
@ -130,7 +261,14 @@ one.
|
||||
<LI>Included the FAQ.</LI>
|
||||
<LI>Other minor additions.</LI>
|
||||
</UL>
|
||||
<H2>3.5 Copyrights and Trademarks </H2>
|
||||
<P>v1.1 (September 27, 2000) - blinky
|
||||
<P>
|
||||
<UL>
|
||||
<LI>Added Testing Install section</LI>
|
||||
<LI>Added Trouble-shooting section</LI>
|
||||
<LI>Added description of application installation</LI>
|
||||
</UL>
|
||||
<H2>6.5 Copyrights and Trademarks </H2>
|
||||
|
||||
<P>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
|
||||
<P>A copy of the license is available at
|
||||
<A HREF="http://www.gnu.org/copyleft/fdl.txt">GNU Free Documentation License</A>.
|
||||
<H2>3.6 Acknowledgements and Thanks </H2>
|
||||
<H2>6.6 Acknowledgments and Thanks </H2>
|
||||
|
||||
<P>Thanks to Joesph Engo for starting phpGroupWare (at the time called webdistro) and the core of this HOWTO.
|
||||
Thanks to all the developers and users who contribute to making phpGroupWare such a success.
|
||||
|
||||
155
doc/HOWTO.sgml
155
doc/HOWTO.sgml
@ -21,7 +21,7 @@
|
||||
<p>
|
||||
phpGroupWare is a web based groupware application that includes integrated features such as
|
||||
email, calendar, todo list, address book, file manager, headline news, and a trouble ticket system.
|
||||
<p>It should run on all systems where PHP is avalible and currently supports MySQL and PostgreSQL.
|
||||
<p>It should run on all systems where PHP is available and currently supports MySQL and PostgreSQL.
|
||||
</p>
|
||||
<sect1>What is phpGroupWare and why should I use it?
|
||||
<p>
|
||||
@ -38,7 +38,7 @@
|
||||
<p>
|
||||
You will need PHP compiled and installed on your system. You will also need MySQL or PostgreSQL setup.
|
||||
If you are planning on using the email system, you will need to have an IMAP server installed and IMAP support compiled into PHP.
|
||||
You can have it installed as an Apache module or command line version, the Apache module is prefered.
|
||||
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.
|
||||
</p>
|
||||
@ -50,9 +50,10 @@
|
||||
<item>Apache 1.3.x
|
||||
<item>MySQL 3.22.25 or PostgreSQL 7.0.x
|
||||
<item>Courier-IMAP 0.33+
|
||||
<item>qmail 1.03 (using the qmail POP3 server)
|
||||
</itemize>
|
||||
|
||||
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.
|
||||
</p>
|
||||
<sect1>Tested Systems
|
||||
<p>
|
||||
@ -77,9 +78,15 @@
|
||||
<tt>$ psql -d phpgroupware -U username < lang.sql</tt>
|
||||
</p>
|
||||
<sect1>Configure phpGroupWare
|
||||
<p>
|
||||
Copy the <tt>header.inc.php.sample</tt> file to
|
||||
<tt>header.inc.php</tt> and edit the file, following the
|
||||
directions in the comments.
|
||||
<p>
|
||||
Change to the inc directory. <newline>
|
||||
Edit globalconfig.inc.php to reflect your system settings.
|
||||
Copy <tt>globalconfig.inc.php.sample</tt> to <tt>globalconfig.inc.php</tt>
|
||||
and edit it to reflect your system settings, again following the
|
||||
comments in the file.
|
||||
<p>
|
||||
If you are using the email system you will need to create a temporary directory
|
||||
where file uploads will be stored. For security reasons, you should <tt>chown
|
||||
@ -106,18 +113,138 @@
|
||||
</itemize>
|
||||
|
||||
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.
|
||||
<p>
|
||||
stale_uploads.pl - This will delete file attachments for messages that where not
|
||||
completed. If a users browser crashes, internet connection dies, etc, their
|
||||
completed. If a users browser crashes, Internet connection dies, etc, their
|
||||
files will sit there forever unless deleted. You could add a few lines to
|
||||
logout.php that will look in the temp directory for any stale uploads and delete
|
||||
them. But, once again, it becomes a performance issue.
|
||||
</p>
|
||||
<sect>Testing the install
|
||||
<p>
|
||||
If your config is setup properly you can now login. Point your browser to the
|
||||
installed location and login with the username <tt>demo</tt> and the password is <tt>1234</tt><newline>
|
||||
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.
|
||||
</p>
|
||||
<sect>Installing additional applications
|
||||
<p>
|
||||
Once you have the core phpGroupWare install up and running,
|
||||
you may want to download and install additional applications.
|
||||
|
||||
You should consult any <tt>README</tt> or <tt>INSTALL</tt>
|
||||
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 <tt>lang.sql</tt>)
|
||||
|
||||
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 <url url="http://sourceforge.net/phpgwapps/"> for
|
||||
more on this and other applications).
|
||||
<itemize>
|
||||
<item>Download the .tar.gz file for the application, or check out the source
|
||||
with cvs with
|
||||
<verb>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'
|
||||
cvs login (just hit enter if prompted for a password)
|
||||
cvs co headlines</verb>
|
||||
|
||||
<item>Move the <tt>headlines</tt> directory into your phpGroupWare
|
||||
install directory.
|
||||
|
||||
<item>Log into phpGroupWare as an administrative user, and go to the Administration page.
|
||||
|
||||
<item>In the first section, choose the <tt>Applications</tt> link
|
||||
|
||||
<item>Click on add, and fill in the form.
|
||||
<descrip>
|
||||
<tag/Application name/ should be identical to the name
|
||||
of the directory you moved into the phpGroupWare install, in this case use <tt>headlines</tt>
|
||||
<tag/Application Title/this is shown in the navigation bar and other places to refer to the
|
||||
new application. Enter <tt>Headlines</tt> for this example.
|
||||
<tag/Enabled/This can be used to disable an application for all users temporially. You
|
||||
should normal check the box to enable the application.
|
||||
</descrip>
|
||||
<item>Back in the Administration page, you need to enable the application for specific users
|
||||
or user groups by editing them, and checking the new <tt>Headlines</tt> box that appears
|
||||
in the middle of the account editing page.
|
||||
<item>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.
|
||||
<item>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.
|
||||
</itemize>
|
||||
</p>
|
||||
<sect>Trouble-shooting
|
||||
<p>
|
||||
<bf>WARNING!</bf> 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
|
||||
|
||||
<sect1>I get "Unable to open mailbox" when using the email application
|
||||
<P>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.
|
||||
</p>
|
||||
|
||||
<sect1>It seems to hang when I try to read my mail
|
||||
<P>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
|
||||
<code>
|
||||
set_time_limit(0);
|
||||
</code>
|
||||
to the top of the inc/phpgwapi/phpgw_msg_pop3.inc.php file, just before
|
||||
the line <verb>class msg extends msg_common</verb>
|
||||
|
||||
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.
|
||||
</p>
|
||||
|
||||
<sect1>When I log in I see the directory listing instead of a web page
|
||||
<P>If you are using Apache, this often means you need to add
|
||||
<tt>.php</tt> to the <tt>DirectoryIndex</tt> line in your httpd.conf file.
|
||||
|
||||
For example:
|
||||
<code>
|
||||
DirectoryIndex index.php index.php3 index.html index.htm index.cgi
|
||||
</code>
|
||||
</p>
|
||||
<sect1>I get garbage that looks like code when I go to the phpGroupWare URL
|
||||
<P>This is often because you have php3 installed, which does not map <tt>.php</tt> to the PHP engine.
|
||||
|
||||
For PHP3:
|
||||
<code>
|
||||
AddType application/x-httpd-php3 .php3 .php
|
||||
</code>
|
||||
For PHP4:
|
||||
<code>
|
||||
AddType application/x-httpd-php .php3 .php
|
||||
</code>
|
||||
</p>
|
||||
<sect>About this document
|
||||
<sect1>New versions
|
||||
@ -153,6 +280,16 @@ name="http://sourceforge.net/mail/?group_id=7305">
|
||||
<item>Other minor additions.
|
||||
</itemize>
|
||||
</p>
|
||||
<p>
|
||||
v1.1 (September 27, 2000) - blinky
|
||||
</p>
|
||||
<p>
|
||||
<itemize>
|
||||
<item>Added Testing Install section
|
||||
<item>Added Trouble-shooting section
|
||||
<item>Added description of application installation
|
||||
</itemize>
|
||||
</p>
|
||||
<sect1>Copyrights and Trademarks
|
||||
<p>
|
||||
Copyright (c) Dan Kuykendall.
|
||||
@ -164,7 +301,7 @@ name="http://sourceforge.net/mail/?group_id=7305">
|
||||
A copy of the license is available at
|
||||
<url url="http://www.gnu.org/copyleft/fdl.txt" name="GNU Free Documentation License">.
|
||||
</p>
|
||||
<sect1>Acknowledgements and Thanks
|
||||
<sect1>Acknowledgments and Thanks
|
||||
<p>
|
||||
Thanks to Joesph Engo for starting phpGroupWare (at the time called webdistro) and the core of this HOWTO.
|
||||
Thanks to all the developers and users who contribute to making phpGroupWare such a success.
|
||||
|
||||
250
doc/HOWTO.txt
250
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<?php
|
||||
if (mkdir("/path/to/temp/directory",0700)) {
|
||||
echo "Directory created successfully";
|
||||
@ -150,30 +169,188 @@
|
||||
the sessions table.
|
||||
|
||||
This file is not required, you can simply disable cron_apps in the
|
||||
admin -> applications section to clean out the sessions table durring
|
||||
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 <http://sourceforge.net/phpgwapps/> 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 first 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.. AAbboouutt tthhiiss ddooccuummeenntt
|
||||
|
||||
66..11.. NNeeww vveerrssiioonnss
|
||||
|
||||
The newest version of this document can be found on our website
|
||||
<http://www.phpgroupware.org> as SGML source, HTML, or TEXT.
|
||||
|
||||
33..22.. CCoommmmeennttss
|
||||
66..22.. CCoommmmeennttss
|
||||
|
||||
Comments on this HOWTO should be directed to the phpGroupWare
|
||||
developers mailing list phpgroupware-developers@lists.sourceforge.net
|
||||
@ -182,12 +359,12 @@
|
||||
To subscribe, go to http://sourceforge.net/mail/?group_id=7305
|
||||
<http://sourceforge.net/mail/?group_id=7305>
|
||||
|
||||
33..33.. HHiissttoorryy
|
||||
66..33.. HHiissttoorryy
|
||||
|
||||
This document was started by Joseph Engo and reworked by Dan
|
||||
Kuykendall.
|
||||
|
||||
33..44.. VVeerrssiioonn HHiissttoorryy
|
||||
66..44.. VVeerrssiioonn HHiissttoorryy
|
||||
|
||||
Old Version
|
||||
|
||||
@ -196,13 +373,23 @@
|
||||
|
||||
v1.0 (July 6, 2000)
|
||||
|
||||
|
||||
+o Built proper SGML version.
|
||||
|
||||
+o Included the FAQ.
|
||||
|
||||
+o Other minor additions.
|
||||
|
||||
33..55.. CCooppyyrriigghhttss aanndd TTrraaddeemmaarrkkss
|
||||
v1.1 (September 27, 2000) - blinky
|
||||
|
||||
|
||||
+o Added Testing Install section
|
||||
|
||||
+o Added Trouble-shooting section
|
||||
|
||||
+o Added description of application installation
|
||||
|
||||
66..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
|
||||
@ -212,7 +399,7 @@
|
||||
A copy of the license is available at GNU Free Documentation License
|
||||
<http://www.gnu.org/copyleft/fdl.txt>.
|
||||
|
||||
33..66.. AAcckknnoowwlleeddggeemmeennttss aanndd TThhaannkkss
|
||||
66..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
|
||||
@ -250,6 +437,17 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user