OMERO.web deployment
====================

.. Warning::
    
    OMERO 5.2 is the last major version which will feature Windows
    support for OMERO.web deployment. See
    `this blog post <http://blog.openmicroscopy.org/tech-issues/future-plans/deployment/2016/03/22/windows-support/>`_ for details. If you are deploying a new installation of
    OMERO.web, we highly recommend you use a different OS (see
    :doc:`/sysadmins/version-requirements`).
    
    The guidance below applies to OMERO **5.2**. Code fixes for
    OMERO.web deployment on Windows have not been back-ported to the 5.1 line
    and this guide cannot be used to deploy OMERO.web 5.1.x on Windows.

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 the ability to manage users and groups.


OMERO.web is an integral part of the OMERO platform and can be deployed
with:

-  IIS 6.0 or 7.0 on Microsoft Windows
-  `WSGI <http://wsgi.readthedocs.org/en/latest/>`_ using a WSGI capable web
   server such as `Apache 2.2+ <http://httpd.apache.org>`_ (with
   `mod wsgi <http://modwsgi.readthedocs.org/en/develop/>`_ enabled).
-  The built-in Django lightweight development server (for **testing**
   only; see the :doc:`/developers/Web/Deployment` page)

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.7

   -  `Pillow`_ should be available for your distribution. We currently do not 
       support version 3.0+.

   -  `Matplotlib`_ should be available for your distribution

-  IIS or WSGI capable web server


.. _windows_omero_web_deployment:

Deployment (Windows)
--------------------

See :ref:`customizing_your_omero_web_installation_unix` for additional
customization options.

.. toctree::
    :maxdepth: 1
    :titlesonly:

    install-web/install-iis

If you wish to use Apache or Nginx please follow the Unix instructions

.. toctree::
    :maxdepth: 1
    :titlesonly:

    /sysadmins/unix/install-web/install-apache
    /sysadmins/unix/install-web/install-nginx


Logging in to OMERO.web
-----------------------

Once you have deployed and started the server, you can use your browser
to access 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.web login

   OMERO.web login

.. _windows_omero_web_maintenance:

OMERO.web Maintenance (Windows)
-------------------------------

-  Session cookies :property:`omero.web.session_expire_at_browser_close`:

   -  A boolean that determines whether to expire the session when the user
      closes their browser.
      See :djangodoc:`Django Browser-length sessions vs. persistent
      sessions documentation <topics/http/sessions/#browser-length-vs-persistent-sessions>`
      for more details. Default: ``True``.

      ::

          C:\omero_dist>bin\omero config set omero.web.session_expire_at_browser_close "True"

   -  The age of session cookies, in seconds. Default: ``86400``.

      ::

          C:\omero_dist>bin\omero config set omero.web.session_cookie_age 86400

-  Session engine:

   -  Each session for a logged-in user in OMERO.web is kept in the session 
      store. Stale sessions can cause the store to grow with time. OMERO.web 
      uses by default the OS file system as the session store backend and 
      does not automatically purge stale sessions, see
      :djangodoc:`Django file-based session documentation <topics/http/sessions/#using-file-based-sessions>`
      for more details. It is therefore the responsibility of the OMERO 
      administrator to purge the session cache using the provided management 
      command:

      ::

          C:\omero_dist>bin\omero web clearsessions

      It is recommended to call this command on a regular basis, for example 
      as a daily cron job, see
      :djangodoc:`Django clearing the session store documentation <topics/http/sessions/#clearing-the-session-store>`
      for more information.

      .. note::
          OMERO.web offers alternative session backends to automatically 
          delete stale data using the cache session store backend, see
          :djangodoc:`Django cached session documentation <topics/http/sessions/#using-cached-sessions>`
          for more details. After installing all the cache prerequisites set the following:

          ::

              C:\omero_dist>bin\omero config set omero.web.caches '{"default": { "BACKEND": "django.core.cache.backends.memcached.MemcachedCache", "LOCATION": "127.0.0.1:11211", "TIMEOUT": "86400" } }'
              C:\omero_dist>bin\omero config set omero.web.session_engine django.contrib.sessions.backends.cache


.. _customizing_your_omero_web_installation_windows:

Customizing your OMERO.web installation
---------------------------------------

All configuration options can be found on various sections of
:ref:`web_index` developers documentation. For the full list, refer to
:ref:`web_configuration` properties or:

::

	C:\omero_dist>bin\omero web -h

The most popular configuration options include:

-  Debug mode, see :property:`omero.web.debug`.

-  Customize login page with your own logo, see
   :property:`omero.web.login_logo`.

-  Customizing index page, see :property:`omero.web.index_template`.

-  Enabling a public user see :doc:`/sysadmins/public`.