Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Web doc improvement #1396

Merged
merged 28 commits into from
Feb 26, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1124845
updating web doc to clarify use of async workers
atarkowska Jan 29, 2016
11aab9e
adding debugging section
atarkowska Jan 29, 2016
41192d1
updating text
atarkowska Jan 30, 2016
73643a3
more fixes
atarkowska Feb 5, 2016
9075271
improving web deployment documentation
atarkowska Feb 7, 2016
a3945d5
updating note
atarkowska Feb 7, 2016
e7d8a10
updating benchmark
atarkowska Feb 7, 2016
0d60330
unifying gunicorn doc urls
atarkowska Feb 8, 2016
af0e708
adding wsgi standard note
atarkowska Feb 8, 2016
8385374
formatting
atarkowska Feb 8, 2016
ebb16e5
updating apache doc
atarkowska Feb 8, 2016
75bc809
moving knows issues to troubleshooting
atarkowska Feb 8, 2016
bbf06f0
updating apache config parameters
atarkowska Feb 8, 2016
c7d9502
fixing typos
atarkowska Feb 8, 2016
7006c90
Title underline too short.
atarkowska Feb 8, 2016
0ab8184
fixing typos pointed by @mtbc
atarkowska Feb 9, 2016
e196395
minor fixes
atarkowska Feb 9, 2016
8a10e9e
addressing @rleigh-dundee comments
atarkowska Feb 10, 2016
da8e77c
fixing properties
atarkowska Feb 10, 2016
4252287
update experimental features
atarkowska Feb 16, 2016
a857235
minor fixes
atarkowska Feb 16, 2016
00399e1
moving experimental to the bottom
atarkowska Feb 18, 2016
bf4120b
add nginx link
atarkowska Feb 24, 2016
8b1053c
updating doc
atarkowska Feb 24, 2016
54ea1f9
fixing typo
atarkowska Feb 24, 2016
e5d7044
more fixes
atarkowska Feb 24, 2016
73ff72b
typo
atarkowska Feb 24, 2016
5195d32
removing apache experimental
atarkowska Feb 26, 2016
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
2 changes: 2 additions & 0 deletions omero/sysadmins/customization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ the clients should not display
.. figure:: /images/disableScripts.png


.. _download_restrictions:

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

Expand Down
27 changes: 27 additions & 0 deletions omero/sysadmins/troubleshooting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,8 @@ images annotated with that tag), there are a few things that may have gone
wrong. See :ref:`search-failures` for more details.


.. _troubleshooting-omeroweb:

OMERO.web issues
----------------

Expand All @@ -342,6 +344,31 @@ OMERO.web did not start

:ome-users:`upgrade 5.0.5 to 5.1.1 omero.web forbidden <2015-April/005316.html>`

OMERO.web running but status says not started
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you upgraded OMERO but forgot to stop OMERO.web, processes will still be
running. In order to kill stale processes by hand, run::

$ ps aux | grep /home/omero/OMERO.server/var/django.pid

.. note::
As Gunicorn is based on the pre-fork worker model it is enough to kill
the master process, the one with the lowest PID.

OMERO.web not available HTTP 404
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Consult nginx :file:`error.log` for more details.

The most common problem appears when the default configuration for ``location /``
is loaded prior to omeroweb.conf

::

2016/01/01 00:00:00 [error] 1234#0: *5 "/usr/share/nginx/html/webclient/login/index.html" is not found (2: No such file or directory), client: 1.2.3.4, server


OMERO.web piecharts
^^^^^^^^^^^^^^^^^^^

Expand Down
38 changes: 36 additions & 2 deletions omero/sysadmins/unix/install-web/install-apache.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,16 @@ Apache 2.2+ with mod_wsgi configuration (Unix/Linux)
see :ref:`python-requirements` on the
:doc:`/sysadmins/version-requirements` page.

If you have installed Apache, install `mod\_wsgi <http://www.modwsgi.org/>`_.
OMERO.web uses the
`Web Server Gateway Interface (WSGI) <http://wsgi.readthedocs.org/en/latest/learn.html>`_
as a primary deployment platform. The Python standard
`PEP 3333 <https://www.python.org/dev/peps/pep-3333/>`_
that describes how a web server communicates with web applications.

.. _apache_default_configuration:

Apache default configuration (Unix/Linux)
-----------------------------------------

Install `Django 1.8`_ using package requirements file:

Expand All @@ -26,6 +35,24 @@ Install `Django 1.8`_ using package requirements file:
:djangodoc:`how to install Django 1.8 <topics/install/#install-the-django-code>`
or :djangodoc:`hot to upgrade Django to 1.8 <topics/install/#remove-any-old-versions-of-django>`.

Additional settings can be configured by changing the following properties:

- :property:`omero.web.application_server.max_requests` to 500

- :property:`omero.web.wsgi_workers` to (2 x NUM_CORES) + 1

.. note::
**Do not** scale the number of workers to the number of clients
you expect to have. OMERO.web should only need 4-12 worker
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- should be an en-dash () since this is a range (this applies to all use of ranges in the document).

processes to handle many requests per second.


.. _apache_mod_wsgi_configuration:

Apache configuration (Unix/Linux)
---------------------------------

If you have installed Apache, install `mod\_wsgi <http://www.modwsgi.org/>`_.

OMERO can automatically generate a
configuration file for your web server. The location of the file
Expand Down Expand Up @@ -58,5 +85,12 @@ configuration redirect the output of the following command into a file:
To configure an HTTPS server follow
`the Apache documentation <http://httpd.apache.org/docs/trunk/mod/mod_ssl.html>`_.


Then reload Apache.


Running OMERO.web (Unix/Linux)
------------------------------

OMERO.web is used in 'daemon' mode where UNIX sockets are used to communicate
between the Apache child processes and the daemon processes which are
to handle a request.
Loading