Customizing OMERO.web

OME Paris 2014

Aleksandra Tarkowska | Will Moore | Simon Li | Douglas Russell

Customizing OMERO.web

  • Configure web settings
  • Use as a webservice
  • Extend with your own apps

Configure web settings

See web install docs for Unix | Windows


$ bin/omero web -h

Login screen

$ bin/omero config set omero.web.login_logo 'http://www.url/to/image.png'

New in OMERO 5.0.2

Index page

$ bin/omero config set omero.web.index_template 'mytemplate/test.html'
$ bin/omero config set omero.web.template_dirs '/your/path/to/templates/'

Login redirection

$ bin/omero config set omero.web.login_redirect 
        '{"redirect": ["webindex"], "viewname": "webindex_custom"}'
$ bin/omero config set omero.web.login_redirect 
                '{"redirect": ["webindex"], "viewname": "load_template", 
                "args":["userdata"], "query_string": "experimenter=-1"}'

Top links menu

$ bin/omero config set omero.web.ui.top_links 
                '[["Figure", "webfigure"]]'
$ bin/omero config set omero.web.ui.top_links 
                '[["GRE", ""]]'

Group and Users in dropdown menu

$ bin/omero config set 
        '{"LEADERS": "Owners", "COLLEAGUES": "Members", "ALL": "All members"}'

Public User

  • Public visitors are logged-in as a specified 'public user'
  • Visitors are able to access data available to public user
  • Functionality exposed can be controlled by url filters
  • See Public Data Documentation
$ bin/omero config set omero.web.public.enabled True
$ bin/omero config set omero.web.public.server_id 1
$ bin/omero config set omero.web.public.user '<username>'
$ bin/omero config set omero.web.public.password '*****'
$ bin/omero config set omero.web.public.url_filter
$ bin/omero config set omero.web.public.url_filter '/webgateway'

Public Repository Examples

OMERO.web as webservice

See WebGateway documentation

JSON methods

    url: "",
    jsonp: 'callback',
    success: function(data) { // },

Rendering images

Embedding live image

advanced example

Extending OMERO.web

See OMERO.web developer docs

Create an OMERO.web app

  • OMERO.web uses the Django framework to support apps
  • Apps can be installed onto existing OMERO.web deployments
  • Apps can use or extend existing page templates or code
    E.g. webclient uses webgateway image viewer
  • See Creating an app documentation

App examples

$ bin/omero config append omero.web.apps '"figure"'


  • OMERO.figure app for creating figures
  • Uses webgateway for json data & image rendering
  • Uses webclient for login screen & export scripts

Webclient plugins

Webclient plugins

  • webtest examples included in OMERO.web:

$ bin/omero config append omero.web.ui.right_plugins
        '["ROIs", "webtest/webclient_plugins/right_plugin.rois.js.html", "image_roi_tab"]'


  • Uses 'right panel' plugin to search with selected images
  • See: More Info | Code on Github
  • Simon Li & Ivan Cao-Berg


Any Questions?


  • Virtual Microscope
  • OMERO.figure

Virtual Microscope
next step in learning


  • Efficient and effective ways to teach subject specialties
  • Open access to explore and examine the sections at different levels of magnification
  • Helping develop classification and identification skills without the need for high-cost microscopes and thin section preparation facilities
  • Open source project