holm/egroupware
1
1
Fork 0
forked from extern/egroupware
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added settings to preference page for the user to have seperate email settings

Browse Source
This commit is contained in:
seek3r 2000-11-11 09:37:31 +00:00
parent afd5b2e926
commit 5f7242e408
7 changed files with 291 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/sgml/about.sgml
View File

@ -70,4 +70,5 @@
</para>
</simplesect>
</partintro>
</part>

27
doc/sgml/index.sgml
View File

@ -1,38 +1,38 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY installation SYSTEM "installation.sgml">
<!ENTITY installing SYSTEM "install.sgml">
<!ENTITY troubleshoot SYSTEM "trouble.sgml">
<!ENTITY using SYSTEM "using.sgml">
<!ENTITY admins SYSTEM "admins.sgml">
<!ENTITY devdocs SYSTEM "devdocs.sgml">
<!ENTITY about SYSTEM "about.sgml">
<!ENTITY installing SYSTEM "install.sgml">
<!ENTITY trobshoot SYSTEM "trouble.sgml">
]>
<book>
<title>phpGroupWare Docs V0.05</title>
<bookinfo>
<authorgroup>
<author>
<firstname>Dan</firstname><surname>Kuykendall</surname>
<authorblurb>
<para>&lt;dan@kuykendall.org&gt</para>
</authorblurb>
<contrib><comment>the active developer of phpGroupWare</comment></contrib>
</author>
<author>
<firstname>Joseph</firstname><surname>Engo</surname>
<authorblurb>
<para>jengo@phpgroupware.org</para>
</authorblurb>
<contrib><comment>the founder and active of phpgroupware</comment></contrib>
</author>
<author>
<firstname>Dan</firstname><surname>Kuykendall</surname>
<authorblurb>
<para>&lt;dan@kuykendall.org&gt</para>
</authorblurb>
<contrib><comment>the active developer of phpGroupWare</comment></contrib>
</author>
<contrib><comment>the founder and active of phpgroupware</comment></contrib>
</author>
</authorgroup>
</bookinfo>
<dedication>
<para>
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.
</para>
Thanks to all the developers and users who contribute to making phpGroupWare such a success.
</para>
</dedication>
&introduction;
@ -42,4 +42,3 @@
&devdocs;
&about;
</book>

385
doc/sgml/install.sgml
View File

