[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.13 2006/01/02 05:36:57 glen Exp $
   2  README - Siteframe Beaumont, Version 5.0.2, Build 768
   3  ===============================================================================
   4  REQUIREMENTS
   5  ===============================================================================
   6  
   7  Required Software
   8  
   9  * PHP5 with mysqli extensions
  10  * MySQL client 4.1.3 / MySQL server 4.1+
  11  * Apache 2.0 (1.3 probable but untested)
  12  * Smarty 2.x PHP templating package (see http://smarty.php.net)
  13  
  14  (Note that this represents the environment under which this software
  15  was developed; it may work with other packages or older versions,
  16  but that cannot be determined at this time.)
  17  
  18  PHP5 extensions
  19  
  20  * The "ext/mysqli" extension is required.
  21  * The "ext/gd" extension is required if you want to use images on your site.
  22  * The "ext/curl" extension is required for outbound Trackback pings.
  23  * The PEAR XML-RPC module is required to use the "ping" plugin.
  24  * The PHP5-exif module is used, if available, to retrieve EXIF information from 
  25    photographs.
  26  
  27  Settings
  28  
  29  * allow_url_fopen - this setting must be On to permit access to RSS feeds
  30  
  31  ===============================================================================
  32  INSTALLATION
  33  ===============================================================================
  34  
  35  1. Copy siteframe.ini-dist to siteframe.ini; edit it to suit your
  36  configuration. You must at least set the following configuration
  37  parameters so that you can connect to your database:
  38  
  39     site_url
  40     site_path
  41     db_host
  42     db_user
  43     db_password
  44     db_database
  45  
  46  2. Upload the files to your web server; make sure that the files/
  47  directory is writable by the web server process.
  48  
  49  3. Point your browser to http://...your-site.../setup.php.
  50  
  51  Once you have completed setup, the setup.php script can be removed,
  52  since it will not run once the database has been installed.
  53  
  54  ===============================================================================
  55  UPGRADING
  56  ===============================================================================
  57  
  58  To upgrade, it's usually simple enough to extract the files from
  59  the distribution archive into your web directory; avoid overwriting
  60  files that you may have modified (such as custom templates).
  61  
  62  If you are upgrading, you should always update your database
  63  definitions in case something has changed. Sign on as an administrator;
  64  go to the Administrator menu (http://yoursite.com/admin.php), and click
  65  on the "Update Database" link. This will ensure that your database
  66  definitions are up-to-date.
  67  
  68  In some cases, additional upgrade steps may be necessary; check the
  69  release notes with each new release to see if something else needs
  70  to be done.
  71  
  72  ===============================================================================
  73  ADDITIONAL STEPS - VERY IMPORTANT!!!
  74  ===============================================================================
  75  
  76  If you are using the Apache webserver, you should copy the file
  77  _htaccess to .htaccess in your web root directory. This file performs
  78  two functions:
  79  
  80  1. It adds security access controls so that sensitive information
  81  cannot be downloaded, such as your database user name and password.
  82  
  83  2. It enables "user-friendly" URLs through mod_rewrite. (To fully
  84  enable this feature, set url_rewriting=On in siteframe.ini.)
  85  
  86  You should copy _htaccess to .htaccess even if you are not using
  87  mod_rewrite for the security reasons outlined above (you may need
  88  to delete the rewrite rules if you do not have mod_rewrite available).
  89  
  90  ===============================================================================
  91  CONTACT INFORMATION
  92  ===============================================================================
  93  
  94  feedback@siteframe.org - to report bugs or for general feedback