gws.server.core

Configuration for embedded servers.

Source code: gws.server.core

Module Contents

class gws.server.core.Config(*args, **kwargs)

Bases: gws.Config

Server module configuration

autoRun: str = ''

Shell command to run before server start.

log: LogConfig | None

Logging configuration.

mapproxy: MapproxyConfig | None

Bundled Mapproxy module.

monitor: MonitorConfig | None

Monitor configuration.

qgis: QgisConfig | None

Qgis server configuration.

spool: SpoolConfig | None

Spool server module.

templates: list[gws.ext.config.template] | None

Configuration templates.

timeout: gws.Duration = '60'

Server timeout. (deprecated in 8.1)

timeZone: str = 'UTC'

Timezone for this server.

web: WebConfig | None

Web server module.

class gws.server.core.LogConfig(*args, **kwargs)

Bases: gws.Config

Logging configuration

level: Literal[ERROR, INFO, DEBUG] = 'INFO'

Logging level.

path: str = ''

Log path.

class gws.server.core.MapproxyConfig(*args, **kwargs)

Bases: gws.Config

Mapproxy server module

enabled: bool = True

The module is enabled.

forceStart: bool = False

Start even if no configuration is defined.

host: str = 'localhost'

Host to run the module on.

port: int = 5000

Port number.

threads: int = 0

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

workers: int = 4

Number of processes for this module.

class gws.server.core.MonitorConfig(*args, **kwargs)

Bases: gws.Config

Object configuration.

enabled: bool = True

The module is enabled.

frequency: gws.Duration = '30'

Filesystem changes check frequency.

ignore: list[gws.Regex] | None

Ignore paths that match these regexes.

class gws.server.core.QgisConfig(*args, **kwargs)

Bases: gws.Config

External QGIS server configuration.

debug: int = 0

QGIS_DEBUG (env. variable) (deprecated in 8.0)

host: str = 'qgis'

Host where the qgis server runs.

legend: dict | None

default legend settings (deprecated in 8.0)

maxCacheLayers: int = 4000

MAX_CACHE_LAYERS (env. variable) (deprecated in 8.0)

port: int = 80

Port number.

searchPathsForSVG: list[gws.DirPath] | None

searchPathsForSVG (ini setting) (deprecated in 8.0)

serverCacheSize: int = 10000000

QGIS_SERVER_CACHE_SIZE (env. variable) (deprecated in 8.0)

serverLogLevel: int = 2

QGIS_SERVER_LOG_LEVEL (env. variable) (deprecated in 8.0)

class gws.server.core.SpoolConfig(*args, **kwargs)

Bases: gws.Config

Spool server module

enabled: bool = True

The module is enabled.

jobFrequency: gws.Duration = '3'

Background jobs checking frequency.

threads: int = 0

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

timeout: gws.Duration = '300'

Job timeout. (added in 8.1)

workers: int = 4

Number of processes for this module.

class gws.server.core.WebConfig(*args, **kwargs)

Bases: gws.Config

Web server module

enabled: bool = True

The module is enabled.

maxRequestLength: int = 10

Max request length in megabytes.

threads: int = 0

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

timeout: gws.Duration = '60'

Web server timeout. (added in 8.1)

workers: int = 4

Number of processes for this module.