OMERO.web installation and maintenance

OMERO.web is a Python 3 client of the OMERO platform that provides a web-based UI and JSON API. This section provides links to detailed step-by-step walkthroughs describing how to install, customize, maintain and run OMERO.web for several systems. OMERO.web is installed separately from the OMERO.server.

OMERO.web can be deployed with:

WSGI using a WSGI capable web server such as NGINX and Gunicorn
the built-in Django lightweight development server. This type of deployment should only be used for testing purpose only; see the OMERO.web installation for developers page.

If you need help configuring your firewall rules, see Server security and firewalls for more details.

Depending upon which platform you are using, you may find a more specific walkthrough listed below. The guides use the example of deploying OMERO.web with NGINX and Gunicorn. OMERO can automatically generate a configuration file for your webserver. The location of the file will depend on your system, please refer to your webserver’s manual. See in the section Customizing your OMERO.web installation in the various walkthroughs for more options.

Configuration

You will find in the various guides how to create the NGINX OMERO configuration file and the configuration steps for the NGINX and Gunicorn. Advanced Gunicorn setups are also described to enable the download of binary data and to handle multiple clients on a single worker thread switching context as necessary while streaming binary data from OMERO.server. Depending on the traffic and scale of the repository you should configure connections and speed limits on your server to avoid blocking resources.

Walkthroughs

Recommended:

OMERO.web installation on Rocky Linux 9 and IcePy 3.6: Instructions for installing OMERO.web from scratch on RHEL 9/Rocky Linux 9 with Ice 3.6.
OMERO.web installation on Ubuntu 22.04 and IcePy 3.6: Instructions for installing OMERO.web from scratch on Ubuntu 22.04 with Ice 3.6.

Supported:

OMERO.web installation on Ubuntu 20.04 and IcePy 3.6: Instructions for installing OMERO.web from scratch on Ubuntu 20.04 with Ice 3.6.

Note

Support for Apache deployment has been dropped in 5.3.0.

If your organization’s policies only allow Apache to be used as the external-facing web-server you should configure Apache to proxy connections to an NGINX instance running on your OMERO server i.e. use Apache as a reverse proxy. For more details see Apache mod_proxy documentation.