You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/QuickStart.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Quick start
2
2
3
-
## Running QWC2 as part of qwc-services
3
+
## Running QWC as part of qwc-services
4
4
5
-
`qwc-services` is a collection of loosely coupled micro-services for extending QWC2. The services communicate with each other via HTTP/Rest, and are mostly written in Python.
5
+
`qwc-services` is a collection of loosely coupled micro-services for extending QWC. The services communicate with each other via HTTP/Rest, and are mostly written in Python.
6
6
7
7
The easiest way to run `qwc-services` is to use the readily available docker images, using the sample setup at [qwc-docker](https://github.com/qwc-services/qwc-docker).
8
8
@@ -57,11 +57,11 @@ Next steps:
57
57
-[Configuring the services](configuration/../configuration/ServiceConfiguration.md)
If you don't need the advanced functionalities provided by `qwc-services` or want to integrate QWC2 in another environment, you can run QWC2 as a standalone viewer.
62
+
If you don't need the advanced functionalities provided by `qwc-services` or want to integrate QWC in another environment, you can run QWC as a standalone viewer.
63
63
64
-
To work with QWC2, you will need a minimal development environment consisting of [git](https://git-scm.com/), [node](https://nodejs.org/) and [yarn](https://yarnpkg.com). You will also need a running QGIS Server instance which serves your projects.
64
+
To work with QWC, you will need a minimal development environment consisting of [git](https://git-scm.com/), [node](https://nodejs.org/) and [yarn](https://yarnpkg.com). You will also need a running QGIS Server instance which serves your projects.
65
65
66
66
The fastest way to get started is by cloning the stock application:
Copy file name to clipboardExpand all lines: src/configuration/ResourcesPermissions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ For more detailed [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_
40
40
41
41
The `viewer_task` resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted.
42
42
Their `name` (e.g. `RasterExport`) will be matched against:
43
-
- The `key` in `menuItems` and `toolbarItems` in the QWC2`config.json`.
43
+
- The `key` in `menuItems` and `toolbarItems` in the QWC`config.json`.
44
44
- The `name` of a plugin entry in `config.json`.
45
45
- The `task` configuration property of a `TaskButton` plugin entry in `config.json`
46
46
@@ -50,7 +50,7 @@ The `FeatureInfo service`, `FeatureInfo layer` and subordinate `Attribute` resou
50
50
51
51
Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the `config.json`.
52
52
53
-
*Note*: The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the `qwc_config.resource_types` table.
53
+
*Note*: The resource types, i.e. for custom QWC plugins, can be extended by inserting new types into the `qwc_config.resource_types` table.
54
54
These can be queried, e.g. in a custom service, by using `PermissionClient::resource_permissions()` or
55
55
`PermissionClient::resource_restrictions()` from [QWC Services Core](https://github.com/qwc-services/qwc-services-core).
@@ -18,24 +18,24 @@ Following is an overview of existing `qwc-services`:
18
18
19
19
**Applications**:
20
20
21
-
*[QWC2 Map Viewer](https://github.com/qwc-services/qwc-map-viewer): The map viewer application
21
+
*[QWC Map Viewer](https://github.com/qwc-services/qwc-map-viewer): The map viewer application
22
22
*[QWC Admin GUI](https://github.com/qwc-services/qwc-admin-gui): Configuration backend for managing users and permissions
23
23
*[Registration GUI](https://github.com/qwc-services/qwc-registration-gui): GUI for registration of new users
24
24
25
25
**REST services**:
26
26
27
27
*[DB auth service](https://github.com/qwc-services/qwc-db-auth): Authentication service with local user database
28
28
*[LDAP auth service](https://github.com/qwc-services/qwc-ldap-auth): LDAP Authentication service
29
-
*[Data service](https://github.com/qwc-services/qwc-data-service): Data edit service, required for QWC2 editing functionality
29
+
*[Data service](https://github.com/qwc-services/qwc-data-service): Data edit service, required for QWC editing functionality
30
30
*[Document service](https://github.com/qwc-services/qwc-document-service): Service for generating Jasper reports
31
-
*[Elevation service](https://github.com/qwc-services/qwc-elevation-service): Service for providing elevation data, required for QWC2 elevation profile
32
-
*[Feature info service](https://github.com/qwc-services/qwc-feature-info-service): Service for providing enhanced GetFeatureInfo responses to QWC2
33
-
*[Fulltext search service](https://github.com/qwc-services/qwc-fulltext-search-service): Fulltext search service for the QWC2 search functionality
34
-
*[Legend service](https://github.com/qwc-services/qwc-legend-service): Service for providing enhanced legend graphics to QWC2
35
-
*[Mapinfo service](https://github.com/qwc-services/qwc-mapinfo-service): Service for providing additional information to the QWC2 right-click map context popup
31
+
*[Elevation service](https://github.com/qwc-services/qwc-elevation-service): Service for providing elevation data, required for QWC elevation profile
32
+
*[Feature info service](https://github.com/qwc-services/qwc-feature-info-service): Service for providing enhanced GetFeatureInfo responses to QWC
33
+
*[Fulltext search service](https://github.com/qwc-services/qwc-fulltext-search-service): Fulltext search service for the QWC search functionality
34
+
*[Legend service](https://github.com/qwc-services/qwc-legend-service): Service for providing enhanced legend graphics to QWC
35
+
*[Mapinfo service](https://github.com/qwc-services/qwc-mapinfo-service): Service for providing additional information to the QWC right-click map context popup
36
36
*[OGC service](https://github.com/qwc-services/qwc-ogc-service): Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server
37
-
*[Permalink service](https://github.com/qwc-services/qwc-permalink-service): Service for storing compat permalinks and bookmarks generated by QWC2
38
-
*[Print service](https://github.com/qwc-services/qwc-print-service): Service for enhancing the QWC2 GetPrint requests
37
+
*[Permalink service](https://github.com/qwc-services/qwc-permalink-service): Service for storing compat permalinks and bookmarks generated by QWC
38
+
*[Print service](https://github.com/qwc-services/qwc-print-service): Service for enhancing the QWC GetPrint requests
39
39
40
40
**Configuration database**:
41
41
@@ -53,10 +53,10 @@ The layout of the `qwc-docker` tree is as follows:
Copy file name to clipboardExpand all lines: src/configuration/ThemesConfiguration.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@ A theme corresponds to a QGIS project, published as WMS and served by QGIS Serve
5
5
The basic steps for configuring a theme are:
6
6
7
7
-[Create a QGIS project and deploy it to QGIS Server](#create-qgis-project)
8
-
-[Writing the QWC2 theme configuration](#writing-themes-configuration)
8
+
-[Writing the QWC theme configuration](#writing-themes-configuration)
9
9
-[Generating the themes configuration](#generating-themes-configuration)
10
10
11
11
## Creating and publishing a QGIS project<aname="create-qgis-project"></a>
12
12
13
-
The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC2:
13
+
The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC:
@@ -27,7 +27,7 @@ The first step is to prepare a QGIS project for publishing. Besides the common t
27
27
| Rendering order | Layer Order Panel or Layers Panel | Rendering order of the layers. If layer re-ordering is enabled in `config.json`, the order from the Layer Order Panel is ignored. |
28
28
| Print layouts | Layout manager | The print layouts offered in the Print plugin. |
29
29
| Print layout labels | Layout manager | Print layout labels with an ID will be exposed in the Print plugin. Note: a label ID starting with `__` will not be exposed. |
30
-
| Attribute form | Vector Layer Properties → Attributes Form | The configured attribute form will be displayed when editing in QWC2. |
30
+
| Attribute form | Vector Layer Properties → Attributes Form | The configured attribute form will be displayed when editing in QWC. |
31
31
| External layers | Layer Properties → QGIS Server → Data URL | Mark the layer as an external layer to avoid cascaded requests. See [Configuring external layers](#external-layers). |
32
32
33
33
Then, store the project in the publishing directory of your QGIS Server instance. When using `qwc-docker`, store the project as `*.qgs` below `qwc-docker/volumes/qgs-resources`.
@@ -52,7 +52,7 @@ sslmode=disable
52
52
53
53
## Configuring the themes in `themesConfig.json` <aname="writing-themes-configuration"></a>
54
54
55
-
The next step is to configure the theme for QWC2. There are two approaches:
55
+
The next step is to configure the theme for QWC. There are two approaches:
56
56
57
57
-[Automatic theme configuration](#automatic-theme-configuration) (only when using `qwc-docker`): Just copy the project file to the designated location and the `qwc-config-generator` will automatically generate a theme configuration using default parameters.
58
58
-[Manual theme configuration](#manual-theme-configuration): Manually configure a theme with the full set of configuration options.
@@ -75,7 +75,7 @@ To use a custom thumbnail for an automatically configured theme, place a an imag
75
75
76
76
The theme configuration file is located as follows:
*Note*: when using `qwc-docker`, the themes configuration may also be embedded as `themesConfig` directly in `qwc-docker/volumes/config-in/<tentant>/tenantConfig.json`.
@@ -198,7 +198,7 @@ The format of the theme definitions is as follows:
198
198
|`"extraLegendParameters": "<&KEY=VALUE>",`| Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#getlegendgraphics) to append to GetLegendGraphic request. |
199
199
|`"extraDxfParameters": "<&KEY=VALUE>",`| Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html?highlight=dxf#format-options) to append to DXF export request. |
200
200
|`"extraPrintParameters": "<&KEY=VALUE>",`| Optional, additional query parameters to append to GetPrint request (requires QGIS Server >= 3.32.0). |
201
-
|`"extraPrintLayers": ["<layername>", ...],`| Optional, extra list of layers to mark as internal print layers, i.e. which are omitted from the QWC2 LayerTree. |
201
+
|`"extraPrintLayers": ["<layername>", ...],`| Optional, extra list of layers to mark as internal print layers, i.e. which are omitted from the QWC LayerTree. |
202
202
|`"printLabelBlacklist": ["<LabelId>", ...]`| Optional, list of composer label ids to not expose in the print dialog. |
203
203
|`"editConfig": {<editConfig>} `| Optional, object containing the editing configuration for the theme, see [Editing](../topics/Editing.md#edit-config). |
204
204
|`"snapping": {...},`| Optional, snapping configuration, see [Snapping](../topics/Snapping.md). |
@@ -239,7 +239,7 @@ A bare minimum theme entry might look as follows:
239
239
240
240
### External layers <aname="external-layers"></a>
241
241
242
-
External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC2 (they are positioned in the layer tree identically to the internal layer they replace), but the `GetMap` and `GetFeatureInfo` requests are sent directly to the specified WMS Service.
242
+
External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC (they are positioned in the layer tree identically to the internal layer they replace), but the `GetMap` and `GetFeatureInfo` requests are sent directly to the specified WMS Service.
243
243
244
244
**Configuring external layers via Data Url**
245
245
@@ -465,11 +465,11 @@ Instead of specifiying a full background layer definition in a group, you can al
465
465
466
466
## Generating the themes configuration <aname="generating-theme-configuration"></a>
467
467
468
-
The file ultimately read by the QWC2 viewer is the `themes.json` configuration, which includes the contents of `themesConfig.json` completed with additional data obtained from the QGIS Project.
468
+
The file ultimately read by the QWC viewer is the `themes.json` configuration, which includes the contents of `themesConfig.json` completed with additional data obtained from the QGIS Project.
469
469
470
470
* When using `qwc-docker`, you can generate the themes from the `qwc-admin-gui` administration backend, running on <http://localhost:8088/qwc_admin> by default. Log in as `admin` user, then press the green `Generate service configuration` button. This will invoce the`qwc-config-generator`, which will generate `mapViewerConfig.json` located below `qwc-docker/volumes/config/<tentant>`. You can then inspect the generated `themes.json` at <http://localhost:8088/themes.json>.
471
471
472
-
* When using QWC2 as a standalone viewer, the `themes.json` can be generated by invoking
472
+
* When using QWC as a standalone viewer, the `themes.json` can be generated by invoking
473
473
```bash
474
474
yarn run themesconfig
475
475
```
@@ -499,7 +499,7 @@ You can configure `qwc-docker` to look for `qgz` project files instead of `qgs`
499
499
500
500
## Split categorized layers
501
501
502
-
By default, symbol categories of a [classified](https://docs.qgis.org/latest/en/docs/training_manual/vector_classification/classification.html) layer won't be exposed via WMS and hence in QWC2.
502
+
By default, symbol categories of a [classified](https://docs.qgis.org/latest/en/docs/training_manual/vector_classification/classification.html) layer won't be exposed via WMS and hence in QWC.
503
503
504
504
To expose symbol categories as separate layers via WMS, you can use the [split_categorized](https://github.com/qwc-services/qwc-qgis-server-plugins/tree/main/split_categorized) QGIS Server plugin.
0 commit comments