extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2025-02-05 21:09:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

I only copied the cvs version.

Browse Source
This commit is contained in:
seek3r 2000-11-09 08:06:56 +00:00
parent 5788571211
commit 9215751229
9 changed files with 660 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
doc/sgml/about.sgml Normal file
View File

@ -0,0 +1,73 @@
<part label="VII">
<title>About this document</title>
<partintro>
<para>
The newest version of this document can be found on our website <ulink url="http://www.phpgroupware.org">
<citetitle>www.phpgroupware.org</citetitle></ulink>
as SGML source, HTML, or TEXT.
</para>
<simplesect>
<title>Comments</title>
<para>
Comments on this HOWTO should be directed to the phpGroupWare developers mailing list
<ulink url="mailto:phpgroupware-developers@lists.sourceforge.net">
<citetitle>phpgroupware-developers@lists.sourceforge.net</citetitle></ulink>
</para>
<para>
To subscribe, go to <ulink url="http://sourceforge.net/mail/?group_id=7305">
<citetitle>http://sourceforge.net/mail/?group_id=7305</citetitle></ulink>
</para>
</simplesect>
<simplesect>
<title>History</title>
<para>
This document was started by Joseph Engo and reworked by Dan Kuykendall.
</para>
</simplesect>
<simplesect>
<title>Version History</title>
<para>
Old Version
<itemizedlist mark=bullet>
<listitem>
<para>Created by Jengo, wasn't in SGML HOWTO format.</para>
</listitem>
</itemizedlist>
</para>
<para>
v1.0 (July 6, 2000)
</para>
<para>
<itemizedlist mark=bullet>
<listitem><para>Built proper SGML version.</para></listitem>
<listitem><para>Included the FAQ.</para></listitem>
<listitem><para>Other minor additions.</para></listitem>
</itemizedlist>
</para>
<para>
v1.1 (September 27-29, 2000) - blinky
</para>
<para>
<itemizedlist mark=bullet>
<listitem><para>Added Testing Install section</para></listitem>
<listitem><para>Added Trouble-shooting section</para></listitem>
<listitem><para>Added description of application installation</para></listitem>
<listitem><para>Changes for the new setup program</para></listitem>
</itemizedlist>
</para>
<para>
v0.01 (October 15 , 2000) - gnrfan , Converted the HOWTO to DocBook format
</para>
<para>
v.0.05 (November 5, 2000) - gnrfan , Completely revamped according to Seek's
idea and intregrated the Developers HOWTO.
</para>
<para>
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 :-).
</para>
</simplesect>
</partintro>
</part>

80
doc/sgml/admins.sgml Normal file
View File

@ -0,0 +1,80 @@
<part label="IV">
<title>Administering phpGroupWare</title>
<partintro>
<para>
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.
</para>
</partintro>
<chapter id="useracc">
<title>User Accounts</title>
<para>
In phpGroupWare it is very easy to maintain User Accounts. You can easily add , remove or
set previleges to the user accordingly.
</para>
<sect1 id="createu">
<title>Creating Accounts</title>
<para>
To create a user account goto <classname>User Accounts</classname> section
of <classname>Administration</classname> and the click the
<classname>Add</classname> 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 !!!
</para>
</sect1>
<sect1 id="maintainu">
<title>Maintaining Accounts</title>
<para>
Maintaining user accounts is also very easy. Just go to the
<classname>User Accounts</classname> 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 :->.
</para>
</sect1>
</chapter>
<chapter id="groupacc">
<title>Group Accounts</title>
<para>
Enter the <classname>User Group</classname> section. You would see
the current user groups.
</para>
<sect1 id="createg">
<title>Creating Accounts</title>
<para>
Click the <classname>Add</classname> 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.
</para>
</sect1>
<sect1 id="maintaing">
<title>Maintaining Accounts</title>
<para>
One has always a option to view and edit the groups when ever
needed
</para>
</sect1>
</chapter>
<chapter id="app">
<title>Applications</title>
<para>
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 <classname>Application</classname> section.
</para>
<sect1 id="installa">
<title>Installing</title>
<para></para>
</sect1>
<sect1 id="updata">
<title>Updating</title>
<para></para>
</sect1>
</chapter>
</part>

39
doc/sgml/devdocs.sgml Normal file
View File

@ -0,0 +1,39 @@
<part label="V">
<title>Developers Documentation</title>
<partintro>
<para>
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 :)
</para>
</partintro>
<chapter id="devaddapp">
<title>Developing Add-On Apps</title>
<para>text for developin add on apps (seek its your area)</para>
<sect1 id="requirdev">
<title>Requirements</title>
<para>
text for requirements
</para>
</sect1
<sect1 id="etc">
<title>add your topic seek</title>
<para>
text for the appropriate topic
</para>
</sect1>
</chapter>
<chapter id="apidocs">
<title> API documentation</title>
<para>
text for the API documentation chapter
</para>
<sect1 id="function1">
<title>function1(or what ever)</title>
<para>
the function you want to include seek.
</para>
</sect1>
</chapter>
</part>

45
doc/sgml/index.sgml Normal file
View File

@ -0,0 +1,45 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY installation SYSTEM "installation.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>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>
</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>
</dedication>
&introduction;
&installation;
&using;
&admins;
&devdocs;
&about;
</book>

169
doc/sgml/install.sgml Normal file
View File

@ -0,0 +1,169 @@
<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>
<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>
<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>

