Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions omero/conf_autogen.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
version_matlab = "5.5.6"
version_dsl_plugin = "5.5.4"
version_blitz_plugin = "5.5.4"
version_py = "5.21.0"
version_web = "5.29.1"
version_py = "5.21.3"
version_web = "5.30.0"
version_dropbox = "5.7.0"
47 changes: 35 additions & 12 deletions omero/sysadmins/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1498,7 +1498,7 @@ the plane size cutoff above which a pixel pyramid will be
generated by the pixeldata service unless subresolutions
can be read from the file format.
These values will be ignored for floating or double pixel
data types unlesss :property: `omero.pixeldata.max_plane_float_override`
data types unless :property:`omero.pixeldata.max_plane_float_override`
is set to false.
Note pyramids are never generated for floating point pixel types.

Expand All @@ -1513,7 +1513,7 @@ the plane size cutoff above which a pixel pyramid will be
generated by the pixeldata service unless subresolutions
can be read from the file format.
These values will be ignored for floating or double pixel
data types unlesss :property: `omero.pixeldata.max_plane_float_override`
data types unlesss :property:`omero.pixeldata.max_plane_float_override`
is set to false.
Note pyramids are never generated for floating point pixel types.

Expand All @@ -1529,6 +1529,15 @@ engine.

Default: `268435456`

.. property:: omero.pixeldata.max_tile_length

omero.pixeldata.max_tile_length
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Maximum tile size which can be requested by clients. Tile requests where
the width or height exceeds this value should be truncated.

Default: `1024`

.. property:: omero.pixeldata.memoizer.dir

omero.pixeldata.memoizer.dir
Expand Down Expand Up @@ -2215,6 +2224,20 @@ https://docs.openmicroscopy.org/omero/latest/sysadmins/grid.html#deployment-exam
Default: `[empty]`


.. _tables_configuration:

Tables
------

.. property:: omero.tables.module

omero.tables.module
^^^^^^^^^^^^^^^^^^^
Name of the Python module to use when starting the Tables service

Default: `runTables`


.. _web_configuration:

Web
Expand Down Expand Up @@ -2336,7 +2359,7 @@ Default: `false`

omero.web.csrf_trusted_origins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A list of hosts which are trusted origins for unsafe requests. When starting with '.', all subdomains are included. Example ``'[".example.com", "another.example.net"]'``. For more details see :djangodoc:`CSRF trusted origins <ref/settings/#csrf-trusted-origins>`.
A list of hosts which are trusted origins for unsafe requests. When starting with '.', all subdomains are included. e.g. ``'["https://*.example.com", "https://another.example.net"]'``. For more details see :djangodoc:`CSRF trusted origins <ref/settings/#csrf-trusted-origins>`.

Default: `[]`

Expand Down Expand Up @@ -2468,6 +2491,14 @@ Prevent download of OMERO.tables exceeding this number of rows in a single reque

Default: `10000`

.. property:: omero.web.max_table_slice_size

omero.web.max_table_slice_size
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Maximum number of cells that can be retrieved in a single call to the table slicing endpoint.

Default: `1000000`

.. property:: omero.web.maximum_multifile_download_size

omero.web.maximum_multifile_download_size
Expand Down Expand Up @@ -2762,7 +2793,7 @@ omero.web.session_serializer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can use this setting to customize the session serialization format. See :djangodoc:`Django session serialization documentation <topics/http/sessions/#session-serialization>` for more details.

Default: `django.contrib.sessions.serializers.PickleSerializer`
Default: `django.contrib.sessions.serializers.JSONSerializer`

.. property:: omero.web.sharing.opengraph

Expand Down Expand Up @@ -2908,14 +2939,6 @@ Django view which handles display of, or redirection to, the desired full image

Default: `omeroweb.webclient.views.image_viewer`

.. property:: omero.web.webgateway_cache

omero.web.webgateway_cache
^^^^^^^^^^^^^^^^^^^^^^^^^^


Default: `None`

.. property:: omero.web.wsgi_args

omero.web.wsgi_args
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,30 @@ If required, first create a local system user omero-web and create directory::
mkdir -p /opt/omero/web/omero-web/etc/grid
chown -R omero-web /opt/omero/web/omero-web



Installing prerequisites
------------------------

**The following steps are run as root.**

Enable CodeReady Linux Builder repository:

Redhat::

subscription-manager repos --enable codeready-builder-for-rhel-9-$(arch)-rpms


Rocky::

dnf -y install 'dnf-command(config-manager)'

dnf config-manager --set-enabled crb


Install dependencies::

