Installs and configures OMERO.web and Nginx. Uses a conf.d style configuration directory for managing the OMERO.web configuration.
All variables are optional, see defaults/main.yml
for the full list
OMERO.web version and installation.
omero_web_release
: The version of OMERO.web to install, defaultlatest
omero_web_upgrade
: Upgrade OMERO.web if the current version does not matchomero_web_release
. This is a workaround for the inability to check for the latest version whenomero_web_release: latest
. It may be removed in future.omero_web_ice_version
: The ice version.omero_web_system_user
: OMERO.web system user, defaultomeroweb
.omero_web_systemd_setup
: Create and start theomero-web
systemd service, defaultTrue
OMERO.web configuration.
omero_web_config_set
: A dictionary ofconfig-key: value
which will be used for the initial OMERO.web configuration, default empty.value
can be a string, or an object (list, dictionary) that will be automatically converted to quoted JSON. Note configuration can also be done pre/post installation using theweb/config
conf.d style directory.omero_web_setup_nginx
: Install and configure Nginx, defaultTrue
.
Variables :
omero_web_systemd_start
: Automatically enable and start/restart systemd omero-web service, defaultTrue
. This is intended for use in server images where installation may be separate from configuration and execution.omero_web_always_reset_config
: Clear the existing configuration before regenerating, defaultTrue
.
It should be safe to use this role to deploy OMERO.web inside a standard centos:7
Docker container without systemd (omero_web_systemd_setup: False
).
This role regenerates the OMERO.web configuration file using the configuration files and helper script in /opt/omero/web/config
.
omero_web_config_set
can be used for simple configurations, for anything more complex consider creating one or more configuration files under: /opt/omero/web/config/
with the extension .omero
.
Manual configuration changes (omero config ...
) will be lost following a restart of omero-web
with systemd, you can disable this by setting omero_web_always_reset_config: False
.
Manual configuration changes will never be copied during an upgrade.
See ome/design#70 for a proposal to add support for a conf.d style directory directly into OMERO.
OMERO.web with the default backend server, localhost:4064
:
- hosts: localhost
roles:
- role: openmicroscopy.omero-web
OMERO.web with a custom configuration using omero_web_config_set
:
- hosts: localhost
roles:
- role: openmicroscopy.omero-web
omero_web_config_set:
omero.web.server_list:
- [omero.example.org, 4064, omero-example]
omero.web.public.enabled: True
omero.web.public.server_id: 1
omero.web.public.user: public
omero.web.public.password: secret-password
OMERO.web with a custom configuration using a configuration file web-custom-config.omero
:
- hosts: localhost
roles:
- role: openmicroscopy.omero-web
tasks:
- copy:
content: >
config set omero.web.server_list '[["omero.example.org", 4064, "omero-example"]'
dest: /opt/omero/web/config/web-custom-config.omero
notify:
- restart omero-web