68
doc/sgml/installation.sgml Normal file
View File

@ -0,0 +1,68 @@
<part label="II">
<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.
</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.
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>
</simplesect>
</chapter>
<chapter id="obtaining">
<title>Obtaining phpGroupWare</title>
<para>
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.
</para>
<simplesect>
<title>Released Versions</title>
<para>
The downloads section on the <ulink url="http://www.phpgroupware.org/"><citetitle>site</citetitle></ulink>
contains links to the most recent releases, and several mirror sites
for the releases.
</para>
</simplesect>
<simplesect>
<title>Developer's version from CVS</title>
<para>
If you have never used CVS, you may want to read through the doucmentation
found at <ulink url="http://www.cvshome.org/"><citetitle>www.cvshome.org</citetitle>
</ulink>.
The CVS pages for the core and apps projects can be found at
<ulink url="http://sourceforge.net/cvs/?group_id=7305">
<citetitle>phpGroupWare Core CVS</citetitle></ulink>
, and <ulink url="http://sourceforge.net/cvs/?group_id=9787">
<citetitle>phpGroupWare Apps CVS</citetitle></ulink>.
Follow the directions for <emphasis>Anonymous CVS access</emphasis> and you should
have the most recent development copy of phpGroupWare in no time.
</para>
</simplesect>
</chapter>
&installing;
&trobshoot;
</part>

45
doc/sgml/introduction.sgml Normal file
View File

@ -0,0 +1,45 @@
<part label="I">
<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 :-).
</para>
</partintro>
<chapter id="what">
<title>What is phpGroupWare</title>
<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.
</para>
</chapter>
<chapter id="why">
<title>Why should u 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.
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">
<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.
</para>
</chapter>
<chapter id="copyright">
<title>Copyright</title>
<para>
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
<ulink url="http://www.gnu.org/copyleft/fdl.txt">
<citetitle>GNU Free Documentation License Making TeXWork</citetitle>
</ulink>
</para>
</chapter>
</part>

85
doc/sgml/trouble.sgml Normal file
View File

@ -0,0 +1,85 @@
<chapter id="trobleshooting">
<title>Trouble Shooting</title>
<warning>
<para>
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.
</para>
</warning>
<para>
The phpGroupWare developers can most often be seen hanging out in <emphasis>#phpGroupWare</emphasis>
on <emphasis>irc.openprojects.net</emphasis> if you require real-time help.
</para>
<para>
Also check the FAQ in this directory for additional common questions,
it is available as FAQ.sgml, FAQ.txt and FAQ.html
</para>
<sect1 id="trob1">
<title>I get "Unable to open mailbox" when using the email application</title>
<para>
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.
</para>
<para>
An preference page to edit the email settings is being developed, and should
appear shortly after the first beta release.
</para>
</sect1>
<sect1 id="trob2">
<title>It seems to hang when I try to read my mail</title>
<para>
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.
</para>
<para>
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.
</para>
<para>
You can either clean up your mailbox with another mail program, or
add the line
<programlisting>
set_time_limit(0);
</programlisting>
to the top of the inc/phpgwapi/phpgw_msg_pop3.inc.php file, just before
the line <classname>class msg extends msg_common</classname>
</para>
<para>
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.
</para>
</sect1>
<sect1 id="trob3">
<title>When I log in I see the directory listing instead of a web page</title>
<para>You are using Apache, this often means you need to add
<classname>.php</classname> to the <classname>DirectoryIndex</classname> line in your httpd.conf file.
For example:
<programlisting>
DirectoryIndex index.php index.php3 index.html index.htm index.cgi
</programlisting>
</para>
</sect1>
<sect1 id="trob4">
<title>I get garbage that looks like code when I go to the phpGroupWare URL</title>
<para>
This is often because you have php3 installed,
which does not map <classname>.php</classname> to the PHP engine.
For PHP3:
<programlisting>
AddType application/x-httpd-php3 .php3 .php
</programlisting>
For PHP4:
<programlisting>
AddType application/x-httpd-php .php3 .php
</programlisting>
</para>
</sect1>
</chapter>

56
doc/sgml/using.sgml Normal file
View File

@ -0,0 +1,56 @@
<part label="III">
<title>Using phpGroupWare</title>
<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
</para>
</partintro>
<chapter id="logingin">
<title>Loging into phpgw</title>
<para>
After your setup you can point your browser to <filename>index.php</filename> in the
installation directory. If the set up was right you can login with user name <classname>demo
</classname> and the password is <classname>1234</classname>> Now it is recommended to
create a new user with administrative privileges and delete the old one.
</para>
</chapter>
<chapter id="checkmail">
<title>checking Email</title>
<para></para>
</chapter>
<chapter id="addressbook">
<title>Using Addressbook</title>
<para></para>
</chapter>
<chapter id="calender">
<title>Using Calender</title>
<para></para>
</chapter>
<chapter id="fileman">
<title>Managing Files with file manager</title>
<para></para>
</chapter>
<chapter id="headlines">
<title>Getting Headlines</title>
<para></para>
</chapter>
<chapter id="hr">
<title>Human Resources</title>
<para></para>
</chapter>
<chapter id="pref">
<title>Preferences</title>
<para></para>
</chapter>
<chapter id="todo">
<title>Using todo</title>
<para></para>
</chapter>
<chapter id="tobtick">
<title>Using Trouble ticket</title>
<para></para>
</chapter>
</part>