menu

Upgrade Instructions 5.1 → 5.2

Support the documentation

This documentation was written by volunteers. Please help support our effort:

Help us improve the documentation

Upgrade Instructions 5.1 → 5.2

By using composer, you can update an existing installation to a specific version, without having to create a new project.

For further information on what changed please take a look at the changelogs (Neos, Flow)

Update Instructions

Before doing substantial changes, make sure you create a backup of the database and files!

cd /installation-root/
# Update the core package dependencies
composer require --no-update "neos/neos:~5.2.0"
composer require --no-update "neos/neos-ui:~5.2.0"

# Update optional package dependencies (if installed)
composer require --no-update "neos/demo:~6.2.0"
composer require --no-update "neos/nodetypes:~5.2.0"
composer require --no-update "neos/site-kickstarter:~5.2.0"

If you require neos/neos-ui-compiled in your composer.json, please remove the dependency since it's not required anymore.

If you have development packages in your composer manifest, update them to match as well:

# Update development packages (if installed)
composer require --no-update --dev "neos/buildessentials:6.2.x-dev"

Breaking changes

With this minor release, no breaking changes where introduced. Its most likely that your project can safely upgrade. Still there are few changes to adapt to optionally to already help with future changes:

Icons and description for asset sources

To make your AssetSources compatible with the future Neos 6.0 add the methods

* public function getIcon(): string
* public function getDescription(): string

to your asset source.

Finish the update

# Update the packages
composer update

# Flush the caches
./flow flow:cache:flush --force
./flow flow:session:destroyAll

# Run code migrations (as needed for any packages that need to be migrated)
./flow flow:core:migrate <Vendor.PackageName>

# If not already on 4.0 or 4.1, set database charset and update to the new default given character set and collation
./flow database:setcharset

# Run database migrations
./flow doctrine:migrate

# Publish resources
./flow resource:publish

Troubleshooting

If you run into trouble with Neos content or resources, the following may help: 

# If you get error messages when running Flow CLI commands:
rm -rf Data/Temporary

# If you experience issues with pages not working, try 
./flow node:repair

# If you experience issues with resources, thumbnail or assets, try
./flow resource:clean
./flow media:clearthumbnails