OMERO.web upgrade¶
The OME team is committed to providing frequent, project-wide upgrades with security fixes, bug fixes and new functionality. We try to make the schedule for these releases as public as possible. You may want to take a look at the Trello boards for exactly what will go into a release. See also OMERO.server upgrade.
See the full details of OMERO features in the CHANGELOGS.
This guide aims to be as definitive as possible so please do not be put off by the level of detail; upgrading should be a straightforward process.
Upgrade checklist¶
Check prerequisites¶
Before starting the upgrade, please ensure that you have reviewed and satisfied all the system requirements with correct versions for installation.
Upgrade¶
Make sure you have activated the correct virtual environment then upgrade OMERO.web via pip:
$ pip install --upgrade 'omero-web>=5.14.0'
If the `omero-web` upgrade requires an upgrade to `omero-py` (e.g.
for new features), this will happen automatically above.
However, even when an `omero-py` upgrade is not required, there may be some
benefits to upgrading:
$ pip install --upgrade 'omero-py>=5.11.1'
Configuration¶
We now recommend that omero-web is installed in a separate python
virtual environment.
If you are migrating to a new virtual environment, where $OMERODIR
does not refer to a server with an existing config, you will
need to export and re-import the configuration from your previous installation.
OLD_INSTALLATION/bin/omero config get --show-password > properties.backup
# omero-web virtual env
omero config load properties.backup
If you generated configuration stanzas using omero web config which enables OMERO.web via NGINX, you should regenerate your config files, remembering to merge in any of your own modifications if necessary. You should carry out this step even for minor version upgrades as there may be fixes which require it.
omero web config nginx > new.confg
More examples can be found under Configuration.
Plugin updates¶
OMERO.web plugins are very closely integrated into the webclient. For this reason, it is possible that an update of OMERO will cause issues with an older version of a plugin. It is best when updating the server to also install any available plugin updates according to their own documentation.
All official OMERO.web plugins can be installed from PyPI. You should remove all previously installed plugins and install the latest versions using pip.
Troubleshooting¶
If you encounter errors during an OMERO.web upgrade, etc., you should retain as much log information as possible, including the output of omero web diagnostics to the OMERO team via the mailing lists available on the support page.
Maintenance & Scaling¶
If you have not already done so, there are a number of additional steps that can be performed on your OMERO.web installation to improve its functioning. For example, you may need to set up a regular task to clear out any stale OMERO.web session files. More information can be found in the various walkthroughs available from OMERO.web installation and maintenance.
Additionally, it is recommended to use a WSGI-capable server such as NGINX. Information can be found under OMERO.web installation and maintenance.
