OMERO.web UI customization
==========================

The OMERO.web offer a flexible user interface that can be customized.
The sections below describe how to set up these features.

Note that depending on the deployment choice, OMERO.web will not activate
configuration changes until Gunicorn is restarted using :command:`omero web
restart`.


Index page
----------

This allows you to add a homepage at <your-omero-server>/index/.
Visitors to your root url at <your-omero-server>/ will get redirected here
instead of redirecting to <your-omero-server>/webclient/.

Create new custom template in
:file:`/your/path/to/templates/mytemplate/index.html` and add the following::

    $ omero config append omero.web.template_dirs '"/your/path/to/templates/"'
    $ omero config set omero.web.index_template 'mytemplate/index.html'

Login page logo
---------------

:property:`omero.web.login_logo` allows you to customize the webclient login
page with your own logo. Logo images should ideally be 150 pixels high or
less and will appear above the OMERO logo. You will need to host the image
somewhere else and link to it with::

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

.. figure:: /images/customLogin.png


Login redirection
-----------------

:property:`omero.web.login_redirect` property redirects to the given location
after logging in to named pages. In the example below, a user who tries to
visit the ``"webindex"`` URL (``/webclient/``) will be redirected after login to a
URL defined by the viewname ``"load_template"``. The ``"args"``
are additional arguments to pass to Django's ``reverse()`` function and the
``"query_string"`` will be added to the URL::

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

Top links menu
--------------

:property:`omero.web.ui.top_links` adds links to the top header::

    $ omero config append omero.web.ui.top_links '["Figure", "figure_index", {"title": "Open Figure in new tab", "target": "_blank"}]'
    $ omero config append omero.web.ui.top_links '["GRE", "http://lifesci.dundee.ac.uk/gre"]'

.. figure:: /images/topLink.png

Open With option
----------------

:property:`omero.web.open_with` adds items to the 'Open with' options.
This allows users to open selected images or other data with another
web app or URL. See :doc:`/developers/Web/LinkingFromWebclient`.

Include template in every page
------------------------------

An HTML template specified by :property:`omero.web.base_include_template` will
be included in every HTML page in OMERO.web.
The template is inserted just before the ``</body>`` tag and can be used for
adding a ``<script>`` such as Google analytics.

For example, create a file called
:file:`/your/path/to/templates/base_include.html` with::

    <script>
        console.log("Hello World");
    </script>

Set the following::

    $ omero config append omero.web.template_dirs '"/your/path/to/templates/"'
    $ omero config set omero.web.base_include_template 'base_include.html'

Group and Users in dropdown menu
--------------------------------

Customize the groups and users dropdown menu by changing the labels or hiding
the entire list::

    $ omero config set omero.client.ui.menu.dropdown.leaders.label "Owners"
    $ omero config set omero.client.ui.menu.dropdown.leaders.enabled true
    $ omero config set omero.client.ui.menu.dropdown.colleagues.label "Members"
    $ omero config set omero.client.ui.menu.dropdown.colleagues.enabled true
    $ omero config set omero.client.ui.menu.dropdown.everyone.label "All Members"
    $ omero config set omero.client.ui.menu.dropdown.everyone.enabled false

.. figure:: /images/dropdownMenu.png


Orphaned container
------------------

:property:`omero.client.ui.tree.orphans.name` allows you to change the name
of the "Orphaned images" container located in the client data manager tree::

    $ omero config set omero.client.ui.tree.orphans.name "Orphaned images"

.. figure:: /images/orphans.png


Disabling scripts
-----------------

:property:`omero.client.scripts_to_ignore` hides the scripts that
the clients should not display::

    $ omero config append omero.client.scripts_to_ignore "/my_scripts/script.py"

.. figure:: /images/disableScripts.png


.. _download_restrictions:

Download restrictions
---------------------

:property:`omero.policy.binary_access` determines whether users can access
binary files from disk. Binary access includes all attempts to download
a file from the UI::

    $ omero config set -- omero.policy.binary_access +read,+write,+image

or on a specific group with ID 15::

    $ omero group info 15
    $ omero obj map-set ExperimenterGroup:15 config -- omero.policy.binary_access +read,+write,+image

.. figure:: /images/downloadRestriction.png