From b11a8b317080ddf2ccb0e956445ade8004b09b43 Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Fri, 19 Mar 2010 12:53:27 -0600 Subject: [PATCH] INSTALL documentation improvements/fixes --- horde/docs/INSTALL | 90 +++++++++++++++++++++----------------------------- horde/docs/PERFORMANCE | 6 ++-- horde/docs/SECURITY | 6 ++-- 3 files changed, 42 insertions(+), 60 deletions(-) diff --git a/horde/docs/INSTALL b/horde/docs/INSTALL index ade64f292..b9a5ffa61 100644 --- a/horde/docs/INSTALL +++ b/horde/docs/INSTALL @@ -75,20 +75,21 @@ below at Prerequisites_. cd php-x.x.x/ ./configure --with-apxs=/usr/sbin/apxs \ - --with-gettext --with-mcrypt --enable-mbstring \ - --with-gd --with-png-dir=/usr --with-jpeg-dir=/usr \ - --with-mime-magic=/user/share/misc/magic.mime \ + --with-gettext --enable-mbstring --with-gd \ + --with-png-dir=/usr --with-jpeg-dir=/usr \ [--with-mysql|--with-pgsql|--with-oci8|--with-ldap] + [--with-mcrypt] [--with-tidy] make make install 2. Restart Apache. -3. Install PEAR packages:: +3. Install PEAR/PECL packages:: pear install -o Crypt_Blowfish Date DB File Mail Net_DNS \ Services_Weather pear -d preferred_state=beta install -a HTTP_WebDAV_Server + pecl install -o fileinfo idn lzf [memcache] 4. Extract tarball:: @@ -125,13 +126,11 @@ The following prerequisites are **REQUIRED** for Horde to function properly. 1. A webserver that supports PHP. - Horde and its applications are developed under the Apache webserver, which - we recommend. Apache is available from + Horde is primarily developed under the Apache and Lighttpd webservers, + which we recommend. These servers are available from: http://httpd.apache.org/ - - Horde has also been reportedly used successfully under Microsoft IIS, among - others. + http://www.lighttpd.net/ 2. PHP 5.2.0 or above. @@ -229,18 +228,7 @@ The following prerequisites are **REQUIRED** for Horde to function properly. will be configurable via Horde's web interface - the default values stored in each applications ``config/prefs.php`` file will be used. - c. Mcrypt support ``--with-mcrypt`` - - Mcrypt is a general-purpose cryptography library which is broader and - more efficient (FASTER!) than the default encryption method. You can - obtain mcrypt from - - http://mcrypt.sourceforge.net/ - - Building PHP without mcrypt support will not stop Horde from working, - but will force it to use slower encryption. - - d. UTF-8 support ``--enable-mbstring`` + c. UTF-8 support ``--enable-mbstring`` If these extensions are enabled, Horde can support multibyte character sets like UTF-8 (meaning that content with any charset can be viewed @@ -253,7 +241,7 @@ The following prerequisites are **REQUIRED** for Horde to function properly. Iconv support is enabled by default in PHP 5. You only have to make sure that you do **not** use ``--without-iconv`` - e. GD support ``--with-gd`` + d. GD support ``--with-gd`` Horde will use the GD extension to perform manipulations on image data through the Horde_Image library. @@ -272,16 +260,29 @@ The following prerequisites are **REQUIRED** for Horde to function properly. .. _ImageMagick: http://www.imagemagick.org - f. tidy ``--with-tidy`` + e. tidy ``--with-tidy`` The tidy PHP extension is required to sanitize HTML data. + The following PHP options are **OPTIONAL** to enable advanced features in + Horde: + + a. Mcrypt support ``--with-mcrypt`` + + Mcrypt is a general-purpose cryptography library which is more efficient + than using native PHP-based encryption. If available, mcrypt is used to + encrypt/decrypt the authentication credentials stored within the + session. Mcrypt can be obtained from: + + http://mcrypt.sourceforge.net/ + .. Important:: Additionally, individual Horde applications may **REQUIRE** or **RECOMMEND** other options to be built into PHP also. Please check ``docs/INSTALL`` for all applications you wish to use to see if other PHP options are needed. -3. Additional PEAR Modules + +3. PEAR Modules PEAR is short for "PHP Extension and Application Repository". The goal of PEAR is to provide a means of distributing reusable code. @@ -387,7 +388,7 @@ The following prerequisites are **REQUIRED** for Horde to function properly. For more detailed directions on installing PEAR modules, see the PEAR documentation at http://pear.php.net/manual/ -4. Additional PECL Modules +4. PECL Modules PECL is short for "PHP Extension Community Library". The goal of PECL is to provide a means of easily distributing PHP extensions. @@ -426,8 +427,7 @@ The following prerequisites are **REQUIRED** for Horde to function properly. b. memcache - If using the memcached SessionHandler, the memcache PECL extension must - be installed. + If using memcache, the memcache PECL extension must be installed. To install, enter the following at the command prompt:: @@ -435,7 +435,7 @@ The following prerequisites are **REQUIRED** for Horde to function properly. c. lzf - If the lzf module is available, Horde can compress some cached data in + If the lzf module is available, Horde can compress cached data within the current session, thus reducing the size of the current session. To install, enter the following at the command prompt:: @@ -463,8 +463,7 @@ if you use a specific Horde application (as noted in [brackets]): Horde uses sendmail, or a program that implements the ``sendmail(8)`` API (as included with postfix, qmail, and exim, among others). If your system does not already have a full mail transport with a sendmail interface, you - can configure Horde to speak directly with a remote SMTP server, but this - may incur a performance penalty. + can configure Horde to speak directly with a remote SMTP server. 2. aspell - Spelling Checker @@ -511,7 +510,7 @@ Skip the next paragraph if you installed Horde from a release tarball. Installing from Git ~~~~~~~~~~~~~~~~~~~ -TODO. See:: +See:: http://horde.org/source/git.php @@ -596,7 +595,7 @@ Configuring Horde 4. Setting up alarm emails If you want your users to be able to receive emails from the Horde_Alarm - system, you must set up a cron entry for ``horde/scripts/alarms.php``, you + system, you must set up a cron entry for ``horde/bin/alarms.php``, you must have at least one administrator specified in the Horde configuration, and you must have the PHP CLI installed (a CGI binary is not supported - ``php -v`` will report what kind of PHP binary you have). @@ -604,7 +603,7 @@ Configuring Horde Running the job every 5 minutes is recommended:: # Horde Alarms - */5 * * * * /usr/bin/php /var/www/horde/scripts/alarms.php + */5 * * * * /usr/bin/php /var/www/horde/bin/alarms.php (replace ``/usr/bin/php`` with the path to your PHP CLI and ``/var/www/horde/`` with the path to your Horde installation) @@ -660,14 +659,13 @@ Configuring Horde - IP name/number of the IMAP server - For a secure connection, select port 993. - - Select the protocol; for a secure connection either ``imap/ssl`` or - ``imap/ssl/novalidate-cert`` (for self-signed certificates). + - Select the secure connection protocol to use, if desired. Continue to configure Horde through all the tabs of the setup interface and - click on ``Generate Horde Configuration``. Important items that you - probably want to configure are the ``Preference System`` that lets users - save their personal options, and the ``DataTree System`` that is required - for some applications to work at all. + click on ``Generate Horde Configuration``. An important item that you + probably want to configure is the ``Database Settings``, which defines the + database configuration that is used, by default, for several different + Horde sub-systems. Configuration of applications in ``registry.php`` is documented in the ``INSTALL`` file of each application. Most applications require you to @@ -675,15 +673,6 @@ Configuring Horde account is any normal Horde account that has been added to the administrator list in the ``Authentication`` tab of the Horde setup. - .. Note:: If using a version of Horde obtained via Git, the compressed - javascript files in the ``js/`` directory will not exist. You - must configure Horde to use the files contained in the ``js/src`` - directory instead. This can be done via the ``jsuri`` or - ``jspath`` parameters in ``config/registry.php``. If desired, the - javascript files can be compressed with the - ``horde-js-compress.php`` script contained in the horde-support - Git repository. - The other files in that directory need only be modified if you wish to customize Horde's appearance or behaviour -- the defaults will work at most sites. @@ -727,11 +716,6 @@ Configuring Horde For more information about securing your webserver, PHP and Horde, see the `docs/SECURITY`_ file. -8. Entering the survey - - If you like, go to http://www.horde.org/survey/ and enter the details of - your system. - Configuring Applications ======================== diff --git a/horde/docs/PERFORMANCE b/horde/docs/PERFORMANCE index 6f453e2ed..03fc74ac3 100644 --- a/horde/docs/PERFORMANCE +++ b/horde/docs/PERFORMANCE @@ -2,7 +2,7 @@ Horde Performance Guide ========================= -:Contact: horde@lists.horde.org +:Contact: horde@lists.horde.org .. contents:: Contents @@ -34,8 +34,8 @@ Webserver/PHP tuning the need to recompile the code for every single page load. **This is probably the easiest way to improve the performance of Horde**. -* Use of the mcrypt PHP extension should significantly increase performance - while also increasing security. +* Use of the mcrypt PHP extension may increase performance on heavily loaded + servers. * Enable PHP output compression in the Horde configuration. Do not enable compression in the PHP configuration (i.e. in ``php.ini``), because certain diff --git a/horde/docs/SECURITY b/horde/docs/SECURITY index b70ae84ee..2a13ee26c 100644 --- a/horde/docs/SECURITY +++ b/horde/docs/SECURITY @@ -2,7 +2,7 @@ Horde Security Notes ====================== -:Contact: horde@lists.horde.org +:Contact: horde@lists.horde.org .. contents:: Contents .. section-numbering:: @@ -44,9 +44,7 @@ Sites with a large user base should consider setting the ``session.entropy_file`` and ``session.entropy_length`` to appropriate values. Horde will encrypt the user credentials before storing them in the session. -However, this encryption can be improved if you have and enable the PHP -extension "mcrypt" which allows for stronger encryption than is otherwise -provided by Horde. +Thus, a compromised sessions will not reveal the user's stored credentials. Default database passwords -- 2.11.0