@ -1,169 +1,226 @@
<chapter id="installing">
<title>Installing on Tested Systems</title>
<para>
After you have met the system requirements, You can install
it from the TarBall or you can get it directly from CVS.
</para>
<sect1 id=tarballins>
<title>Installing from TarBall</title>
<para>Installing from a TarBall is very easy. 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
</para>
</sect1>
<sect1 id=CVSins>
<title>Installing from CVS</title>
<para>Fill this Seek3r</para>
</sect1>
<sect1>
<title>Setup / Configure phpGroupWare</title>
<para>
Copy the <filename>header.inc.php.sample</filename> file to
<filename>header.inc.php</filename> and edit the file, following the
directions in the comments.
</para>
<para>
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
<filename>header.inc.php</filename>. Setup will attempt to determine what version
of the phpGroupWare database you have installed, and upgrade to the most recent
version.
</para>
<note><title>Note</title>
<para>
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!
</para>
</note>
<para>
If you get no error messages, continue on to phpgroupware/setup/config.php
to configure phpGroupWare to your system.
</para>
<para>
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 <constant>chown
nobody.nobody</constant> and <constant>chmod 700</constant> 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.
</para>
<para>
If you do not have access to root, create this file and run it.
</para>
<programlisting>
&lt;?php
if (mkdir("/path/to/temp/directory",0700)) {
echo "Directory created successfully";
} else {
echo "Error creating directory";
}
?&gt;
</programlisting>
<para>
If you have access to cron, you may want to setup the files in the cron
directory.
</para>
<para>
stalesessions.pl - There are 2 reasons for this file.
<itemizedlist mark=bullet>
<listitem><para>Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk.</para></listitem>
<listitem><para>The email system requires plain text passwords which are stored in the sessions table.</para></listitem>
</itemizedlist>
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
</para>
<para>
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.
</para>
</sect1>
<sect1>
<title>Testing the install</title>
<para>
If your config is setup properly you can now login. Point your browser to the
installed location and login with the username <classname>demo</classname> and the password is <classname>1234</classname>
At this point it would be a good idea to create a new user with administrative privileges and
delete the old one.
</para>
</sect1>
<sect1>
<title>Installing additional applications</title>
<title>Installation Steps</title>
<para>
Once you have the core phpGroupWare install up and running,
you may want to download and install additional applications.
</para>
<para>
You should consult any <filename>README</filename> or <filename>INSTALL</filename>
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 <filename>lang.sql</filename>)
</para>
<para>
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.
</para>
<para>
For example, this is the process to install the
Headlines application (see <ulink url="http://sourceforge.net/phpgwapps/">
<citetitle>http://sourceforge.net/phpgwapps/</citetitle></ulink> for
more on this and other applications).
<itemizedlist mark=bullet>
<listitem><para>Download the .tar.gz file for the application, or check out the source
with cvs with
<programlisting>
export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'
cvs login (just hit enter if prompted for a password)
cvs co headlines
</programlisting></para></listitem>
<listitem><para>Move the <classname>headlines</classname> directory into your phpGroupWare
install directory.</para></listitem>
<listitem><para>Log into phpGroupWare as an administrative user, and go to the Administration page.
</para></listitem>
After you have met the system requirements, You can install
it from the TarBall or you can get it directly from CVS.
</para>
<listitem><para>In the first section, choose the <classname>Applications</classname> link.
</para></listitem>
<sect1 id=tarballins>
<title>Installing from TarBall</title>
<para>
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
</para>
<para>
(eg. /home/httpd/html for default apache configuration in many linux distros).
</para>
<para>
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.
</para>
</sect1>
<sect1 id=cvsins>
<title>Installing from CVS</title>
<para>
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:
<cmdsynopsis>
<command>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'</command><sbr>
<command>cvs login (just hit enter when prompted for a password)</command><sbr>
<command>cvs checkout phpgroupware</command>
</cmdsynopsis>
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:
<cmdsynopsis>
<command>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware'</command><sbr>
<command>cvs login (just hit enter when prompted for a password)</command><sbr>
<command>cvs checkout -d dirname phpgroupware</command>
</cmdsynopsis>
</para>
</sect1>
<sect1>
<title>Setup / Configure phpGroupWare</title>
<sect2>
<title>The config file</title>
<para>
Copy the <filename>header.inc.php.sample</filename> file to
<filename>header.inc.php</filename> and edit the file, following the
directions in the comments.
</para>
</sect2>
<sect2>
<title>Create database in MySQL</title>
<para>
An empty database will be needed for phpGroupWare. Here are the instructions for doing so with MySQL.
First create the database:
<cmdsynopsis>
<command>mysqladmin create phpgroupware -p</command>
</cmdsynopsis>
Then login to the mysql:
<cmdsynopsis>
<command>mysql -p</command>
</cmdsynopsis>
Finally grant the needed security rights:
<cmdsynopsis>
<command>grant all on phpgroupware.* to phpgroupware@localhost identified by "some_password";</command>
</cmdsynopsis>
</para>
</sect2>
<listitem><para>Click on add, and fill in the form.</para>
<para>
<application>Application name</application>
should be identical to the name
of the directory you moved into the phpGroupWare install, in this case use <classname>headlines</classname>
</para>
<para>
<application>Application Title</application>
is shown in the navigation bar and other places to refer to the
new application. Enter <classname>Headlines</classname> for this example.
</para>
<para>
<application>Enabled</application>
can be used to disable an application for all users temporially. You
should normal check the box to enable the application.
</para>
</listitem>
<listitem><para>Back in the Administration page, you need to enable the application for specific users
or user groups by editing them, and checking the new <classname>Headlines</classname> box that appears
in the middle of the account editing page.</para></listitem>
<listitem><para>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.</para></listitem>
<listitem><para>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.</para></listitem>
</itemizedlist>
</para>
</sect1>
<sect2>
<title>Create database in PostreSQL</title>
<para>
An empty database will be needed for phpGroupWare. Here are the instructions for doing so with PostgreSQL.
Create the database:
<cmdsynopsis>
<command>postmaster -i -D /home/[username]/[dataDir]</command>
</cmdsynopsis>
You will probably need to review PostgreSQL documentation for futher details.
</para>
</sect2>
<sect2>
<title>The Setup Program</title>
<para>
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
<filename>header.inc.php</filename>. Setup will attempt to determine what version
of the phpGroupWare database you have installed, and upgrade to the most recent
version.
</para>
<note><title>Note</title>
<para>
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!
</para>
</note>
<para>
If you get no error messages, continue on to phpgroupware/setup/config.php
to configure phpGroupWare to your system.
</para>
<para>
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 <constant>chown
nobody.nobody</constant> and <constant>chmod 700</constant> 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.
</para>
<para>
If you do not have access to root, create this file and run it.
</para>
<programlisting>
&lt;?php
if (mkdir("/path/to/temp/directory",0700)) {
echo "Directory created successfully";
} else {
echo "Error creating directory";
}
?&gt;
</programlisting>
</sect2>
<sect2>
<title>The phpGroupWare Daemon</title>
<para>
If you have access to cron, you may want to setup the files in the cron
directory.
</para>
<para>
stalesessions.pl - There are 2 reasons for this file.
<itemizedlist mark=bullet>
<listitem><para>Users always forget to logout. This way the session doesn't sit around forever, creating a possible security risk.</para></listitem>
<listitem><para>The email system requires plain text passwords which are stored in the sessions table.</para></listitem>
</itemizedlist>
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
</para>
<para>
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.
</para>
</sect2>
</sect1>
<sect1>
<title>Testing the install</title>
<para>
If your config is setup properly you can now login. Point your browser to the
installed location and login with the username <classname>demo</classname> and the password is <classname>1234</classname>
At this point it would be a good idea to create a new user with administrative privileges and
delete the old one.
</para>
</sect1>
<sect1>
<title>Installing additional applications</title>
<para>
Once you have the core phpGroupWare install up and running,
you may want to download and install additional applications.
</para>
<para>
You should consult any <filename>README</filename> or <filename>INSTALL</filename>
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 <filename>lang.sql</filename>)
</para>
<para>
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.
</para>
<para>
For example, this is the process to install the
Headlines application (see <ulink url="http://sourceforge.net/phpgwapps/">
<citetitle>http://sourceforge.net/phpgwapps/</citetitle></ulink> for
more on this and other applications).
<itemizedlist mark=bullet>
<listitem><para>Download the .tar.gz file for the application, or check out the source with cvs with
<cmdsynopsis>
<command>export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps'</command>
<command>cvs login (just hit enter if prompted for a password)</command>
<command>cvs co headlines</command><sbr>
</cmdsynopsis>
</para></listitem>
<listitem><para>Move the <classname>headlines</classname> directory into your phpGroupWare
install directory.</para></listitem>
<listitem><para>Log into phpGroupWare as an administrative user, and go to the Administration page.
</para></listitem>
<listitem><para>In the first section, choose the <classname>Applications</classname> link.
</para></listitem>
<listitem><para>Click on add, and fill in the form.</para>
<para>
<application>Application name</application>
should be identical to the name
of the directory you moved into the phpGroupWare install, in this case use <classname>headlines</classname>
</para>
<para>
<application>Application Title</application>
is shown in the navigation bar and other places to refer to the
new application. Enter <classname>Headlines</classname> for this example.
</para>
<para>
<application>Enabled</application>
can be used to disable an application for all users temporially. You
should normal check the box to enable the application.
</para>
</listitem>
<listitem><para>Back in the Administration page, you need to enable the application for specific users
or user groups by editing them, and checking the new <classname>Headlines</classname> box that appears
in the middle of the account editing page.</para></listitem>
<listitem><para>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.</para></listitem>
<listitem><para>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.
</para></listitem>
</itemizedlist>
</para>
</sect1>
</chapter>

