:tocdepth: 3

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

.. py:module:: gws.server.core

.. autoapi-nested-parse::

   Configuration for embedded servers.



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



Module 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.


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


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

   Logging configuration

   .. py:attribute:: level
      :type:  Literal['ERROR', 'INFO', 'DEBUG']
      :value: 'INFO'


      Logging level.

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


      Log path.


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


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

   Mapproxy server module

   .. py:attribute:: enabled
      :type:  bool
      :value: True


      The module is enabled.

   .. py:attribute:: forceStart
      :type:  bool
      :value: False


      Start even if no configuration is defined.

   .. py:attribute:: host
      :type:  str
      :value: 'localhost'


      Host to run the module on.

   .. py:attribute:: port
      :type:  int
      :value: 5000


      Port number.

   .. py:attribute:: threads
      :type:  int
      :value: 0


      Number of threads for this module. (deprecated in 8.0)

   .. py:attribute:: workers
      :type:  int
      :value: 4


      Number of processes for this module.


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


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

   Object configuration.

   .. py:attribute:: enabled
      :type:  bool
      :value: True


      The module is enabled.

   .. py:attribute:: frequency
      :type:  gws.Duration
      :value: '30'


      Filesystem changes check frequency.

   .. py:attribute:: ignore
      :type:  Optional[list[gws.Regex]]

      Ignore paths that match these regexes.


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


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

   External QGIS server configuration.

   .. py:attribute:: debug
      :type:  int
      :value: 0


      QGIS_DEBUG (env. variable) (deprecated in 8.0)

   .. py:attribute:: host
      :type:  str
      :value: 'qgis'


      Host where the qgis server runs.

   .. py:attribute:: legend
      :type:  Optional[dict]

      default legend settings (deprecated in 8.0)

   .. py:attribute:: maxCacheLayers
      :type:  int
      :value: 4000


      MAX_CACHE_LAYERS (env. variable) (deprecated in 8.0)

   .. py:attribute:: port
      :type:  int
      :value: 80


      Port number.

   .. py:attribute:: searchPathsForSVG
      :type:  Optional[list[gws.DirPath]]

      searchPathsForSVG (ini setting) (deprecated in 8.0)

   .. py:attribute:: serverCacheSize
      :type:  int
      :value: 10000000


      QGIS_SERVER_CACHE_SIZE (env. variable) (deprecated in 8.0)

   .. py:attribute:: serverLogLevel
      :type:  int
      :value: 2


      QGIS_SERVER_LOG_LEVEL (env. variable) (deprecated in 8.0)


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


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

   Spool server module

   .. py:attribute:: enabled
      :type:  bool
      :value: True


      The module is enabled.

   .. py:attribute:: jobFrequency
      :type:  gws.Duration
      :value: '3'


      Background jobs checking frequency.

   .. py:attribute:: threads
      :type:  int
      :value: 0


      Number of threads for this module. (deprecated in 8.0)

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


      Job timeout. (added in 8.1)

   .. py:attribute:: workers
      :type:  int
      :value: 4


      Number of processes for this module.


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


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

   Web server module

   .. py:attribute:: enabled
      :type:  bool
      :value: True


      The module is enabled.

   .. py:attribute:: maxRequestLength
      :type:  int
      :value: 10


      Max request length in megabytes.

   .. py:attribute:: threads
      :type:  int
      :value: 0


      Number of threads for this module. (deprecated in 8.0)

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


      Web server timeout. (added in 8.1)

   .. py:attribute:: workers
      :type:  int
      :value: 4


      Number of processes for this module.