Note

This documentation is for OMERO 5.2. This version is now in maintenance mode and will only be updated in the event of critical bugs or security concerns. OMERO 5.3 is expected in the first quarter of 2017.

OMERO.web deployment for developers

Getting set up

You will need to have an OMERO server running that you can connect to. This will typically be on your own machine, although you can also connect to an external OMERO server. You can add the server to the omero.web.server_list and choose that server when you log in. You should enable omero.web.debug and start a lightweight development Web server on your local machine.

Note

Since OMERO 5.2, the OMERO.web framework no longer bundles a copy of the Django package, instead manual installation of the Django dependency is required. It is highly recommended to use Django 1.8 (LTS) which requires Python 2.7. For more information see Python on the Version requirements page.

Using the lightweight development server on Unix

All that is required to use the Django lightweight development server is to set the omero.web.application_server configuration option, turn omero.web.debug on and start the server up:

$ bin/omero config set omero.web.application_server development
$ bin/omero config set omero.web.debug True
$ bin/omero web start
INFO:__main__:Application Starting...
INFO:root:Processing custom settings for module omeroweb.settings
...
Validating models...

0 errors found
Django version 1.8, using settings 'omeroweb.settings'
Starting development server at http://127.0.0.1:4080/
Quit the server with CONTROL-C.

Using the lightweight development server on Windows

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
INFO:__main__:Application Starting...
INFO:root:Processing custom settings for module omeroweb.settings
...
Validating models...

0 errors found
Django version 1.8, using settings 'omeroweb.settings'
Starting development server at http://127.0.0.1:4080/
Quit the server with CTRL-BREAK.

Using WSGI (Unix/Linux)

For convenience you may wish to run a web server under your local user account instead of using a system server for testing. Install Nginx and Gunicorn (See OMERO.web deployment) but generate a configuration file using the following commands:

$ bin/omero config set omero.web.application_server 'wsgi-tcp'
$ bin/omero web config nginx-development > nginx-development.conf

Start Nginx and the Gunicorn worker processes running one thread listening on 127.0.0.1:4080 that will autoreload on source change:

$ nginx -c $PWD/nginx-development.conf
$ bin/omero config set omero.web.application_server.max_requests 1
$ bin/omero config set omero.web.wsgi_args -- "--reload"
$ bin/omero web start

Next: Get started by Creating an app....