52
doc/sgml/installation.sgml
View File

@ -3,32 +3,52 @@
<title>Installation</title>
<partintro>
<para>
Installation and Configuration of phpGroupWare has never been easy. Just point and click , yeah
its very easy :-). Since this is still a beta version we do expect some bugs . By carefully reading
this document you can easly install phpGroupWare.
<literallayout>
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.
</literallayout>
</para>
<para>
Since this is still a beta version we do expect some bugs.
</para>
</partintro>
<chapter id="requirements">
<title>Requirements</title>
<para>
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.
You will need PHP compiled and installed on your system. You will also need MySQL, PostgreSQL or Oracle setup.
</para>
<para>
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.
</para>
<simplesect>
<title>Tested Systems</title>
<para>
On Linux 2.2.x
<itemizedlist mark=bullet>
<listitem><para>PHP 3.0.15+ / PHP 4.0.x</para></listitem>
<listitem><para>Apache 1.3.x</para></listitem>
<listitem><para>MySQL 3.22.25 or PostgreSQL 7.0.x</para></listitem>
<listitem><para>Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access</para></listitem>
</itemizedlist>
We have reports of it working on Windows NT and OS/2, and using Oracle as the database.</para>
Seek3r has tested:
<itemizedlist mark=bullet>
<listitem><para>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</para></listitem>
</itemizedlist>
Blinky has tested:
<itemizedlist mark=bullet>
<listitem><para>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</para></listitem>
<listitem><para>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.</para></listitem>
</itemizedlist>
Jengo has tested:
<itemizedlist mark=bullet>
<listitem><para>main test box: Red Hat 6.2,Apache 1.3.12,PHP 3.0.16,PostgreSQL 7.2,Sendmail (from RH6.2)</para></listitem>
<listitem><para>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</para></listitem>
<listitem><para>Test box: Win2k with IIS5.0, PHP4.0.2 and MySQL</para></listitem>
</itemizedlist>
There are installations on Windows NT and OS/2, and using MySQL or Oracle as the database.
</para>
</simplesect>
</chapter>
<chapter id="obtaining">
@ -63,6 +83,6 @@
</para>
</simplesect>
</chapter>
&installing;
&trobshoot;
&installing;
&troubleshoot;
</part>

