OMERO.web deployment
====================
OMERO.web is the web application component of the OMERO platform which
allows for the management, visualization (in a fully multi-dimensional
image viewer) and annotation of images from a web browser. It also
includes OMERO.webadmin for managing users and groups.
OMERO.web is an integral part of the OMERO platform and can be deployed
with:
- IIS 5.1, 6.0 or 7.0 on Microsoft Windows (since OMERO 4.2.1)
- FastCGI using a FastCGI capable web server such as
`Apache <http://httpd.apache.org/>`_ (with
`mod\_fastcgi <http://www.fastcgi.com/drupal/>`_ enabled),
`nginx <http://nginx.org/>`_ or
`lighttpd <http://www.lighttpd.net/>`_ (since OMERO 4.2.1)
- The built-in Django lightweight development server (for **testing**
only)
You can find more information about FastCGI and where to get modules or
packages for your distribution on the
`FastCGI website <http://www.fastcgi.com/drupal/node/3>`_.
If you need help configuring your firewall rules, see the :doc:`/sysadmins/server-security` page.
Prerequisites
-------------
- OMERO and its prerequisites (see :doc:`server-installation`).
- Python 2 (2.6 or later)
- `Pillow`_ should be available for your distribution
- Matplotlib_ should be available for your distribution
- A FastCGI capable web server
Configuring OMERO from the command line
---------------------------------------
Configuration options can be set using the :omerocmd:`config set` command:
::
C:\omero_dist>bin\omero config set <parameter> <value>
When supplying a value with spaces or multiple elements, use **double
quotes**. The quotes will not be saved as part of the value (see below).
Please use the **escape sequence** ``\"`` for nesting double quotes (e.g.
``"[\"foo\", \"bar\"]"``).
To remove a configuration option (to return to default values where
mentioned), simply omit the value:
::
C:\omero_dist>bin\omero config set <parameter>
These options will be stored in a file: ``etc/grid/config.xml`` which
you can read for reference. **DO NOT** edit this file directly.
You can also review all your settings by using:
::
C:\omero_dist>bin\omero config get
which should return values without quotation marks.
A final useful option of :omerocmd:`config edit` is:
::
C:\omero_dist>bin\omero config edit
which will allow for editing the configuration in a system-default text
editor.
Quick start
-----------
Using IIS
~~~~~~~~~
Once you have IIS installed on your system, a straightforward set of
steps is required to get the `ISAPI
WSGI <http://code.google.com/p/isapi-wsgi/>`_ handler for OMERO.web
working with your IIS deployment.
- Choose between FastCGI TCP (recommended) or FastCGI (advanced):
::
C:\omero_dist>bin\omero config set omero.web.application_server "fastcgi" / "fastcgi-tcp"
- Ensure that the ISAPI for IIS options are installed
- Download and install `an ISAPI
WSGI Installer <http://code.google.com/p/isapi-wsgi/downloads/list>`_ (we
suggest the *Windows Installer*)
- For extended compatibility with multiple IIS versions ISAPI WSGI uses
the IIS 5/6 WMI interface to interact with your IIS deployment. If
you are using IIS 7 you must enable the IIS 6 WMI backwards
compatibility options, as shown on the figure:
.. figure:: /images/installation-images/IIS7Requirements.png
:align: center
:width: 35%
:alt: IIS 7 configuration options
IIS 7 configuration options
- OMERO.web and ISAPI WSGI are **32-bit** applications on Windows at
present. If you are attempting to run OMERO.web on a 64-bit version
of Windows, you must enable 32-bit compatibility in the *Advanced
Settings...* for the *Application Pool* assigned to your default
*Site*. You can do this in the *IIS Manager* as follows:
.. figure:: /images/installation-images/IIS7ApplicationPool.png
:align: center
:width: 35%
:alt: IIS 7 Application Pool Advanced Settings
IIS 7 Application Pool Advanced Settings
- Configure OMERO.web bindings for IIS
::
C:\omero_dist>bin\omero config set omero.web.session_engine "django.contrib.sessions.backends.cache"
C:\omero_dist>bin\omero config set omero.web.cache_backend "file://C:/windows/temp/"
C:\omero_dist>bin\omero web iis
Using the lightweight development server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All that is required to use the Django lightweight development server
is to set the *omero.web.application\_server* configuration option, turn
Debugging on and start the server up:
::
C:\omero_dist>bin\omero config set omero.web.application_server development
C:\omero_dist>bin\omero config set omero.web.debug True
C:\omero_dist>bin\omero web start
Copying 'C:\omero_dist\lib\python\omeroweb\feedback\static\feedback\css\layout.css'
.....
Copying 'C:\omero_dist\lib\python\omeroweb\webstart\static\webstart\img\icon-omero-web.png'
735 static files copied to 'C:\omero_dist\lib\python\omeroweb\webstart\static'.
Starting OMERO.web... Validating models...
0 errors found
Django version 1.3.1, using settings 'omeroweb.settings'
Development server is running at http://0.0.0.0:4080/
Quit the server with CONTROL-C.
Logging in to OMERO.web
-----------------------
Once you have deployed and started the server, you can use your browser
to access OMERO.webadmin or the OMERO.webclient:
- **http://your\_host/omero** OR, for development server:
**http://localhost:4080**
.. figure:: /images/installation-images/login.png
:align: center
:width: 55%
:alt: OMERO.webadmin login
OMERO.webadmin login
.. note::
This starts the server in the foreground. It is your
responsibility to place it in the background, if required, and
manage its shutdown.
Customizing your OMERO.web installation
---------------------------------------
.. note::
Please use double quotes instead of single quotes and a
proper escape sequence to specify options with multiple
values.
.. note::
For clarity, some edge-case/in-development options may not
be documented below. For the full list see:
::
C:\omero_dist>bin\omero web -h
OR look in lib/python/omeroweb/settings.py
- A list of servers the Web client can connect to. Default:
``[["localhost", 4064, "omero"]]``.
::
C:\omero_dist>bin\omero config set omero.web.server_list "[[\"prod.example.com\", 4064, \"prod\"], [\"dev.example.com\", 4064, \"dev\"]]"
- Email server and notification:
- (**REQUIRED**) From : address to be used when sending e-mail.
Default: ``root@localhost``
::
C:\omero_dist>bin\omero config set omero.web.server_email "webmaster@example.com"
- (**REQUIRED**) Mail server hostname. Default: ``localhost``.
::
C:\omero_dist>bin\omero config set omero.web.email_host "email.example.com"
- Mail server login username. Default: '' (Empty string).
::
C:\omero_dist>bin\omero config set omero.web.email_host_user "username"
- Mail server login password. Default: '' (Empty string).
::
C:\omero_dist>bin\omero config set omero.web.email_host_password "password"
- Mail server port. Default: ``25``.
::
C:\omero_dist>bin\omero config set omero.web.email_host_port "2255"
- Use TLS when sending e-mail. Default: ``False``.
::
C:\omero_dist>bin\omero config set omero.web.email_use_tls "True"
- Subject prefix for outgoing e-mail. Default: ``"[Django] "``.
::
C:\omero_dist>bin\omero config set omero.web.email_subject_prefix "Subject prefix for outgoing e-mail"
- Controlling displayed scripts:
- Since OMERO 4.3.2, OMERO.web has the ability to dynamically
display scripts in the script runner menu just like OMERO.insight.
Some scripts were not suitable for display initially and are
excluded from the menu. You may wish to control which scripts your
users can see in OMERO.web using this configuration option.
Default:
``'["\omero\figure_scripts\Movie_Figure.py", "\omero\figure_scripts\Split_View_Figure.py", "\omero\figure_scripts\Thumbnail_Figure.py", "\omero\figure_scripts\ROI_Split_Figure.py", "\omero\export_scripts\Make_Movie.py"]'``
::
C:\omero_dist>bin\omero config set omero.web.scripts_to_ignore '[]'
C:\omero_dist>bin\omero config set omero.web.scripts_to_ignore '["\omero\my_scripts\really_buggy.py", … ]'
.. _install_web_public_user:
- Enabling a public user:
- Since OMERO 4.4.0, OMERO.web has the ability to automatically log
in a public user.
- First, create a public user. You can use any username and
password you wish. If you do not want this user to be able to
modify any of the data they see, you should put this user in a
Read-Only group and the public data should be owned by another
member(s) of this group. Now you can configure the public user:
- Enable and disable the OMERO.web public user functionality.
Default: ``False``.
::
C:\omero_dist>bin\omero config set omero.web.public.enabled True
- Set a URL filter for which the OMERO.web public user is allowed
to navigate. Default: ``^/(?!webadmin)`` (`Python regular
expression <http://docs.python.org/2/library/re.html>`_). You
probably do not want the whole webclient UI to be publicly
visible (although you could do this). The idea is that you can
create the public pages yourself (see :doc:`/developers/Web`
since we do not provide public pages. E.g. to allow only URLs
that start with '/my\_web\_public' you would use:
::
C:\omero_dist>bin\omero config set omero.web.public.url_filter '^/my_web_public'
C:\omero_dist>bin\omero config set omero.web.public.url_filter'^/(my_web_public|webgateway)' # OR webgateway
Exotic matching techniques can be used but more explicit regular
expressions are needed when attempting to filter based on a base
URL:
::
'webtest' matches '/webtest' but also '/webclient/webtest'
'dataset' matches '/webtest/dataset' and also '/webclient/dataset'
'/webtest' matches '/webtest…' but also '/webclient/webtest'
'^/webtest' matches '/webtest…' but not '/webclient/webtest'
- Server to authenticate against. Default: ``1`` (the first
server in ``omero.web.server_list``)
::
C:\omero_dist>bin\omero config set omero.web.public.server_id 2
- Username to use during authentication. Default: ``Not set.``
(required if ``omero.web.public.enabled=True``):
::
C:\omero_dist>bin\omero config set omero.web.public.user '__public__'
- Password to use during authentication. Default: ``Not set.``
(required if ``omero.web.public.enabled=True``):
::
C:\omero_dist>bin\omero config set omero.web.public.password 'secret'
- Administrator e-mail notification:
- Admins list of people who get code error notifications. When debug
mode is off and a view raises an exception, Django will e-mail
these people with the full exception information. Default: ``[]``
(Empty list).
::
C:\omero_dist>bin\omero config set omero.web.admins '[["Dave", "dave@example.com"], ["Bob", "bob@example.com"]]'
- Ping interval:
- Since OMERO 4.4.0, OMERO.web now pings the server to keep your
session alive when you are logged in and have an active browser
window. The duration between these pings can be configured.
Default: ``60000.`` (every 60 seconds)
::
C:\omero_dist>bin\omero config set omero.web.ping_interval 12000
- Debug mode:
- A boolean that turns on/off debug mode. Default: ``False``.
::
C:\omero_dist>bin\omero config set omero.web.debug "True"
- Configuring additional web apps:
- The OMERO.web framework allows you to add additional Django apps.
For an example with installation instructions, see
`webmobile <https://github.com/will-moore/webmobile/>`_
- Download or clone from the git repository into the /omeroweb/
directory, then run
::
C:\omero_dist>bin\omero config set omero.web.apps '["<app name>"]'