|Use this document to UPGRADE CiviCRM Standalone installations to the latest 3.1 release from versions 2.2.x, 3.0.x or an earlier release of 3.1|
- Installing from scratch? Instructions are here.
|Version 3.1 Requirements|
Before beginning this upgrade, verify that your server meets the requirements for CiviCRM 3.1.
- CiviCRM 2.2.x : You must be running CiviCRM 2.2.x, 3.0.x or an earlier 3.1 release to use this upgrade.
- PHP 5.2.x : Starting with the 1.9 release, CiviCRM will NOT run on PHP 4 servers. CiviCRM 3.1 is also NOT compatible with PHP 5.3. (more info...).
- MySQL 5.0.x or higher : CiviCRM is compatible the current generally available MySQL release.
- Make sure you are logged into the site as a user with administrator level permissions BEFORE you start the upgrade process
Step-by-step Upgrade Procedures
1. Download the CiviCRM Package
2. Backup your CiviCRM database and settings file
Refer to the MySQL reference manual or phpMyAdmin documentation if you need information on backing up your database.
If you have done any changes to civicrm settings file, make sure to take a backup/copy of it.
3. Backup and then delete all previous version code files
CiviCRM will not run properly if previous version files are present after the upgrade. Make sure you have a good backup of your complete previous version installation and then delete previous version of CiviCRM codebase.
These commands will do the trick:
4. Unpack the package and verify permissions
- Unpack the files to the place where previous version of CiviCRM existed.
- Ensure that your CiviCRM/standalone/files directory is writeable by the webserver. You can use the following command to set proper permissions:
- Copy your files and settings back from the old version
[NOTE: (Will Brownsberger, 10-3-2009). The standalone tarball I downloaded today has no files directory within the standalone directory. So mkdir files, then rsync, then chmod to be sure about writeability.]
5. Run the Upgrade script
|MySQL 4.0 and 4.1 are Not Supported|
Support for MySQL versions 4.0 and 4.1 has been discontinued. This means that you may encounter various issues and/or unexpected behavior if you atempt to run CiviCRM under these versions, and the CiviCRM engineering team will not provide support for debugging or resolving these issues. You are strongly encouraged to upgrade to the current generally available release of MySQL.
* Point your web browser to the following URL (you should already be logged in to Standalone with administrator-level permissions):
* You should see the Upgrade screen.
- If you are ready to upgrade, click the 'Upgrade Now' button.
- You should see the message Upgrade successful when the upgrade completes.
- If you receive any errors during the process, please note down the exact error message, and check for solutions on the community support forum.
- Now click the Return to CiviCRM home page link. This will rebuild CiviCRM menus automatically and return you to the CiviCRM home dashboard. You should the message Menu has been rebuilt.
6. Verify and Update Resource URL Settings
- Go to Administer CiviCRM » Global Settings » Resource URLs
- Refer to the field help on that screen for instructions.
7. Enable Components
If you plan on using the new CiviCase component, or any components that you weren't using in the prior version (e.g. CiviPledge or CiviGrant for grant management) - you'll need to enable these component(s):
- Go to Administer CiviCRM » Global Settings » Enable Components
If you have been using Cases in 2.1 or 2.2 and / or want to start using the CiviCase component, you will also need to complete additional configuration steps. Learn more...
8. Restore settings file changes
If you had done any changes to civicrm settings file and took the backup in step2, copy/propagate those changes to the new settings file.
Download and run Database Troubleshooting Tools to test the current state of the database and provides a diagnosis. The tools suite also includes a repair facility.