Skip to content

Commit 35233f1

Browse files
committed
Rework upgrade. Address remarks for #586
1 parent 8172410 commit 35233f1

3 files changed

Lines changed: 30 additions & 21 deletions

File tree

src/server/environment/index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Other settings related to data management.
116116
| `DELETED_PROJECT_EXPIRATION` | integer | `7` | Lifetime in days for deleted projects. Expired projects are removed permanently without possibility to restore afterwards. |
117117
| `PROJECT_ACCESS_REQUEST` | integer | `604800` | Lifetime of active project access request in seconds. |
118118
| `TEMP_EXPIRATION` | integer | `7` | Time in days after files in a temporary folder are permanently deleted. |
119-
119+
120120

121121
#### Celery asynchronous tasks
122122
Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing regular jobs.
@@ -129,11 +129,8 @@ Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing reg
129129
#### WebMaps
130130
<ServerType type="EE" />
131131

132-
| Variable name | Type | Default | Description |
133-
|--------------------------|----------|---------------------------------------------------------|--------------------------------|
134-
| `MAPS_ENABLED` | boolean | `false` | Flag to enable webmaps |
135-
| `OVERVIEW_DATA` | string | `/data/overviews` | Folder to store overviews data |
136-
| `WMTS_SERVER_URL` | string | `http://mergin-qgis-nginx:80` | URL to qgis-server WMTS server |
137-
| `QGIS_EXTRACTOR_API_URL` | string | `http://mergin-qgis-extractor:8000` | URL for QGIS Extractor service |
138-
| `VECTOR_TILES_URL` | string | `https://tiles.merginmaps.com` | URL to custom tile service |
139-
| `VECTOR_TILES_STYLE_URL` | string | `https://tiles.dev.merginmaps.com/styles/default.json` | URL to custom tile style JSON |
132+
| Variable name | Type | Default | Description |
133+
|--------------------------|----------|-------------------------------|--------------------------------|
134+
| `MAPS_ENABLED` | boolean | `false` | Flag to enable webmaps |
135+
| `VECTOR_TILES_URL` | string | `` | URL to custom tile service |
136+
| `VECTOR_TILES_STYLE_URL` | string | `` | URL to custom tile style JSON |

src/server/install/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ Now tweak deployment settings by modifying environment variables. You have to fi
8989
<ServerType type="EE" />
9090

9191
WebMaps consists of three more services (`mergin-qgis`, `mergin-qgis-extractor` and `mergin-qgis-nginx`) that you can run alongside <MainPlatformName /> main stack or independently in a new machine.
92-
Just make sure related `MAPS_*` [environment variables](../environment/#WebMaps) are set, namely `MAPS_ENABLED` (`True` by default).
92+
Just make sure `MAPS_ENABLED` [environment variable](../environment/) is set to `True` (`False` by default) and `VECTOR_TILES_URL` as well `VECTOR_TILES_STYLE_URL` are set correctly to your target tile service.
9393
For convenience this stack is provided on a separate docker compose file, `docker-compose.maps.yml`.
9494

95-
To run the webmaps, simply run this command line:
95+
To run the webmaps stack, simply run this command line:
9696
```shell
9797
$ docker-compose -f docker-compose.maps.yml -d up
9898
```

src/server/upgrade/index.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
git# Upgrade
1+
# Upgrade
22

33
Migration guides are here to help you migrate your <CommunityPlatformNameLink /> or <EnterprisePlatformNameLink /> to the latest server version. The main Cloud <DashboardLink desc="Mergin Maps Server"/> is always migrated to latest version by <MainPlatformName /> team. Read more about server platforms in [overview article](../).
44

@@ -15,22 +15,35 @@ Make sure to always back up your database data before doing a migration.
1515

1616
<MigrationType type="EE" />
1717

18+
::: tip Changes on deployment behaviour
19+
Release 2025.3.x brings some changes on <MainPlatformName /> docker compose orchestration deployment procedure.
20+
Users are advised to clone the <GitHubRepo id="MerginMaps/server/blob/master/" desc="server repository" /> in order to proceed with the new deployment procedure.
21+
:::
22+
1823
Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" /> or update docker images manually to version `2025.3.0`.
1924
Perform the migration:
2025

21-
1. Stop your running docker containers and build the new images
26+
1. Stop your running docker containers
2227
```bash
23-
$ docker compose -f docker-compose.yml down # or similarly, based on your deployment
28+
$ docker compose -f docker-compose.yml down # or similarly, based on your previous deployment
2429
# INFO: After shutdown update the docker-compose.yml file to latest release
2530
```
26-
27-
2. Start up your docker containers
31+
2. If you didn't clone the <MainPlatformName /> github repository, do it now and locate yourself under `deployment/enterprise` folder
32+
```bash
33+
$ git clone git@github.com:MerginMaps/server.git # If you haven't cloned the repo yet
34+
$ cd server/deployment/enterprise
35+
```
36+
3. If you plan to use the new webmaps stacks, adapt your existing `.prod.env` and `docker-compose.yml` files. Move/copy them to the `enterprise` deployment folder
37+
```bash
38+
$ cp /some/path/.prod.env . # assuming you are located in `server/deployment/enterprise`
39+
$ cp /some/path/docker-compose.yml . # assuming you are located in `server/deployment/enterprise`
40+
```
41+
4. Start up your docker containers
2842
```bash
2943
$ docker compose -f docker-compose.yml -d up # or similarly, based on your deployment
30-
$ docker compose -f docker-compose.maps.yml -d up # If you want to deploy maps stack
44+
$ docker compose -f docker-compose.maps.yml -d up # If you want to deploy webmaps stack
3145
```
32-
33-
3. Check that you are on correct versions (`ba5051218de4`, `ba5ae5972c4a`).
46+
5. Check that you are on correct versions (`ba5051218de4`, `ba5ae5972c4a`).
3447
```bash
3548
$ docker exec merginmaps-server flask db current
3649
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
@@ -44,8 +57,7 @@ Perform the migration:
4457
$ docker exec merginmaps-server flask db stamp ba5051218de4
4558
$ docker exec merginmaps-server flask db stamp ba5ae5972c4a
4659
```
47-
48-
4. Run the database migration:
60+
6. Run the database migration:
4961
```bash
5062
$ docker exec merginmaps-server flask db upgrade community@5ad13be6f7ef
5163
$ docker exec merginmaps-server flask db upgrade enterprise@819e6b20ee93

0 commit comments

Comments
 (0)