:tocdepth: 3

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

.. py:module:: gws.server.manager

.. autoapi-nested-parse::

   Configuration manager for embedded servers.

   This object creates configuration files for embedded servers and the server startup script.

   The configuration is template-based, there are following template subjects defined:

   - ``server.rsyslog_config`` - for the embedded ``rsyslogd`` daemon
   - ``server.uwsgi_config`` - for backend uWSGI servers (the ``uwsgi`` argument contains the specific backend name)
   - ``server.nginx_config`` - for the frontend NGINX proxy

   Each template receives a :obj:`TemplateArgs` object as arguments.

   By default, the Manager uses text-only templates from the ``templates`` directory.



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



Module Contents
---------------



.. py:class:: Object


   Bases: :py:obj:`gws.ServerManager`

   Server configuration manager.

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_environment()

      Overwrite config values from the environment.


   .. py:method:: configure_templates()

   .. py:method:: create_server_configs(target_dir, script_path, pid_paths)

      Create server configuration files.



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


   Bases: :py:obj:`gws.TemplateArgs`

   Arguments for configuration templates.

   .. py:attribute:: groupName
      :type:  str

      Group name.

   .. py:attribute:: gwsEnv
      :type:  dict

      A dict of GWS environment variables.

   .. py:attribute:: inContainer
      :type:  bool

      True if we're running in a container.

   .. py:attribute:: mapproxyPid
      :type:  str

      Mapproxy pid path.

   .. py:attribute:: mapproxySocket
      :type:  str

      Mapproxy socket path.

   .. py:attribute:: nginxPid
      :type:  str

      nginx pid path.

   .. py:attribute:: root
      :type:  gws.Root

      Root object.

   .. py:attribute:: serverDir
      :type:  str

      Absolute path to app/server directory.

   .. py:attribute:: spoolPid
      :type:  str

      Spooler pid path.

   .. py:attribute:: spoolSocket
      :type:  str

      Spooler socket path.

   .. py:attribute:: userName
      :type:  str

      User name.

   .. py:attribute:: uwsgi
      :type:  str

      uWSGI backend name.

   .. py:attribute:: webPid
      :type:  str

      Web server pid path.

   .. py:attribute:: webSocket
      :type:  str

      Web server socket path.