"Fossies" - the Fresh Open Source Software Archive

Member "phpESP/docs/INSTALL" (22 Mar 2009, 10973 Bytes) of package /linux/www/old/phpESP-2.1.4.tgz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 ****** NOTICE ******
    2 You should backup your production phpESP database before upgrading to this release.
    3 We are now using ADODB and have made significant changes to the database API which
    4 may cause unknown data corruption.
    5 
    6 Also if you are upgrading mySQL to version 4.1 or above, on an existing phpESP 
    7 installation you need to read the UPDATING document in this directory, especially
    8 the UPDATING DATABASE section.
    9 ****** NOTICE ******
   10 
   11 =================
   12 INSTALLING PHPESP
   13 =================
   14 
   15 This document contains instructions for installing phpESP on your
   16 system.
   17 
   18 
   19 OBTAINING PHPESP
   20 ----------------
   21 
   22 phpESP can be obtained from the phpESP web site, at
   23 
   24    http://phpesp.sourceforge.net/
   25 
   26 The most current release version and the most current development
   27 version are listed on the main page.  Older releases are available from
   28 the "Files" section of the Source Forge project page.  All distribution
   29 files can be unpacked using tar+gunzip (see INSTALLING PHPESP, below). 
   30 
   31 Bleeding-edge development versions of phpESP are available via CVS; see
   32 the file docs/HACKING for information on accessing the phpESP CVS
   33 repository.
   34 
   35 
   36 PREREQUISITES
   37 -------------
   38 
   39 The following prerequisites are REQUIRED for phpESP to function
   40 properly.
   41 
   42   1. A web server that supports PHP.
   43 
   44      phpESP is developed under the Apache web server, which we
   45      recommend.  Apache is available from
   46 
   47         http://httpd.apache.org/
   48 
   49      phpESP may work under Microsoft IIS, but is known to have certain
   50      problems.
   51 
   52   2. PHP 4.2.1 or above.
   53 
   54      PHP is the interpreted language in which phpESP is written.  You
   55      can obtain PHP at
   56 
   57         http://www.php.net/
   58 
   59      Follow the instructions in the PHP package to build PHP for your
   60      system.  If you use Apache, be sure to build PHP as a library with
   61      the
   62 
   63          --with-apache
   64      or
   65          --with-apxs
   66 
   67      options to ./configure.
   68 
   69      The following PHP options are REQUIRED by phpESP (listed with
   70      their own prerequisites and configure options).  In many cases,
   71      the required libraries and tools can be obtained as packages from
   72      your operating system vendor.
   73 
   74        a. MySQL support.  (--with-mysql)
   75 
   76           phpESP uses a MySQL database to store survey information,
   77           responses to surveys, and user information.  Information on
   78           obtaining MySQL is available at
   79 
   80             http://www.mysql.com/
   81         
   82           (Future versions may allow the use of any database supported
   83           by the PEAR database abstraction class.)
   84 
   85      The following PHP options are RECOMMENDED to enable advanced
   86      features in phpESP:
   87 
   88        a. Gettext support.  (--with-gettext)
   89 
   90           Gettext is the GNU Translation Project's localization
   91           library.  phpESP uses gettext to provide local translations
   92           of text displayed by the designer interface.  Information on
   93           obtaining the gettext package is available at
   94 
   95              http://www.gnu.org/software/gettext/gettext.html
   96 
   97           (See also note below on configuring translations.)
   98 
   99   3. Additional PEAR Modules
  100 
  101      PEAR is short for "PHP Extension and Application Repository".  The
  102      goal of PEAR is to provide a means of distributing reusable code.
  103 
  104      For more information, see http://pear.php.net/
  105 
  106      At this time, phpESP does not use any PEAR modules.  Future
  107      versions of phpESP will take advantage of PEAR.
  108 
  109 
  110 INSTALLING PHPESP
  111 -----------------
  112 
  113 phpESP is written in PHP, and must be installed in a web-accessible
  114 directory.  The precise location of this directory will differ from
  115 system to system.  If you have no idea where you should be installing
  116 phpESP, install it directly under the root of your web server's
  117 document tree.
  118 
  119 Since phpESP is written in PHP, there is no compilation necessary;
  120 simply expand the distribution where you want it to reside and rename
  121 the root directory of the distribution to whatever you wish to appear
  122 in the URL.  For example, with the Apache web server's default document
  123 root of '/usr/local/apache/htdocs', you would type:
  124 
  125    cd /usr/local/apache/htdocs
  126    tar zxvf /path/to/phpESP-1.6.tar.gz
  127    mv phpESP-1.6 phpESP
  128 
  129 and you would then find phpESP at the URL
  130 
  131    http://your-server/phpESP/
  132 
  133 Now, before you can use this URL, please read the next section about
  134 configuring phpESP.
  135 
  136 CONFIGURING PHPESP
  137 ------------------
  138 
  139 1. Configuring the web server
  140 
  141    phpESP requires the following web server settings.  Examples shown
  142    are for Apache; other web servers' configurations will differ.
  143 
  144    a. PHP interpretation for files matching "*.php"
  145 
  146          AddType application/x-httpd-php .php
  147 
  148    Note: The above instructions may not work if you have specified PHP
  149          as an output filter with SetOutputFilter directive  in Apache
  150          2.x versions.  In particular, RedHat 8.0 Apache 2.x RPMS have
  151          the output filter set, and MUST NOT have the above AddType
  152          directive added.
  153 
  154    b. "index.php" as an index file (brought up when a user requests a
  155       URL for a directory)
  156 
  157          DirectoryIndex index.php
  158 
  159 2. Creating databases
  160 
  161    If you are upgrading an existing version of phpESP please read
  162    "docs/UPDATING" for instructions on updating your database.
  163 
  164    a. Database and User
  165 
  166       The preferred method is that you create the database and user
  167       for phpESP on your own. This can easily be done with a tool
  168       like phpMyAdmin.
  169 
  170       Alternatively, look at the "scripts/db/mysql5.x_create.sql" (or 4.x
  171       if you still have an older mysql) file. This script, when run as
  172       the root user in mysql, will create a database and user for phpESP. 
  173       Be sure to change the default password, "phpesp", to something else
  174       before executing the script! (Remember to use this password when you
  175       configure phpESP in the next step.)
  176 
  177    b. Tables and Data
  178    
  179       Once a database and user have been created for phpESP, go to
  180       the configured url, eg. http://your-server/phpESP/, the creation
  181       of tables and initial data is all web based.
  182       The default user name is "root" and has a password of "esp". You
  183       should login and change this password immediately after you configure
  184       phpESP. This user name and password are for logging into phpESP, do
  185       not confuse them with the database user name and password.
  186 
  187 3. Configuring phpESP
  188 
  189    To configure phpESP, change to the admin/ directory of the installed
  190    distribution, and create "phpESP.ini.php".  Most users will only have
  191    to change a few settings in this file.  The most common changes are
  192    to the 'base_url', and to the database username and password
  193    ('db_user' and 'db_pass'). The defaults for this file can be found
  194    "phpESP.ini.php.default", so copy only the things you need to change.
  195    Also a file "phpESP.ini.php.fixed" exists, containing values you should
  196    never touch.
  197    The sequence is this:
  198 
  199    require (phpESP.ini.php.default);
  200 	 ==> defaults, gets overwritten with every new release
  201    require (phpESP.ini.php);
  202 	 ==> your own values, never gets overwritten
  203    require (phpESP.ini.php.fixed);
  204 	 ==> fixed parts, you can change these, but they get overwritten
  205 	     with every new release
  206 
  207    Note for international users:  phpESP uses GNU gettext to provide
  208    local translations of text displayed by applications; the
  209    translations are found in the locale/ directory.  If a translation
  210    is not yet available for your locale (and you wish to create one),
  211    or if you are having trouble using a provided translation, please
  212    see the "docs/TRANSLATIONS" file for instructions.
  213 
  214 4. Securing phpESP
  215 
  216    a. Passwords
  217 
  218       phpESP's configuration file contains passwords which local users
  219       could use to access your database.  It is recommended to ensure
  220       that at least the phpESP configuration files (admin/phpESP.ini.php*)
  221       are not readable to system users.
  222 
  223       An additional approach is to make phpESP's configuration file
  224       owned by the user 'root' and by a group which only the web server
  225       user belongs to, and then making it readable only to owner and
  226       group.  For example, if your web server runs as www.www, do as
  227       follows:
  228 
  229          chown root.www admin/phpESP.ini.php.fixed
  230          chmod 0440 admin/phpESP.ini.php.fixed
  231          chown root.www admin/phpESP.ini.php.default
  232          chmod 0440 admin/phpESP.ini.php.default
  233          chown root.www admin/phpESP.ini.php
  234          chmod 0440 admin/phpESP.ini.php
  235 
  236    b. Sessions
  237 
  238       Session data -- including hashed versions of your users'
  239       passwords, in some applications -- may not be stored as securely
  240       as necessary.
  241 
  242       If you are using file-based PHP sessions (which are the default),
  243       be sure that session files are not being written into /tmp with
  244       permissions that allow other users to read them.  Ideally, change
  245       the 'session.save_path' setting in php.ini to a directory only
  246       readable and writeable by your web server.
  247 
  248       Additionally, if phpESP is deployed at a hosting service that
  249       uses a server farm you may have problems with sessions.  If all
  250       servers do not share a common 'session.save_path', sessions will
  251       break.  The solution to this problem is to use the php function
  252       session_save_path(), to change the path to a shared location. 
  253       Please make use of one of the support channels (below) if you
  254       encounter this problem.
  255 
  256 
  257 5. Testing phpESP
  258 
  259    Once you have configured your web server, PHP, and phpESP, bring up
  260    the included test page in your Web browser to ensure that all
  261    necessary prerequisites have been met.  If you installed phpESP as
  262    described above, the URL to the test page would be
  263 
  264       http://your-server/phpESP/admin/test.php
  265 
  266    Check that your PHP and PEAR versions are acceptably recent, and
  267    that all required module capabilities are present.  Then note the
  268    "Session counter: 1" line under "PHP Sessions", and reload the page.
  269    The session counter should increment.
  270 
  271 
  272 OBTAINING SUPPORT
  273 -----------------
  274 
  275 If you encounter problems with phpESP, help is available!
  276 
  277 The phpESP Frequently Asked Questions List (FAQ), available on the Web
  278 at
  279 
  280   http://phpesp.sourceforge.net/docs/faq.html
  281 
  282 A few mailing lists are run for phpESP.  Information, archives, and
  283 subscription information can be found at
  284 
  285   http://phpesp.sourceforge.net/
  286 
  287 Finally, phpESP developers, contributors and users also make occasional
  288 appearances on IRC, on the channel #phpesp on freenode.
  289 (irc.freenode.net).
  290 
  291 Please keep in mind that phpESP is free software written by volunteers.
  292 
  293 Thanks for using phpESP!
  294 
  295 The phpESP team
  296 
  297 ----
  298 $Id$
  299 
  300 ------------------------------------------------------------------------
  301 This document was obtained from the Horde project, and modified for
  302 phpESP.  We would like to thank the Horde project for providing such
  303 clean documentation.  You may learn more about the Horde project at
  304   http://www.horde.org/
  305 ------------------------------------------------------------------------