Skip to content

Commit 331c764

Browse files
committed
Update README to introduce reference to stock viewer instead of demo viewer
1 parent 04d010a commit 331c764

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
[![](https://github.com/qwc-services/qwc-map-viewer/workflows/build/badge.svg)](https://github.com/qwc-services/qwc-map-viewer/actions)
2-
[![docker](https://img.shields.io/docker/v/sourcepole/qwc-map-viewer-demo?label=Docker%20image&sort=semver)](https://hub.docker.com/r/sourcepole/qwc-map-viewer-demo)
2+
[![docker](https://img.shields.io/docker/v/sourcepole/qwc-map-viewer?label=Docker%20image&sort=semver)](https://hub.docker.com/r/sourcepole/qwc-map-viewer)
33

44
QWC Map Viewer
55
==============
66

7-
Provide a [QWC2 Web Client](https://github.com/qgis/qwc2-demo-app) application using QWC services.
7+
Provide a [QWC2 Web Client](https://github.com/qgis/qwc2) application using QWC services.
88

99
**Note:** Requires a QWC OGC service or QGIS server running on `ogc_service_url`. Additional QWC Services are optional.
1010

1111

1212
Setup
13-
-----
13+
--------------------------
1414

15-
Copy your QWC2 files from a production build (see [QWC2 Quick start](https://github.com/qgis/qwc2-demo-app/blob/master/doc/src/quick_start.md)):
15+
Copy your QWC2 files from a production build:
1616

17-
SRCDIR=path/to/qwc2-app/prod/ DSTDIR=$PWD
17+
SRCDIR=path/to/qwc2/prod/ DSTDIR=$PWD
1818
mkdir $DSTDIR/qwc2 && mkdir $DSTDIR/qwc2/dist
1919
cd $SRCDIR && \
2020
cp -r assets $DSTDIR/qwc2 && \
@@ -109,11 +109,11 @@ Additional user info fields may be read from the JWT identity by setting `user_i
109109
```
110110
These will be added as `user_infos` in the `config.json` response if present in the current identity.
111111

112-
`qwc2_config` contains the QWC2 application configuration, with `config` corresponding to the contents of your standalone `config.json` file (see [Documentation](https://github.com/qgis/qwc2-demo-app/blob/master/doc/src/qwc_configuration.md#application-configuration-the-configjson-and-jsappconfigjs-files)).
112+
`qwc2_config` contains the QWC2 application configuration, with `config` corresponding to the contents of your standalone `config.json` file (see [Documentation](https://qwc-services.github.io/master/configuration/ViewerConfiguration/#load-time-configuration-configjson)).
113113

114114
`qwc2_themes` contains the full themes configuration, corresponding to the contents of your standalone `themes.json` collected from `themesConfig.json`.
115115

116-
Add new themes to your `themesConfig.json` (see [Documentation](https://github.com/qgis/qwc2-demo-app/blob/master/doc/src/qwc_configuration.md#theme-configuration-qgis-projects-and-the-themesconfigjson-file)) and put any theme thumbnails into `$QWC2_PATH/assets/img/mapthumbs/`.
116+
Add new themes to your `themesConfig.json` (see [Documentation](https://qwc-services.github.io/master/configuration/ThemesConfiguration/)) and put any theme thumbnails into `$QWC2_PATH/assets/img/mapthumbs/`.
117117
The `themesConfig.json` file is used to collect the full themes configuration using GetProjectSettings.
118118

119119
Optional settings for restricted themes:
@@ -245,22 +245,18 @@ Docker images
245245
-------------
246246

247247
The following Docker images are available:
248-
* `sourcepole/qwc-map-viewer-base`: Map viewer service
249-
* `sourcepole/qwc-map-viewer-demo`: Map viewer service with qwc-demo-app viewer
248+
* `sourcepole/qwc-map-viewer`: Map viewer service with stock qwc2 application
249+
* `sourcepole/qwc-map-viewer-base`: Map viewer service to use with a custom qwc2 application
250250

251251
Dependencies:
252252

253253
git repos Docker images
254254

255255
┌───────────────┐
256-
│ qwc2 │
257-
└───────┬───────┘
258-
│submodule
259-
┌───────▼───────┐
260-
│ qwc-demo-app ├────────────┐
261-
│ config.json│ CI Build │
256+
│ qwc2 ├────────────┐
257+
│ config.json │ CI Build │
262258
└───────────────┘ ┌─────▼───────────────┐
263-
┌──► qwc-map-viewer-demo
259+
┌──► qwc-map-viewer
264260
┌───────────────┐ │ └─────────────────────┘
265261
│ qwc-map-viewer├───┤
266262
└───────────────┘ │ ┌─────────────────────┐
@@ -289,9 +285,9 @@ Those services can be found under https://github.com/qwc-services/. The followin
289285

290286
**Step 3: Choose between a version of the qwc-map-viewer**
291287

292-
#### qwc-map-viewer-demo
288+
#### qwc-map-viewer
293289

294-
This is the demo version used in the `docker-compose-example.yml` file. With this version, the docker image comes with a preinstalled version of the latest qwc2-demo-app build and the python application for the viewer. Use this docker image, if you don't have your own build of the QWC2 app.
290+
This is the stock version used in the `docker-compose-example.yml` file. With this version, the docker image comes with a preinstalled version of the latest qwc2 stock application build and the python application for the viewer. Use this docker image, if you don't have your own build of the QWC2 app.
295291

296292
#### qwc-map-viewer-base
297293

0 commit comments

Comments
 (0)