modules/UpgradeWizard/SILENTUPGRADE.txt

   1 /*********************************************************************************
   2  * SugarCRM Community Edition is a customer relationship management program developed by
   3  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by the
   7  * Free Software Foundation with the addition of the following permission added
   8  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
   9  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  10  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License along with
  18  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  19  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20  * 02110-1301 USA.
  21  *
  22  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  23  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  30  * these Appropriate Legal Notices must retain the display of the "Powered by
  31  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  32  * technical reasons, the Appropriate Legal Notices must display the words
  33  * "Powered by SugarCRM".
  34  ********************************************************************************/
  35
  36
  37 README.txt for silentupgrade.php
  38 SugarCRM Inc.
  39 Version 6.4.4
  40
  41 What is silentupgrade.php?
  42 ---------------------------
  43
  44 The silentupgrade.php is a stand-alone PHP script that can be run from the command prompt for upgrading a Sugar instance.
  45 SugarCRM comes with built-in Upgrade Wizard as part of the application that you invoke through a browser.  The Silent Upgrader is executed at the
  46 commmand line on the server where the Sugar instance is installed.
  47
  48 Why is silentupgrade.php useful for Upgrades?
  49 ------------------------------------------------------
  50
  51 Sugar upgrades can potentially require resources that are sometimes beyond the Web execution environment settings.
  52 Using the Silent Upgrader enables you to avoid some of the limitations that the Web application environment may have
  53 that prevent the Upgrade Wizard from completing the upgrade.  The upload size limit (by PHP and sometimes even by Web server),
  54 the CGI (or equivalent) timeout limit, and the MySQL (or equivalent) session timeout limit are some of the challenges people run into when upgrading.  The Silent Upgrader either avoids the limitations or better controls the settings in its stand-alone
  55 execution environment.
  56
  57 Note: After upgrading, you will need to rebuild the relationship metadata. To do this, log in as the administrator. On the Administration Home page, select the Repair option in the Systems sub-panel and click Rebuild Relationships
  58
  59 How do you run silentupgrade.php?
  60 ---------------------------------
  61
  62 To execute the silentupgrade.php script, you need to supply the three parameters, as described in the Arguments section below.
  63
  64
  65 Usage: php -f silentUpgrade.php [upgradeZipFile] [logFile] [pathToSugarInstance] [adminUser]
  66
  67 Arguments:
  68
  69     upgradeZipFile      Full path to the upgrade zip file.
  70                         Such as SugarCE-Upgrade-6.3.X-to-6.4.4.zip
  71
  72     logFile             Full path to an alternate log file.
  73
  74     pathToSugarInstance Full path to the instance being upgraded.
  75
  76     adminUser           A valid admin user name
  77
  78 Upgrading the Sugar Database Schema:
  79 -------------------------------------
  80 The Silent Upgrader will automatically replace the current database schema with the 6.4.4 schema.
  81
  82
  83 Compatibility matrix for the Silent Upgrader:
  84 ----------------------------------------------
  85   PHP  versions                         :  5.2,5.3
  86   Databases                             :  MySQL, MSSQL, Oracle, DB2
  87   Operating systems                     :  Windows, Linux, Mac, IBM i
  88   Upgrade from Sugar Instances      :  6.3.x, and 6.4.x
  89
  90 You can also view the compatibility matrix online at:
  91 http://www.sugarcrm.com/crm/products/supported-platforms/6.4.x
  92
  93 Note: The silentUpgrade.php script creates new files for the user who is running it. For example, for
  94 the root user it create files as user/group root. Because Apache cannot read this, you must ensure that
  95 the Web server user has the permissions to read and write the script.