tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity
5507ce89c6
silverstripe-framework/docs/en/03_Upgrading/index.md
Cam Findlay 0fa8335bc0 DOCS Upgrading information about 3.2.0 and the additional modules required (reports & siteconfig) 
Based on a community question about upgrading their site manually, they followed the instructions but were not aware of the additional modules now required.
2015-10-22 09:13:57 +13:00

3.2 KiB
Raw Blame History

title: Upgrading introduction: Keep your SilverStripe installations up to date with the latest fixes, security patches and new features.

Upgrading to SilverStripe 3.2

SilverStripe applications should be kept up to date with the latest security releases. Usually an update or upgrade to your SilverStripe installation means overwriting files, flushing the cache and updating your database-schema.

See our [upgrade notes and changelogs](/changelogs/3.2.0) for 3.2.0 specific information, bugfixes and API changes.

Composer

For projects managed through Composer, update the version number of framework and cms to ^3.2 in your composer.json file and run composer update.

	"require": {
		"silverstripe/framework": "^3.2",
		"silverstripe/cms": "^3.2"
	}

This will also add extra dependencies, the reports and siteconfig modules. SilverStripe CMS is becoming more modular, and composer is becoming the preferred way to manage your code.

Manual

  • Check if any modules (e.g. blog or forum) in your installation are incompatible and need to be upgraded as well
  • Backup your database content
  • Backup your webroot files
  • Download the new release and uncompress it to a temporary folder
  • Leave custom folders like mysite or themes in place.
  • Identify system folders in your webroot (cms, framework and any additional modules).
  • Delete existing system folders (or move them outside of your webroot)
  • Extract and replace system folders from your download (Deleting instead of "copying over" existing folders ensures that files removed from the new SilverStripe release are not persisting in your installation).
  • As of SilverStripe CMS 3.2.0 you will also need to include the reports and siteconfig modules to ensure feature parity with previous versions of the CMS.
  • Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website database.
  • Check if you need to adapt your code to changed PHP APIs
  • Check if you have overwritten any core templates or styles which might need an update.
Never update a website on the live server without trying it on a development copy first.

Decision Helpers

How easy will it be to update my project? It's a fair question, and sometimes a difficult one to answer.

  • "Micro" releases (x.y.z) are explicitly backwards compatible, "minor" and "major" releases can deprecate features and change APIs (see our /misc/release-process for details)
  • If you've made custom branches of SilverStripe core, or any thirdparty module, it's going to be harder to upgrade.
  • The more custom features you have, the harder it will be to upgrade. You will have to re-test all of those features, and adapt to API changes in core.
  • Customizations of a well defined type - such as custom page types or custom blog widgets - are going to be easier to upgrade than customisations that modify deep system internals like rewriting SQL queries.

Related