:tocdepth: 3

:py:mod:`gws.server`
====================

.. py:module:: gws.server

.. autoapi-nested-parse::

   Configuration and management of embedded servers.

   GWS runs several servers in the container: WSGI backend servers (Web and Mapproxy), the Spool server for background jobs and the frontend NGINX proxy.

   This module provides configuration and control utilities for these facilities. It handles GWS startups and reloads.

   The GWS startup sequence is the following:

   - the main script ``bin/gws`` invokes the ``start`` command in :obj:`gws.server.cli`
   - CLI delegates to :obj:`gws.server.control`
   - control invokes the ``Application`` configuration in :obj:`gws.base.application.core.Object`
   - the Application creates a ``ServerManager`` (:obj:`gws.server.manager.Object`)
   - the Manager creates configuration files for embedded servers and a startup shell script to start them
   - the control is returned to ``bin/gws``, which invokes the startup script
   - the script starts the backends and finally NGINX, which keeps running in foreground



**Source code:** :source:`gws.server<gws/server/__init__.py>`

Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   spool/index.rst



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   cli/index.rst
   control/index.rst
   core/index.rst
   manager/index.rst
   monitor/index.rst
   uwsgi_module/index.rst



Package Contents
----------------



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.Config`

   Server module configuration

   .. py:attribute:: autoRun
      :type:  str
      :value: ''


      Shell command to run before server start.

   .. py:attribute:: log
      :type:  Optional[LogConfig]

      Logging configuration.

   .. py:attribute:: mapproxy
      :type:  Optional[MapproxyConfig]

      Bundled Mapproxy module.

   .. py:attribute:: monitor
      :type:  Optional[MonitorConfig]

      Monitor configuration.

   .. py:attribute:: qgis
      :type:  Optional[QgisConfig]

      Qgis server configuration.

   .. py:attribute:: spool
      :type:  Optional[SpoolConfig]

      Spool server module.

   .. py:attribute:: templates
      :type:  Optional[list[gws.ext.config.template]]

      Configuration templates.

   .. py:attribute:: timeout
      :type:  gws.Duration
      :value: '60'


      Server timeout. (deprecated in 8.1)

   .. py:attribute:: timeZone
      :type:  str
      :value: 'UTC'


      Timezone for this server.

   .. py:attribute:: web
      :type:  Optional[WebConfig]

      Web server module.