...
Warning | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
It is not always possible to upgrade multiple versions in one step. When this is not the case, if you attempt to skip a critical release you will see this message when trying to update the database schema:
You must download and upgrade successfully to the specified version. This is the list of versions that block upgrading:
|
Info | ||
---|---|---|
| ||
You should review the general installation instructions to check for any changes to minimum version (eg: minimum PHP version) and other requirements. |
Backup Your Database
While upgrading is usually a fairly straightforward process, from time to time fairly significant database changes are made. Efforts are made to make these changes transparent, but as a precaution you should create a backup of your database prior to upgrading in case you need to revert the upgrade.
Download New Source
Checkout the source as described in Registry Installation - Source.
...
For versions after v1.0.0, copy your local
directory from your previous installation, or symlink to it.
- When upgrading to or past v2.0.0, before continuing you may need to create symlinks to Plugins you were previously using. For more details, see Upgrading Registry to v2.0.0.
For versions prior to v1.0.0, depending on how you set things up previously you will likely need to:
- Update
app/tmp
to point to your production tmp directory. - Re-install your authentication configuration. (eg: On Apache, copy
app/webroot/auth/login/.htaccess
andapp/webroot/auth/logout/.htaccess
. - Re-install your database configuration. (
app/Config/database.php
) - If you updated
app/Config/email.php
, re-install that file as well. - Copy
app/Config/security.salt
andapp/Config/security.seed
. - Update your
registry-source
link to point to the new directory. - Re-install your Shibboleth Embedded Discovery Service Plugin configuration, if in use.
Clear Caches
...
When running the console steps under v0.9.4, you may notice deprecation messages like
Deprecated (16384): Validation::notEmpty() is deprecated.
Regardless of version, update your registry-current
link to point to the new directory.
Clear Caches
...
Various caches are maintained to improve performance, but can cause problems during upgrades. Clear existing caches prior to continuing.
Note |
---|
In order to avoid problems with file ownership, you should run console commands as the web server user. Otherwise, make make sure the cache directory (wherever |
Version 1.0.6 and Later
Use the clearcache
command.
No Format |
---|
$ cd app
$ su -c "./Console/clearcache" ${APACHE_USER}
Done clearing caches |
Version 1.0.5 and Earlier
Info |
---|
When running the console steps under v0.9.4, you may notice deprecation messages like Deprecated (16384): Validation::notEmpty() is deprecated. These messages may be safely ignored, and will be addressed in a future release ( |
No Format |
---|
$ cd app $ su -c "./Console/cake cache" ${APACHE_USER} [...] Done clearing cache |
Warning |
---|
If you do not see the "Done cleaning cache" message (without any errors) then the caches have not been cleared. If you do not have write permission to the cache directories, this command may fail without producing any output. If necessary, clear the caches manually, as described below. |
Note | ||
---|---|---|
Sometimes the cache clearing fails due to "internal error", which is usually Cake being confused by cached models not matching the new code. In this case you will need to manually clear the cache. Remove the cache files, but leave the directory structure in place. Something like
|
Update Database Schema
Generally, updating the database schema is required when upgrading COmanage Registry. You may need to run this command as a user that has permission to write to your tmp directory.
...
Note | |||||
---|---|---|---|---|---|
If you see an error like the following when upgrading, it may indicate the caches were not properly cleared:. Try clearing the caches again (manually emptying the
registry/cache directory if necessary), then try running upgradeVersion again.or
|
Info | ||
---|---|---|
| ||
When upgrading the database schema, you may see " |
...
The following list of tables can be dropped as of the listed version:
Once you upgrade to this version | You should drop these tables (if present) |
---|---|
Registry 0.8.2 |
|
Registry 2.0.0 | cm_organizations |
Registry 3.3.0 |
|
Registry 4.1.0 | cm_password_reset_tokens |
Version Specific Database Updates
Run the appropriate steps for the versions you are upgrading past AND to. For example, if you are upgrading from v0.8.2 to v0.9, you must run the upgrade steps for both v0.8.3 and v0.9.
...