cat <<EOF > /etc/yum.repos.d/nginx.repo
[nginx-stable]
name=nginx stable repo
baseurl=http://nginx.org/packages/centos/\$releasever/\$basearch/
gpgcheck=1
enabled=1
gpgkey=https://nginx.org/keys/nginx_signing.key
module_hotfixes=true
EOF
if grep -q "Rocky" /etc/redhat-release; then
dnf -y install 'dnf-command(config-manager)'
dnf config-manager --set-enabled crb
fi
if grep -q "Red Hat" /etc/redhat-release; then
subscription-manager repos --enable codeready-builder-for-rhel-9-$(arch)-rpms
fi
cat <<EOF > /etc/yum.repos.d/nginx.repo
[nginx-stable]
name=nginx stable repo
baseurl=http://nginx.org/packages/centos/\$releasever/\$basearch/
gpgcheck=1
enabled=1
gpgkey=https://nginx.org/keys/nginx_signing.key
module_hotfixes=true
EOF

dnf -y install git

Expand All @@ -61,7 +53,7 @@ Install dependencies::
dnf -y install nginx


*Optional*: if you wish to use the Redis cache, install Redis::
*Recommended*: if you wish to use the Redis cache, install Redis::

dnf -y install redis

Expand All @@ -75,13 +67,13 @@ Creating a virtual environment

**The following steps are run as root.**


Create the virtual environment. This is the recommended way to install OMERO.web::

python3.12 -mvenv /opt/omero/web/venv3




Install ZeroC IcePy 3.6::

/opt/omero/web/venv3/bin/pip install https://github.com/glencoesoftware/zeroc-ice-py-linux-x86_64/releases/download/20240202/zeroc_ice-3.6.5-cp312-cp312-manylinux_2_28_x86_64.whl
Expand Down Expand Up @@ -227,7 +219,6 @@ Copy the generated configuration file into the NGINX configuration directory, di

systemctl start nginx

**The following steps are run as omero-web system user.**

For production servers you may need to add additional directives to the configuration file, for example to enable `HTTPS <https://nginx.org/en/docs/http/configuring_https_servers.html>`_. As an alternative to manually modifying the generated file you can generate a minimal configuration and include this in your own manually created NGINX file, such as :file:`/etc/nginx/conf.d/omero-web.conf`:

Expand All @@ -250,15 +241,14 @@ Running OMERO.web

Since OMERO.web 5.16.0, the package `whitenoise` is installed by default.

**The following steps are run as root.**

*Optional*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::
*Recommended*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::

/opt/omero/web/venv3/bin/pip install 'django-redis==5.0.0'

**The following steps are run as the omero-web system user.**

*Optional*: Configure the cache::
*Recommended*: Configure the cache::

omero config set omero.web.caches '{"default": {"BACKEND": "django_redis.cache.RedisCache","LOCATION": "redis://127.0.0.1:6379/0"}}'
omero config set omero.web.session_engine 'django.contrib.sessions.backends.cache'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ If required, first create a local system user omero-web and create directory::
mkdir -p /opt/omero/web/omero-web/etc/grid
chown -R omero-web /opt/omero/web/omero-web



Installing prerequisites
------------------------

Expand All @@ -39,7 +37,7 @@ Install dependencies::
apt-get -y install nginx


*Optional*: if you wish to use the Redis cache, install Redis::
*Recommended*: if you wish to use the Redis cache, install Redis::

apt-get -y install redis-server

Expand Down Expand Up @@ -217,13 +215,13 @@ Running OMERO.web
Since OMERO.web 5.16.0, the package `whitenoise` is installed by default.


*Optional*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::
*Recommended*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::

/opt/omero/web/venv3/bin/pip install 'django-redis==5.0.0'

**The following steps are run as the omero-web system user.**

*Optional*: Configure the cache::
*Recommended*: Configure the cache::

omero config set omero.web.caches '{"default": {"BACKEND": "django_redis.cache.RedisCache","LOCATION": "redis://127.0.0.1:6379/0"}}'
omero config set omero.web.session_engine 'django.contrib.sessions.backends.cache'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ If required, first create a local system user omero-web and create directory::
mkdir -p /opt/omero/web/omero-web/etc/grid
chown -R omero-web /opt/omero/web/omero-web



Installing prerequisites
------------------------

Expand All @@ -39,7 +37,7 @@ Install dependencies::
apt-get -y install nginx


*Optional*: if you wish to use the Redis cache, install Redis::
*Recommended*: if you wish to use the Redis cache, install Redis::

apt-get -y install redis-server

Expand Down Expand Up @@ -217,13 +215,13 @@ Running OMERO.web
Since OMERO.web 5.16.0, the package `whitenoise` is installed by default.


*Optional*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::
*Recommended*: Install `Django Redis <https://github.com/jazzband/django-redis>`_::

/opt/omero/web/venv3/bin/pip install 'django-redis==5.0.0'

**The following steps are run as the omero-web system user.**

*Optional*: Configure the cache::
*Recommended*: Configure the cache::

omero config set omero.web.caches '{"default": {"BACKEND": "django_redis.cache.RedisCache","LOCATION": "redis://127.0.0.1:6379/0"}}'
omero config set omero.web.session_engine 'django.contrib.sessions.backends.cache'
Expand Down