From 4a8a26b367f52e5ab17967f21cc60ea47db2061e Mon Sep 17 00:00:00 2001 From: brandonne Date: Thu, 4 Oct 2001 21:18:32 +0000 Subject: [PATCH] converting previous documents to sgml format --- doc/sgml/admin/addressbook.sgml | 4 + doc/sgml/admin/calendar.sgml | 4 + doc/sgml/admin/email.sgml | 4 + doc/sgml/admin/filemanager.sgml | 4 + doc/sgml/admin/general.sgml | 21 + doc/sgml/admin/installation.sgml | 539 ++++++++++++++++++ doc/sgml/admin/introduction.sgml | 25 + doc/sgml/admin/notes.sgml | 4 + doc/sgml/admin/performance.sgml | 28 + doc/sgml/admin/phpGroupWare-Admin-Manual.sgml | 52 ++ doc/sgml/admin/project.sgml | 4 + doc/sgml/admin/security.sgml | 4 + doc/sgml/admin/todo.sgml | 4 + doc/sgml/admin/upgrading.sgml | 17 + 14 files changed, 714 insertions(+) create mode 100644 doc/sgml/admin/addressbook.sgml create mode 100644 doc/sgml/admin/calendar.sgml create mode 100644 doc/sgml/admin/email.sgml create mode 100644 doc/sgml/admin/filemanager.sgml create mode 100644 doc/sgml/admin/general.sgml create mode 100644 doc/sgml/admin/installation.sgml create mode 100644 doc/sgml/admin/introduction.sgml create mode 100644 doc/sgml/admin/notes.sgml create mode 100644 doc/sgml/admin/performance.sgml create mode 100644 doc/sgml/admin/phpGroupWare-Admin-Manual.sgml create mode 100644 doc/sgml/admin/project.sgml create mode 100644 doc/sgml/admin/security.sgml create mode 100644 doc/sgml/admin/todo.sgml create mode 100644 doc/sgml/admin/upgrading.sgml diff --git a/doc/sgml/admin/addressbook.sgml b/doc/sgml/admin/addressbook.sgml new file mode 100644 index 0000000000..e3ae883432 --- /dev/null +++ b/doc/sgml/admin/addressbook.sgml @@ -0,0 +1,4 @@ + + +Addressbook + diff --git a/doc/sgml/admin/calendar.sgml b/doc/sgml/admin/calendar.sgml new file mode 100644 index 0000000000..e4f0e50250 --- /dev/null +++ b/doc/sgml/admin/calendar.sgml @@ -0,0 +1,4 @@ + + +Calendar + diff --git a/doc/sgml/admin/email.sgml b/doc/sgml/admin/email.sgml new file mode 100644 index 0000000000..e05b25317e --- /dev/null +++ b/doc/sgml/admin/email.sgml @@ -0,0 +1,4 @@ + + +Email + diff --git a/doc/sgml/admin/filemanager.sgml b/doc/sgml/admin/filemanager.sgml new file mode 100644 index 0000000000..3e4d7f11ad --- /dev/null +++ b/doc/sgml/admin/filemanager.sgml @@ -0,0 +1,4 @@ + + +File Manager + diff --git a/doc/sgml/admin/general.sgml b/doc/sgml/admin/general.sgml new file mode 100644 index 0000000000..bf9f80698a --- /dev/null +++ b/doc/sgml/admin/general.sgml @@ -0,0 +1,21 @@ + + +General + + +Here will go an overview of categories and other overall topics. + + + +Categories + + +Themes + + +Access Control Lists + + +Translations + + diff --git a/doc/sgml/admin/installation.sgml b/doc/sgml/admin/installation.sgml new file mode 100644 index 0000000000..e53861ee39 --- /dev/null +++ b/doc/sgml/admin/installation.sgml @@ -0,0 +1,539 @@ + + + +Installation + +Installation and Configuration of phpGroupWare has never +been easier. Just point and click, yeah it's very easy. + + +Since this is still a beta version we do expect some bugs. +By carefully reading this document you can easly install +phpGroupWare. + + +Requirements + +You will need PHP compiled and installed on your system. +You will also need MySQL or PostgreSQL setup. If you are +planning on using the email system, you will need to have +an IMAP server installed and IMAP support compiled into +PHP. You can have it installed as an Apache module or command +line version, the Apache module is preferred. We will assume +that you are running on a Linux or other Unix system for +these steps. Windows is supported, but there is no documentation +for it currently. + + +In order to check if you have php installed create the file +with your favorite text editor named test.php in your webserver +root directory: + + +<? phpinfo(); ?> + + +Then point your browser to http://yourserverroot/test.php. +You should get a very detailed page describing various options +in php. + + +If you need to to compile php and apache the following links +are good starting points: + + + +http://www.apachetoolbox.com + +A set of scripts to compile and install various modules with +apache. + + + +http://www.linuxhelp.net/guides/ + +The Linux Apache MySQL PHP (LAMP) Guide v2 (latest as of +this writing) + + + +http://www.devshed.com/Server_Side/PHP/SoothinglySeamless + +The Soothing Seemless Setup of Apache, SSL, MySQL, and PHP + + + + + + +Tested Systems + +On Linux 2.2.x, 2.4.x + + + + +PHP 3.0.15+ / PHP 4.0.x + + + + +Apache 1.3.x + + + + +MySQL 3.22.25 or PostgreSQL 7.0.x + + + + +Courier-IMAP 0.33+ and/or qmail 1.03 for POP3 access + + + + +We have reports of it working on Windows NT and OS/2, and using Oracle as the database. + + + +Obtaining and Installing phpgroupware + +Installing from TarBall + +Installing from a TarBall is very easy. The files should +be installed in the webserver directory. Example steps (please +adjust to your servers config): + +
+# cp phpgroupware-version.tar.gz /home/httpd/html +# cd /home/httpd/html +# tar zxf phpgroupware-version.tar.gz +
+ +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. + + +You can get current releases of phpGroupWare at the phpGroupware +website. + + + +Installing from CVS + +Installing from a CVS is fairly easy. The files should be checked out in the webserver directory. +You may have to get required permissions to install from CVS. Contact your system administrator if you dont have the permission to write to your webserver directory. + + +To see a list of applications currently available via CVS, go to [http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/phpgroupware/] + + +Development Branch in CVS +Follow these steps (please adjust to your servers config): +
+# cd /home/httpd/html +# cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co phpgroupware +# cd phpgroupware +# cvs co admin addressbook calendar email phpgwapi preferences setup todo notes infolog +
+ +or if you prefer using CVSROOT: + +
+# export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware' +# cvs co phpgroupware +# cd phpgroupware +# cvs co admin addressbook calendar email phpgwapi preferences setup todo notes infolog +
+ + +Stable Branch in CVS + +Follow these steps (please adjust to your servers config): + +
+# cd /home/httpd/html +# cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co -r Version-0_9_12-branch phpgroupware +# cd phpgroupware +# cvs co -r Version-0_9_12-branch admin addressbook calendar email phpgwapi preferences setup todo notes infolog +
+ +or if you prefer using CVSROOT: + +
+# export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware' +# cvs co -r Version-0_9_12-branch phpgroupware +# cd phpgroupware +# cvs co -r Version-0_9_12-branch admin addressbook calendar email phpgwapi preferences setup todo notes infolog +
+ + +Patched Branches in CVS + +Recently the phpGroupWare developers started a branch for patches to released versions. This is to facilitate bugs being fixed in a released version without having to wait for the next offical release. There is a developer who has been assigned the responsibility for maintaining that branch and applying patches and fixes. To check out this version of the code using 0.9.12 as an example you would do the following: + +
+# cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware -r Version-0_9_12-patches phpgroupware +
+ + + +Setting File Permissions + +There are a few directories which will need special fie permissions set for phpGroupWare to work properly. + + + +Temp Directory (Required) - This can be /tmp for simplicity, but it is required for several apps to function properly. Simply make sure that the webserver can add/delete files in it. + + + +Files Directory (Required) - This can be should be the files dir under the phpgroupware dir. You will need to give the webserver account owndership of this directory. + +
+(from phpgroupware root) +# mkdir files +# mkdir files/groups +# mkdir files/users +# chown nobody:nobody files (note: this assumes your webserver runs as user nobody, adjust for your installation) +# chmod 700 files +
+ + +Root Directory (Not recommended) - If you give the webserver account write access to the phpgroupware directory, then the setup program can create the header.inc.php for you. Otherwise you will need to use the setup program to create it, and then you can manually save it to file. + + + +If you want to do it: + +
+# chown :nobody phpgroupware +# chmod 770 phpgroupware +
+ +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. + + + +Setup the database + +You need to create empty databases for the setup app to create the tables in. + + +MySQL + +Ensure that you have a working MySQL installation and that MySQL is running. + +
+Mandrake or Redhat: +/etc/rc.d/init.d/mysqld start +other: +/usr/local/mysql/bin/safe_mysqld & +
+Create the phpgroupware Database and give permissions to the phpgroupware user +
+# mysqladmin -u someuser -p create phpgroupware (enter password when prompted) +# mysql -u someuser -p +mysql> grant all on phpgroupware.* to phpgroupware@localhost identified by "somepassword"; +
+ + +Make sure you change the password from "somepassword" to your MySQL password in the GRANT statement +For more detailed user documentation on MySQL see their website: [http://www.mysql.com] + + + + +PostgreSQL + +Ensure that you have a working PostgreSQL installation and that PostgreSQL is running. + +
+Mandrake or Redhat : +/etc/rc.d/init.d/postgresql start +Others: + /usr/bin/postmaster -D /var/lib/pgsql/data or /usr/bin/pg_ctl -D /var/lib/pgsq/data start (adjust for your install dirs) +
+ +Create the phpgroupware database and user + +
+ # /usr/bin/createdb phpgroupware + # /usr/bin/createuser phpgroupware --pwprompt +
+ +For more detailed user documentation on Postgresql see their website: [http://www.postgresql.org] + + + + + +Setup/Configure phpGroupWare + +configure header file + +Point your browser to http://yourserverroot/phpgroupware/setup/ which will create (or upgrade) the header.inc.php and database tables. Setup will attempt to determine what version of the phpGroupWare databases and header.inc.php you have installed, and upgrade to the most recent version. + + +Most values for the header setup can be left as the default, be sure to enter a password for header admin, and change the password for your DB, and for configuration. + + +*addme* What is mcrypt for? + + +*addme* Explain what the Domain select box is for + + +Once you have finished your configuration, you can have phpGroupWare write it directly if you changed permissions on the directory, or you can download or view it with your browser, and save it in the directory yourself. + + + +Site Configuration + +After header configuration, you will be prompted to enter your Setup/Config Login, or your Header login if you want to go back and change something. + + + +You are advised to backup your existing database before running the setup script to avoid problems! + + + + +You have to press the button, not hit enter on the setup/index.php script + + + +Your first step is to install all application databases, simply click on the Install to have phpGroupWare add all the necessary tables. + + +Next, click on Edit Current Configuration. You will be prompted with a list of configuration options. + +Edit Current Configuration + + + +Prompt +Notes + + + +full path for temporary files +usually /tmp + +full path for user and group files +directory must exist and have user and group directories underneath it. + + +location of phpGroupWare URL + +full domain name or just relative link, no trailing slash + + +hostname of machine + Fully qualified hostname + + +default ftp server + *addme* what is this for? + + +use correct mimetype for FTP + *addme* what might this affect? + + +HTTP proxy server + + +HTTP proxy port + + +Which type of Authentication + + +SQL use SQL table (default) +SQL/SSL use encrypted SQL access +LDAP use LDAP server +mail use mail server (IMAP/POP3) +HTTP use HTTP authentication (.htaccess) +PAM use PAM authentication (note currently working) + + + + +Where to store user accounts + + +SQL store in SQL table +LDAP store in LDAP server +Contacts *addme* what is this? + + + +Minimum account ID + + +Maximum account ID + + +manage homedirectory and loginshell attributes + *addme* what is this? + + +LDAP home directory prefix + + +LDAP default shell + + +Auto create account records? +*addme* what is this? + + +if no ACL records... + + +LDAP host + + +LDAP accounts context + + +LDAP root dn + + +LDAP root password + + +LDAP encryption type + + +app_session encryption +*addme* what is this? + + +title for your site + + +Show powered by logo on + + +Country Selection + + +use pure HTML + + +Use cookies + + +check for new version? +*addme* what does this check, stable version or CVS? + + +cache the phpgw_info array +*addme* what effect does this have on speed, what tradeoffs? + + + +
+ + +Next, select click here to add admin account and optionally, three demo accounts. Fill in the fields on the next screen and uncheck the box at the bottom if you don't want the demo accounts created. Click on Submit when finished. + + +Click Install Languages to add at least one language to the system. On the next screen, select all the languages you want by single clicking them, then click on Install. + + +There shouldn't be anything to do under Manage Applications at this time, this is where you will return after an upgrade to update and table differences. + + +after your done, click on logout to complete the install and end the session. + + + +Testing the install + +If your config is setup properly you can now login. Point your browser to the installed location and login with the new admin username and password you created. + + + + +Installing additional applications + + +Once you have the core phpGroupWare install up and running, you may want to download and install additional applications. + + + +You should consult any README or INSTALL files that come with the new application first, as most require you to create additional tables in the database, and add additional translation data to the lang table (typically a file called lang.sql) + + + +You install the new application within the phpGroupWare install tree by copying the application directory into the phpGroupWare install location, and enabling the application through the Administration page. + + + + +For example, this is the process to install the Headlines application: (see [http://www.sourceforge.net/projects/phpgwapps] for more applications) + + + +Download the .tar.gz file for the application, or check out the source with cvs with + +
+# export CVSROOT=':pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgwapps' +# cvs login (just hit enter if prompted for a password) +# cvs co headlines +
+ +Move the headlines directory into your phpGroupWare install directory. + + + +Log into phpGroupWare as an administrative user, and go to the Administration page. + + + +In the first section, choose the Applications link. + + + +Click on add, and fill in the form. + + + +Application name should be identical to the name of the directory you moved into the phpGroupWare install, in this case use headlines + + + +Application title is shown in the navigation bar and other places to refer to the new application. Enter Headlines for this example. + + + +Enabled can be used to disable an application for all users temporially. You should normal check the box to enable the application. + + + +Back in the Administration page, you need to enable the application for specific users or user groups by editing them, and checking the new Headlines box that appears in the middle of the account editing page. + + + +Once you have added the Headlines app to your account, you should see a Headlines entry in the Administration and Preferences pages, and there should be an icon for the Headlines application in the navigation bar. + + + +Once you enable a few of the Headlines sites through the Administration page link, you should see headlines grabbed from the sites you selected when you click on the Headlines icon in the navigation bar. + + + + + +Troubleshooting + +deb package of 4.0.6 has a problem with cookies, the setup program uses cookies +See the FAQ + + + diff --git a/doc/sgml/admin/introduction.sgml b/doc/sgml/admin/introduction.sgml new file mode 100644 index 0000000000..fbfdf5645d --- /dev/null +++ b/doc/sgml/admin/introduction.sgml @@ -0,0 +1,25 @@ + + + +Introduction + +What is phpGroupWare + +phpGroupWare is a multi-user web-based suite written in PHP. It contains many applications, including a Calendar, email package, contact database and project manager. It also includes an extensive API for writing new applications. + + + + +Acknowledgements + +I would like to thank the many authors of phpGroupWare and it's applications for creating such a useful and extensible product. I would also like to thank the authors of previous version of the documentation, including Dan Kuykendall, Joseph Engo and Darryl VanDorp and the authors of the LDP Author guide for teaching me how to use DocBook. + + + + +Notes + +This document is based upon the current CVS release, where possible I included notes relating to the current stable release (0.9.12). This is a work in progress, please email any corrections to bneill@yahoo.com. + + + diff --git a/doc/sgml/admin/notes.sgml b/doc/sgml/admin/notes.sgml new file mode 100644 index 0000000000..4e3128e8fe --- /dev/null +++ b/doc/sgml/admin/notes.sgml @@ -0,0 +1,4 @@ + + +Notes + diff --git a/doc/sgml/admin/performance.sgml b/doc/sgml/admin/performance.sgml new file mode 100644 index 0000000000..b5bf1a8792 --- /dev/null +++ b/doc/sgml/admin/performance.sgml @@ -0,0 +1,28 @@ + + +Performance Tuning + +Linux + + +Apache + + +PHP + + +Database + +When phpgroupware is used by 5+ users, the number of connections to the backend grows very fast toward it's limits. + +A patch is available for 0.9.12 to allow for non-persistent connections. This patch adds to the header managing page to allow for non-persistent connections. It's only made for mysql, postgresql and oracle, but should be portable. + + +The patch is available at [http://karlsbakk.net/dev/phpgw/persistent-connections- choice.patch] + + + + +phpGroupWare + + diff --git a/doc/sgml/admin/phpGroupWare-Admin-Manual.sgml b/doc/sgml/admin/phpGroupWare-Admin-Manual.sgml new file mode 100644 index 0000000000..1825a4516e --- /dev/null +++ b/doc/sgml/admin/phpGroupWare-Admin-Manual.sgml @@ -0,0 +1,52 @@ + + + + + + + + + + + + + +]> + + + + +phpGroupWare Administration Manual + + +BrandonNeill + + +Brandon Neill just wanted to figure out how to use the program and decided to write a manual as an excuse to bug the developers. + + + + +$Revision$, $Date$ + + +This Manual is for administrators of phpGroupware. + + + +&introduction +&installation +&upgrading +&general +&calendar +&email +&addressbook +¬es +&todo +&project +&filemanager +&security +&performance + + diff --git a/doc/sgml/admin/project.sgml b/doc/sgml/admin/project.sgml new file mode 100644 index 0000000000..3b6ab85619 --- /dev/null +++ b/doc/sgml/admin/project.sgml @@ -0,0 +1,4 @@ + + +Project + diff --git a/doc/sgml/admin/security.sgml b/doc/sgml/admin/security.sgml new file mode 100644 index 0000000000..d744db5868 --- /dev/null +++ b/doc/sgml/admin/security.sgml @@ -0,0 +1,4 @@ + + +Security + diff --git a/doc/sgml/admin/todo.sgml b/doc/sgml/admin/todo.sgml new file mode 100644 index 0000000000..13b0f722af --- /dev/null +++ b/doc/sgml/admin/todo.sgml @@ -0,0 +1,4 @@ + + +Todo + diff --git a/doc/sgml/admin/upgrading.sgml b/doc/sgml/admin/upgrading.sgml new file mode 100644 index 0000000000..a95a548047 --- /dev/null +++ b/doc/sgml/admin/upgrading.sgml @@ -0,0 +1,17 @@ + + +Upgrading + +Upgrading from CVS + +Follow these steps to upgrade a CVS install (please adjust to your servers config): + +
+# cd /home/httpd/html/phpgroupware +# cvs update -pD +
+ +After updating from CVS, be sure to return to the configuration page [/setup] and update any necessary tables + + +