Mambo API

[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  * Install instructions
   4  * @package Mambo
   5  * @author Mambo Foundation Inc see README.php
   6  * @copyright (C) 2000 - 2009 Mambo Foundation Inc.
   7  * See COPYRIGHT.php for copyright notices and details.
   8  * @license GNU/GPL Version 2, see LICENSE.php
   9  *
  10  * Redistributions of files must retain the above copyright notice.
  11  *
  12  * Mambo is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; version 2 of the License.
  15  */
  16  
  17  // no direct access
  18  defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );
  19  ?>
  20  
  21  REQUIREMENTS
  22  ------------
  23  
  24  First you must have the base environment for Mambo.
  25  We have thoroughly tested Mambo on: Linux, Free BSD, Mac OS X and Windows NT/2000.
  26  Linux or one of the BSD's are recommended, but anything else that can run the
  27  3 pieces of software listed below should do it.
  28  
  29  Apache    -> http://www.apache.org
  30  MySQL    -> http://www.mysql.com
  31  PHP    -> http://www.php.net
  32  
  33  
  34  SERVER CONFIGURATION
  35  --------------------
  36  
  37  You MUST ensure that PHP has been compiled with support for MySQL and Zlib
  38  in order to successfully run Mambo.
  39  
  40  While we have reports that Mambo works on IIS server we recommend Apache
  41  for running Mambo on Windows.
  42  
  43  
  44  OPTIONAL COMPONENTS
  45  -------------------
  46  
  47  If you want support for SEF (Search Engine Friendly) URLs, you'll need mod_rewrite and the ability to
  48  use local .htaccess files.
  49  
  50  
  51  INSTALLATION
  52  ------------
  53  
  54  1. DOWNLOAD Mambo
  55  
  56      You can obtain the latest Mambo release from:
  57          http://source.mambo-foundation.org/Remository/Download/Mambo_Core_Files/.
  58  
  59      Copy the tar.gz file into a working directory e.g.
  60  
  61      $ cp MamboVx.x.x-Stable.tar.gz /tmp/Mambo
  62  
  63      Change to the working directory e.g.
  64  
  65      $ cd /tmp/Mambo
  66  
  67      Extract the files e.g.
  68  
  69      $ tar -zxvf MamboVx.x.x-Stable.tar.gz
  70  
  71      This will extract all Mambo files and directories.  Move the contents
  72      of that directory into a directory within your web server's document
  73      root or your public HTML directory e.g.
  74  
  75      $ mv /tmp/Mambo/* /var/www/html
  76  
  77      Alternatively if you downloaded the file to your computer and unpacked
  78      it locally use a FTP program to upload all files to your server.
  79      Make sure all PHP, HTML, CSS and JS files are sent in ASCII mode and
  80      image files (GIF, JPG, PNG) in BINARY mode.
  81  
  82  
  83  2. CREATE THE Mambo DATABASE
  84  
  85      Mambo will currently only work with MySQL.  In the following examples,
  86      "db_user" is an example MySQL user which has the CREATE and GRANT
  87      privileges.  You will need to use the appropriate user name for your
  88      system.
  89  
  90      First, you must create a new database for your Mambo site e.g.
  91  
  92      $ mysqladmin -u db_user -p create Mambo
  93  
  94      MySQL will prompt for the 'db_user' database password and then create
  95      the initial database files.  Next you must login and set the access
  96      database rights e.g.
  97  
  98      $ mysql -u db_user -p
  99  
 100      Again, you will be asked for the 'db_user' database password.  At the
 101      MySQL prompt, enter following command:
 102  
 103      GRANT ALL PRIVILEGES ON Mambo.*
 104          TO nobody@localhost IDENTIFIED BY 'password';
 105  
 106      where:
 107  
 108      'Mambo' is the name of your database
 109      'nobody@localhost' is the userid of your webserver MySQL account
 110      'password' is the password required to log in as the MySQL user
 111  
 112      If successful, MySQL will reply with
 113  
 114      Query OK, 0 rows affected
 115  
 116      to activate the new permissions you must enter the command
 117  
 118      flush privileges;
 119  
 120      and then enter '\q' to exit MySQL.
 121  
 122      Alternatively you can use your web control panel or phpMyAdmin to
 123      create a database for Mambo.
 124  
 125  
 126  3. WEB INSTALLER
 127  
 128  Finally point your web browser to http://www.mysite.com where the Mambo web
 129  based installer will guide you through the rest of the installation.
 130  
 131  
 132  4. CONFIGURE Mambo
 133  
 134  You can now launch your browser and point it to your Mambo site e.g.
 135  
 136     http://www.mysite.com -> Main Site
 137     http://www.mysite.com/administrator -> Admin
 138  
 139  You can log into Admin using the username 'admin' along with the
 140  password that was generated or you chose during the web based install.
 141  
 142  
 143  MAMBO ADMINISTRATION
 144  ---------------------
 145  
 146  Upon a new installation, your Mambo website defaults to a very basic
 147  configuration with only a few active components, modules and templates
 148  (CMTs).
 149  
 150  Use Admin to install and configure additional CMTs, add users, select
 151  default language and much more.
 152  
 153  Note that additional community-contributed CMTs and languages are
 154  announced on the forums at http://forum.mambo-foundation.org.