Switch a live site to a new version of Elgg.
If you’ve written custom plugins, you should also read the developer guides for information on upgrading plugin code for the latest version of Elgg.
- Back up your database and code
- Mind any version-specific comments below
- Version below 2.0 are advised to only upgrade one minor version at a time
- You can upgrade from any minor version to any higher minor version in the same major (2.0 -> 2.1 or 2.0 -> 2.3)
- You can only upgrade the latest minor version in the previous major version to any minor version in the next version (2.3 -> 3.0 or 2.3 -> 3.2, but not 2.2 -> 3.x or 2.3 -> 4.x).
- Try out the new version on a test site before doing an upgrade
- Report any problems in plugins to the plugin authors
- If you are a plugin author you can report any backwards-compatibility issues to GitHub
If you had your Elgg 2.3 project installed using composer, you can follow this sequence:
composer self-update composer global update fxp/composer-asset-plugin cd ./path/to/project/root composer require elgg/elgg:~3.0 composer update vendor/bin/elgg-cli upgrade async
- Log in as an admin to your site
- Disable caching in Advanced Settings
- Back up your database, data directory, and code
- Download the new version of Elgg from http://elgg.org
- Update the files
- If doing a patch upgrade (1.9.x), overwrite your existing files with the new version of Elgg
- If doing a minor upgrade (1.x), replace the existing core files completely
- Merge any new changes to the rewrite rules
- For Apache from
- For Nginx from
install/config/nginx.distinto your server configuration (usually inside
- For Apache from
- Merge any new changes from
- Visit http://your-elgg-site.com/upgrade.php
Any modifications should have been written within plugins, so that they are not lost on overwriting. If this is not the case, take care to maintain your modifications.
From 2.3 to 3.0¶
On your working 2.3 installation:
- Open your
- In the browser, open the site’s Advanced Settings page in the admin area
- Copy the data directory path into your settings file as
- Copy the site URL into your settings file as
Elgg 3.0 will not operate at all without
$CONFIG->dataroot set in
Find the line:
RewriteRule ^(.*)$ index.php?__elgg_uri=$1 [QSA,L]
And replace it with:
RewriteRule ^(.*)$ index.php [QSA,L]
Removed / changed language keys¶
- The language keys related to comment notifications have changed. Check the
New MySQL schema features are not applied¶
New 3.0 installations require MySQL 5.5.3 and use the utf8mb4 character set and LONGTEXT content columns (notably allowing storing longer content and extended characters like emoji).
The settings “Allow visitors to register” and “Restrict pages to logged-in users” now appear on the Basic Settings admin page.
Twitter API plugin¶
twitter_api plugin no longer comes bundled with Elgg.
Unit and Integration Testing¶
Elgg’s PHPUnit bootstrap can now handle both unit and integration tests. Please note that you shouldn’t run tests on a production site, as it may damage data integrity. To prevent data loss, you need to specify database settings via environment variables. You can do so via the phpunit.xml bootstrap.
Plugins can now implement their own PHPUnit tests by extending
plugins test suite will automatically autoload PHPUnit tests from
Prior to running integration tests, you need to enable the plugins that you wish to test alongside core API.
\Elgg\Seeding trait, which can be used to conveniently build new entities and
write them to the database.
\Elgg\UnitTestCase does not use the database, but provides a database mocking interface, which allows tests to
define query specs with predefined returns.
By default, both unit and integration tests will be run whenever
phpunit is called. You can use
--testsuite flag to only run a specific suite:
phpunit --testsuite unit or
phpunit --testsuite integration or
phpunit --testsuite plugins.
For integration testing to run properly, plugins are advised to not put any logic into the root of
start.php, and instead
return a Closure. This allows the testsuite to build a new Application instance without loosing plugin initialization logic.
Plugins with simpletests will continue working as perviously. However, method signatures in the
ElggCoreUnitTest abstract class
have changed and you will need to update your tests accordingly. Namely, it’s discouraged to use
tearDown have been marked as private and are used for consistent test
boostrapping and asserting pre and post conditions, your test case should use
down methods instead.
Simpletests can no longer be executed from the admin interface of the developers plugin.
Use Elgg cli command:
From 2.2 to 2.3¶
PHP 5.5 has reached end of life in July 2016. To ensure that Elgg sites are secure, we now require PHP 5.6 for new installations.
Existing installations can continue using PHP 5.5 until Elgg 3.0.
In order to upgrade Elgg to 2.3 using composer while using PHP 5.5, you may need to use
- PHPUnit bootstrap is deprecated by composer autoloader: Tests should no longer bootstrap themselves using
/engine/tests/phpunit/bootstrap.php. Instead, tests should extend
- PHPUnit bootstrap no longer sets global
$CONFIG. Tests should use
- Core and tests no longer use private global values in
- The database GUID columns need to be aligned. In the admin section an upgrade is available to handle this. Please make sure you have a backup available
From 2.3 to 3.0¶
Be aware the 3.0 upgrade process will remove any remaining “legacy” password hashes. This will affect users who have never logged in under an Elgg 1.10 or later system. These users will be politely asked to reset their password.
From 1.x to 2.0¶
The following plugins are no longer bundled with Elgg core:
IE-specific workarounds have been dropped¶
Several views (
css/ie8, etc.) as well as conditional
comments have been discarded now that IE10+ browsers are more standards-compliant.
If you need browser support farther back than that, you will need to find or build
a plugin that introduces its own compatibility layer or polyfills.
Update your webserver config¶
URL paths like
rewrite.php now use the main front controller
script. You must remove these rewrite rules from your webserver config (e.g.
Also remove the rules for paths like
export/*; these endpoints have been removed.
After upgrading, move your
settings.php file from
From 1.10 to 1.11¶
In versions 1.9 and 1.10, names and values for metadata and annotations were not correctly trimmed for whitespace. Elgg 1.11 correctly trims these strings and updates the database to correct existing strings. If your plugin uses metadata or annotations with leading or trailing whitespace, you will need to update the plugin to trim the names and values. This is especially important if you are using custom SQL clauses or have hard-coded metastring IDs, since the update might change metastring IDs.
From 1.8 to 1.9¶
Elgg 1.9 is a much lighter upgrade than 1.8 was.
Plugins and themes written for 1.8 are expected to be compatible with 1.9 except as it pertains to comments, discussion replies, and notifications. Please report any backwards compatibility issues besides those just listed.
There are several data migrations involved, so it is especially important that you back up your database and data directory before performing the upgrade.
Download the new version and copy these files from the existing 1.8 site:
- any 3rd-party plugin folders in the
Then replace the old installation directory with the new one. This way you are guaranteed to get rid of obsolete files which might cause problems if left behind.
Follow the basic instructions listed above.
After you’ve visited
upgrade.php, go to the admin area of your site.
You should see a notification that you have pending upgrades.
Click the link in the notification bar to view and run the upgrades.
The new notifications system delivers messages via a minutely cron handler. If you haven’t done so yet, you will need to install and configure crontab on your server. If cron jobs are already configured, note that the scope of available cron periods may have changed and you may need to update your current crontab to reflect these changes.
Running all of the listed upgrades took about 1 hour and 15 minutes on the Elgg community site which at the time had to migrate:
- ~75,000 discussion replies
- ~75,000 comments
- ~75,000 data directories
You should take this only as a ballpark estimate for your own upgrade. How long it takes will depend on how large your site is and how powerful your servers are.
From 1.7 to 1.8¶
Elgg 1.8 is the biggest leap forward in the development of Elgg since version 1.0. As such, there is more work to update core and plugins than with previous upgrades.
Delete the following core directories (same level as _graphics and engine):
If you do not delete these directories before an upgrade, you will have problems!