QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | List of all members
QgsServerSettingsEnv Class Reference

Provides some enum describing the environment currently supported for configuration. More...

#include <qgsserversettings.h>

Inheritance diagram for QgsServerSettingsEnv:
Inheritance graph
[legend]

Public Types

enum  EnvVar {
  QGIS_OPTIONS_PATH , QGIS_SERVER_PARALLEL_RENDERING , QGIS_SERVER_MAX_THREADS , QGIS_SERVER_LOG_LEVEL ,
  QGIS_SERVER_LOG_FILE , QGIS_SERVER_LOG_STDERR , QGIS_PROJECT_FILE , QGIS_SERVER_IGNORE_BAD_LAYERS ,
  QGIS_SERVER_CACHE_DIRECTORY , QGIS_SERVER_CACHE_SIZE , QGIS_SERVER_SHOW_GROUP_SEPARATOR , QGIS_SERVER_OVERRIDE_SYSTEM_LOCALE ,
  QGIS_SERVER_WMS_MAX_HEIGHT , QGIS_SERVER_WMS_MAX_WIDTH , QGIS_SERVER_API_RESOURCES_DIRECTORY , QGIS_SERVER_API_WFS3_MAX_LIMIT ,
  QGIS_SERVER_TRUST_LAYER_METADATA , QGIS_SERVER_FORCE_READONLY_LAYERS , QGIS_SERVER_DISABLE_GETPRINT , QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES ,
  QGIS_SERVER_LANDING_PAGE_PROJECTS_PG_CONNECTIONS , QGIS_SERVER_LOG_PROFILE , QGIS_SERVER_SERVICE_URL , QGIS_SERVER_WMS_SERVICE_URL ,
  QGIS_SERVER_WFS_SERVICE_URL , QGIS_SERVER_WCS_SERVICE_URL , QGIS_SERVER_WMTS_SERVICE_URL , QGIS_SERVER_LANDING_PAGE_PREFIX ,
  QGIS_SERVER_PROJECT_CACHE_CHECK_INTERVAL , QGIS_SERVER_PROJECT_CACHE_STRATEGY , QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS
}
 Environment variables to configure the server. More...
 
enum  Source { DEFAULT_VALUE , ENVIRONMENT_VARIABLE , INI_FILE }
 Source of the parameter used in the configuration. More...
 

Detailed Description

Provides some enum describing the environment currently supported for configuration.

Since
QGIS 3.0

Definition at line 36 of file qgsserversettings.h.

Member Enumeration Documentation

◆ EnvVar

Environment variables to configure the server.

Enumerator
QGIS_OPTIONS_PATH 
QGIS_SERVER_PARALLEL_RENDERING 
QGIS_SERVER_MAX_THREADS 
QGIS_SERVER_LOG_LEVEL 
QGIS_SERVER_LOG_FILE 
QGIS_SERVER_LOG_STDERR 
QGIS_PROJECT_FILE 
QGIS_SERVER_IGNORE_BAD_LAYERS 

Do not consider the whole project unavailable if it contains bad layers.

QGIS_SERVER_CACHE_DIRECTORY 
QGIS_SERVER_CACHE_SIZE 
QGIS_SERVER_SHOW_GROUP_SEPARATOR 

Show group (thousands) separator when formatting numeric values, defaults to false (since QGIS 3.8)

QGIS_SERVER_OVERRIDE_SYSTEM_LOCALE 

Override system locale (since QGIS 3.8)

QGIS_SERVER_WMS_MAX_HEIGHT 

Maximum height for a WMS request. The most conservative between this and the project one is used (since QGIS 3.6.2)

QGIS_SERVER_WMS_MAX_WIDTH 

Maximum width for a WMS request. The most conservative between this and the project one is used (since QGIS 3.6.2)

QGIS_SERVER_API_RESOURCES_DIRECTORY 

Base directory where HTML templates and static assets (e.g. images, js and css files) are searched for (since QGIS 3.10).

QGIS_SERVER_API_WFS3_MAX_LIMIT 

Maximum value for "limit" in a features request, defaults to 10000 (since QGIS 3.10).

QGIS_SERVER_TRUST_LAYER_METADATA 

Trust layer metadata. Improves project read time. (since QGIS 3.16).

QGIS_SERVER_FORCE_READONLY_LAYERS 

Force to open layers in read-only mode. (since QGIS 3.28).

QGIS_SERVER_DISABLE_GETPRINT 

Disabled WMS GetPrint request and don't load layouts. Improves project read time. (since QGIS 3.16).

QGIS_SERVER_LANDING_PAGE_PROJECTS_DIRECTORIES 

Directories used by the landing page service to find .qgs and .qgz projects (since QGIS 3.16)

QGIS_SERVER_LANDING_PAGE_PROJECTS_PG_CONNECTIONS 

PostgreSQL connection strings used by the landing page service to find projects (since QGIS 3.16)

QGIS_SERVER_LOG_PROFILE 

When QGIS_SERVER_LOG_LEVEL is 0 this flag adds to the logs detailed information about the time taken by the different processing steps inside the QGIS Server request (since QGIS 3.16)

QGIS_SERVER_SERVICE_URL 

To set the service URL if it's not present in the project. (since QGIS 3.20).

QGIS_SERVER_WMS_SERVICE_URL 

To set the WMS service URL if it's not present in the project. (since QGIS 3.20).

QGIS_SERVER_WFS_SERVICE_URL 

To set the WFS service URL if it's not present in the project. (since QGIS 3.20).

QGIS_SERVER_WCS_SERVICE_URL 

To set the WCS service URL if it's not present in the project. (since QGIS 3.20).

QGIS_SERVER_WMTS_SERVICE_URL 

To set the WMTS service URL if it's not present in the project. (since QGIS 3.20).

QGIS_SERVER_LANDING_PAGE_PREFIX 
QGIS_SERVER_PROJECT_CACHE_CHECK_INTERVAL 

Prefix of the path component of the landing page base URL, default is empty (since QGIS 3.20).

QGIS_SERVER_PROJECT_CACHE_STRATEGY 

Set the interval for cache invalidation strategy 'interval', default to 0 which select the legacy File system watcher (since QGIS 3.26).

QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS 

Set the project cache strategy. Possible values are 'filesystem', 'periodic' or 'off' (since QGIS 3.26).

Definition at line 51 of file qgsserversettings.h.

◆ Source

Source of the parameter used in the configuration.

Enumerator
DEFAULT_VALUE 
ENVIRONMENT_VARIABLE 
INI_FILE 

Definition at line 42 of file qgsserversettings.h.


The documentation for this class was generated from the following file: