feiyuanxin / oq-qgis-server Goto Github PK

The Docker image is built using Fedora 31 and QGIS RPMs from https://copr.fedorainfracloud.org/coprs/dani/qgis/ (QGIS 3.14) and https://copr.fedorainfracloud.org/coprs/dani/qgis-ltr/ (QGIS 3.10 LTR). It includes Nginx and Xvfb and can be used as a standalone service (via HTTP TCP port 80) or as FCGI backend (via TCP port 9993).

A fallback image running Ubuntu 18.04 is also provided as fallback for systems lacking support for statx syscall. See the Requisites section. The Fedora container is generally more tested.

To be able to run Fedora containers you need Docker >= 18.04 with seccomp support for the statx syscall required by Qt 5.10+. This is generally included in libseccomp >= 2.3.3; a kernel with statx support is also required; any kernel newer than 4.11 should be ok. Please check with your vendor.

Known good configurations are:

• Ubuntu 18.04.2+
• CentOS 8
• Fedora 29+

As a fallback for systems lacking statx support, containers built on top of Ubuntu 18.04 LTS (Bionic) are also provided.

See https://github.com/gem/oq-qgis-server/issues/1 for further details.

Containers are not tested on hosts running OSes other than Linux.

This Docker container exposes HTTP on port 80 via Nginx and a direct FastCGI on port 9993 that can be used directly by an external HTTP proxy (like the provided docker-compose.yml does). A sample Nginx configuration for using it as a FastCGI backend is also provided.

Image name: openquake/qgis-server

• stable | 3.14 | 3.14.0 | stable-ubuntu | 3.14-ubuntu | 3.14.0-ubuntu

• ltr | 3.10 | 3.10.7 | ltr-ubuntu | 3.10-ubuntu | 3.10.7-ubuntu

• 3.12.1 | 3.12.1-ubuntu
• 3.10.4 | 3.10.4-ubuntu
• 3.10.1 | 3.10.1-ubuntu
• 3.10.0 | 3.10.0-ubuntu
• 3.4.14 | 3.4.14-ubuntu
• 3.4.13 | 3.4.13-ubuntu
• 3.4.12 | 3.4.12-ubuntu
• 3.4.11 | 3.4.11-ubuntu
• 3.4.10 | 3.4.10-ubuntu
• 3.4.9 | 3.4.9-ubuntu
• 3.4.8 | 3.4.8-ubuntu
• 3.4.7 | 3.4.7-ubuntu
• 3.4.6 | 3.4.6-ubuntu
• 3.4.5 | 3.4.5-ubuntu
• 3.8.3 | 3.8.3-ubuntu
• 3.8.2 | 3.8.2-ubuntu
• 3.8.1 | 3.8.1-ubuntu
• 3.8.0 | 3.8.0-ubuntu

Example:

$ docker pull openquake/qgis-server:ltr

# Fedora based container
$ docker build -t openquake/qgis-server:3.14 -f Dockerfile.fedora .
# Ubuntu based container
$ docker build -t openquake/qgis-server:3.14-ubuntu -f Dockerfile.ubuntu .

# Fedora based container
$ docker build --build-arg repo=qgis-ltr -t openquake/qgis-server:3.10 -f Dockerfile.fedora .
# Ubuntu based container
$ docker build --build-arg repo=ubuntu-ltr -t openquake/qgis-server:3.10-ubuntu -f Dockerfile.ubuntu .

You may skip this step. The container will be downloaded from the Docker Hub.

$ docker run -v $(pwd)/data:/io/data --name qgis-server -d -p 8010:80 openquake/qgis-server:3.10

WMS and WFS for a specific project will be published at http://localhost:8010/ogc/<project_name>. An /ows/ endpoint is also available for direct access to the fcgi (bypassing the map=<<project_name> rewrite).

Plugins, custom fonts and SVG can be optionally exposed from host to the containers:

-v $(pwd)/plugins:/io/plugins

-v $(pwd)/fonts:/usr/share/fonts

-v $(pwd)/svg:/var/lib/qgis/.local/share/QGIS/QGIS3/profiles/default/svg

Example:

$ docker run -v $(pwd)/data:/io/data -v $(pwd)/plugins:/io/plugins -v $(pwd)/fonts:/usr/share/fonts --name qgis-server -d -p 8010:80 openquake/qgis-server:3.10

$ docker exec -ti qgis-server /bin/bash

where qgis-server is the name of the container.

QGIS server log can retreived via docker logs

$ docker logs [-f] qgis-server

where qgis-server is the name of the container.

Default log level is set to warning. Log level can be increased during container deployment passing the -e QGIS_SERVER_LOG_LEVEL=0 option:

$ docker run -e QGIS_SERVER_LOG_LEVEL=0 -v $(pwd)/data:/io/data -v $(pwd)/plugins:/io/plugins --name qgis-server -d -p 8010:80 openquake/qgis-server:3.10

Adjust first the configuration in conf/nginx.conf with the proper number of expected workers and docker-compose.yml with the path of data folder on the host.

Then:

$ docker-compose up -d --scale qgis-server=N

Where N is the number of expected QGIS server workers.

$(pwd)/data must have the following structure:

data 
 |
 |-- <project_name>
      |-- <project_name>.qgs

oq-consolidate may helps you in exporting data suitable for QGIS server (consolidating project and layers).

$(pwd)/plugins must have the following structure:

plugins
 |
 |-- <plugin_name>
      |-- <plugin_code>.py
      |-- metadata.txt
      |-- __init__.py

Custom fonts are loaded into /usr/share/fonts. fc-cache is run when container is started.

The following variables can be customized during container deployment:

When SKIP_NGINX is set to a different value than 0 or false the embedded copy of Nginx will not be started and an external reverse proxy is then required to access the FastCGI QGIS backend.

• SKIP_NGINX: default is unset (do not skip Nginx startup)

• QGIS_SERVER_LOG_LEVEL: default is 1
• QGIS_SERVER_PARALLEL_RENDERING: default is true
• QGIS_SERVER_MAX_THREADS: default is 2
• QGIS_SERVER_WMS_MAX_WIDTH: not set by default
• QGIS_SERVER_WMS_MAX_WIDTH: not set by default

See QGIS server documentation for further details.

It is also possible to customized the ID of the user running QGIS server processes when it is required to write to host volumes (see notes):

• QGIS_USER: default is nginx, a numerical id must be proivided

Example: docker run -e QGIS_USER=1000 or docker run -e QGIS_USER=$(id -u qgis)

GeoPackages do not play well with multiple processes having gpkg files opened in rw mode. By default QGIS server processes lack write permission on /io/data. If it is required to let QGIS server write data to /io/data make sure that either you are using a process-safe datastore (i.e. a Postgres backend) or you are limiting horizontal scaling to one container only. QGIS server user can be customized via the QGIS_USER environment variable.