26
doc/sgml/introduction.sgml
View File

@ -2,8 +2,10 @@
<title>Introduction</title>
<partintro>
<para>
do yo have questions on using phpGroupWare , like What? Why? What for? What's in for me?
then you should seriously read this doc :-).
Do yo have questions on using phpGroupWare , like What? Why? What for? What's in for me?
</para>
<para>
Then you should seriously read this doc :-).
</para>
</partintro>
<chapter id="what">
@ -11,28 +13,36 @@
<para>
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 ,PostgreSQL and
al oracle.
It should run on all systems where PHP is installed and has access to a SQL server (MySQL ,PostgreSQL or Oracle).
</para>
</chapter>
<chapter id="why">
<title>Why should u use it</title>
<title>Why should you use it</title>
<para>
You should use it if you would like a powerful groupware system that can be access from anywhere on the Internet.
</para>
<para>
For companies with a distributed user base, it's an ideal solution. Oh, and did I mention that its FREE?
</para>
</chapter>
<chapter id="dochis">
<chapter id="apphis">
<title>A short History</title>
<para>
This document was started by Joseph Engo and reworked by Dan Kuykendall and converted to do
DocBook By Powell Molleti.
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.
</para>
<para>
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.
</para>
</chapter>
<chapter id="copyright">
<title>Copyright</title>
<para>
Copyright (c) Dan Kuykendall.
</para>
<para>
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

2
doc/sgml/trouble.sgml
View File

@ -1,4 +1,4 @@
<chapter id="trobleshooting">
<chapter id="troubleshoot">
<title>Trouble Shooting</title>
<warning>
<para>

2
doc/sgml/using.sgml
View File

@ -3,7 +3,7 @@
<partintro>
<para>
Using phpGroupWare is a cake walk , thats what people say :-). Reading this doc would
definitely give a head start. If u ever comea cross any problem please report to
definitely give a head start. If you ever come cross any problem please report to
</para>
</partintro>
<chapter id="logingin">