It is also assumed that Gisquick platform is running on the publication server. Such server can be run on your own hardware or in cloud services, see Deployment of server application in Docker containers section for details.
Gisquick provides ready-to-use demo publication server available at https://projects.gisquick.org, freely available for experiments and testing.
QGIS project dedicated for publishing is prepared in the standard way. Map layers can be combined from various data sources as flat files (Esri Shapefile, GML), file-based databases (SQLite, SpatiaLite), server-client databases (PostGIS), or OGC Web Services (WMS, WFS, WCS).
Before publishing project using Gisquick plugin, the project must be saved.
When using flat files or file-based databases as data stores it is recommended to save all the files (data and QGIS project) in the same directory. QGIS project must be set up to use relative paths (see Project Properties).
When using any kind of authentication (databases, web services) it must be ensured that server used for publishing will have access rights to such data sources.
Publishing QGIS project will be demonstrated on Prague sample
project downloadable as zip file. At
prague.qgs QGIS project is open in QGIS
Desktop. Before doing any changes the project will be published as it
First page of the wizard allows defining basic settings for publishing:
- base layers,
- overlay layers, and
- basic project metadata
By base layers are meant typically WMS layers provided by QGIS
Base layer sub-page also allows adding base layers provided by
external services like OpenStreetMap, MapBox or Bing.
Here also default base layer can be defined, see figure below.
In the second
Layers sub-page is controlled, simply by check
boxes, which map layers will be published. It’s also possible to
publish layer as hidden (ie. not shown in
Overlay layers tab, see
User Interface section). Top-left checkbox
controls usage of QGIS Server map cache. By default, map tiles are
cached by QGIS server and re-used when possible.
Project sub-page allows defining basic project metadata
like title, extent, min/max scales, info message, access constraints,
In the following page topics can be defined. By topic it’s meant
group of thematically-related overlay layers. Topics can be easily
Topics tab of Gisquick UI, see
User Interface section. Layers which
should be part of defined topic are simply checked. Topics can be
added or removed by buttons located in bottom-left part of the
dialog. Each topic has defined short description (abstract) which is
shown by Gisquick UI.
Last but one page shows read-only configuration summary. It’s last
chance to go back by
Back button and change publication settings.
On the last page are displayed files which needs to transferred to the
Gisquick publication server. The result of publication process are two
generated files: timestamped QGIS project (
.qgs) and metafile
.meta). These files together with project data (see
sources) must be transferred to the publication server.
Publish button is pressed, unique project file name with
timestamp together with its metafile are created. By default,
timestamped files are created in the same directory as original QGIS
project. Optionally the destination directory can be changed by
Change button. In this case data source files are also copied to
the newly defined directory.
The published project together with data can be optionally zipped into
archive, which can be easily uploaded to the publication server, see
Create project zip file for upload option.
Transferring project to publication server¶
Publication process is finished by transferring project to the publication server. The procedure will be explained on demo publication server (https://projects.gisquick.org).
First of all a new user account must be created on publication server. This can be done easily by filling registration form available at https://projects.gisquick.org/accounts/register/.
CREATE ACCOUNT button an confirmation mail should
be send to given e-mail address.
Afterwards a new user is notified about successfull singing-in.
After clicking on
CONTINUE button a new user will be redicted to
the publication server welcome screen.
The user can log-in using credentials (user name and password). After log-in Gisquick loads an empty project.
In the next step the user can upload prepared project zip file created
by Gisquick plugin as described in section above. In the user menu go
My profile (see User profile page
for details). Go to
Upload project, enter project zip file and
upload the file using
After successfull upload go to
My Projects and find your first
Click on it’s name and enjoy Gisquick!
Notes for advanced users running testing environment¶
Uploading step can be skipped when running publication server in
testing enviromment. Publication directory is defined by
docker-compose.yml configuration file. In the presented
example publication directory is located
in Gisquick source tree
Projects in the
publish directory are split into
sub-directories corresponding registered users, see
User management section.
Then published QGIS project (including timestamped files) with all
associated data can be copied into user publish directory,
docker/_data/publish/user1 directory located on the
publication server. In our example, the project will be copied into
Published project is possible to access by URL formed by server name (https://localhost in the case of virtual server), user name, project directory and QGIS project file name, see URL below.
As the final step, open web browser and launch published project in Gisquick interface by entering URL, in our case eg. https://localhost?PROJECT=user1/prague/prague.qgs.
You will see welcome screen with possibility to enter credential but
for now, you can just
Continue as guest.