Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 4.78 KB

README.md

File metadata and controls

98 lines (73 loc) · 4.78 KB
Raw

logoLizmap QGIS Server Plugin

QGIS.org Tests 🎳

Environment variables

  • QGIS_SERVER_LIZMAP_REVEAL_SETTINGS, read docs.lizmap.com documentation
  • STRICT_BING_TOS_CHECK and STRICT_GOOGLE_TOS_CHECK, if set to TRUE (the default value), an API key will be checked and required for these layers. If no API key provided in the Lizmap plugin, these layers will be discarded. If set to FALSE, these layers will be forwarded from QGIS Server to Lizmap Web Client but these layers might not work and the TOS from these providers might not be compliant.

Download

Stable

  • All published versions are available plugins.qgis.org.
  • We highly recommend to use qgis-plugin-manager to download and install.
    • qgis-plugin-manager install 'Lizmap server'
    • and then follow the documentation about the environment variable for security in the Lizmap documentation.
  • Latest release link with the full changelog from the release page

Remember that the plugin must be updated with each release of Lizmap Web Client with its latest version available.

Unstable

  • The master branch can be found on https://packages.3liz.org/ after each commits with a stable link.
  • Do not use the link provided by GitHub by default in the top right corner.

You can find help and news by subscribing to the mailing list: https://lists.osgeo.org/mailman/listinfo/lizmap.

For more detailed information, check the Lizmap Web Client GitHub repository.

Lizmap server API

Starting from :

  • Lizmap 3.4, the plugin is highly recommended.
  • Lizmap 3.6, the plugin is required.

To enable all features in Lizmap Web Client, read the documentation about the environment variable on the QGIS server side.

  • lizmap/server.json
  • SERVICE=LIZMAP
    • REQUEST=GetServerSettings deprecated for the JSON URL above
    • REQUEST=GetSubsetString
      • LAYER=
      • LIZMAP_USER_GROUPS=
  • SERVICE=EXPRESSION
    • REQUEST=VirtualFields
      • VIRTUALS=
      • FILTER=
      • FIELDS=
      • WITH_GEOMETRY=true
    • REQUEST=replaceExpressionText
      • STRING=
      • STRINGS=
      • FEATURE=
      • FEATURES=
      • FORM_SCOPE=
    • REQUEST=GetFeatureWithFormScope
      • FILTER=
      • FORM_FEATURE=
      • WITH_GEOMETRY=
      • FIELDS=
    • REQUEST=Evaluate
      • EXPRESSIONS=
      • FEATURE=
      • FEATURES=
      • FORM_SCOPE=

Tests

make tests

Manually running a local QGIS server :

QGIS_PLUGINPATH=/home/etienne/dev/qgis/server_plugin_git/lizmap_server/ QGIS_SERVER_LOG_FILE=/tmp/bob.txt QGIS_SERVER_LOG_LEVEL=0 QGIS_SERVER_LIZMAP_REVEAL_SETTINGS=True REQUEST_URI=/lizmap/server.json /usr/lib/cgi-bin/qgis_mapserv.fcgi

License

Version: MPL 2.0/GPL 2.0/LGPL 2.1

The contents of this file are subject to the Mozilla Public License Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Alternatively, the contents of this file may be used under the terms of either of the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.