Skip to content

Commit 5316d7d

Browse files
authored
Merge pull request #410 from MerginMaps/migration_to_2023.6.1
Update migration guide of CE 2023.6.1
2 parents e7937c9 + 55989bd commit 5316d7d

File tree

2 files changed

+114
-66
lines changed

2 files changed

+114
-66
lines changed

src/dev/ce-migration/index.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,53 @@
11
# Migration Guides
2+
3+
Migration guides are here to help you migrate to the latest version of our [<MainPlatformName /> Community Edition](../mergince/).
4+
5+
::: warning
6+
Migrations must be performed one by one and cannot be skipped.
7+
8+
Make sure to always back up your database data before doing a migration.
9+
:::
10+
211
[[toc]]
312

4-
Migration guides are here to help you migrate to the latest version of [<MainPlatformName /> Community Edition](../mergince/).
13+
## Migration guide from 2023.2.0+ to 2023.6.1
14+
15+
⚠️ If you are on a server version lower than `2023.2.0`, it is important to first [upgrade to `2023.2.0`](#migration-guide-from-any-previous-version-to-2023-2-0) before continuing with this migration.
16+
17+
-----
18+
19+
Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" /> or update docker images manually to version `2023.6.1`.
20+
Perform the migration:
21+
22+
1. Start up your docker containers
23+
```bash
24+
$ docker-compose -f docker-compose.yml up # or similarly, based on your deployment
25+
```
26+
27+
2. Check that you are on a correct version (`b6cb0a98ce20`)
28+
```bash
29+
$ docker exec merginmaps-server flask db current
30+
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
31+
INFO [alembic.runtime.migration] Will assume transactional DDL.
32+
b6cb0a98ce20 # <--- important
33+
```
34+
35+
- If you do not see the version number on the last line, run the following command:
36+
```bash
37+
$ docker exec merginmaps-server flask db stamp b6cb0a98ce20
38+
```
539

6-
## 2023.2.0 -> 2023.3.0
7-
Since there is no db migration or new config settings needed it is enough just to use new docker image tag.
40+
3. Run the database migration
41+
```bash
42+
$ docker exec merginmaps-server flask db upgrade 3a77058a2fd7
43+
```
844

9-
## Migration guide from any previous version to 2023.2
45+
## Migration guide from any previous version to 2023.2.0
1046

1147
Besides various fixes, enhancements and performance improvements the most notable change recently introduced is the concept of workspaces. For Community Edition it means there is a **common shared workspace (global workspace)** for all users where all projects are stored, instead of having a personal or organisational namespace for projects.
1248

1349
:::tip
14-
In case you do not need your previous data, we advise to start with [clean deployment](../mergince/#how-to-deploy-mergin-maps-ce) without the need to follow this migration guide.
50+
In case you do not need your previous data, we advise to start with [clean deployment](../mergince/#deployment) without the need to follow this migration guide.
1551
:::
1652

1753
**Upgrading to 2023.2**
@@ -44,7 +80,7 @@ Specify its name with the following environment variable:
4480
- `GLOBAL_WORKSPACE=ShinyWorkspace` - name of your workspace. A good fit is a name of your company or team. This value *should not be changed* later.
4581

4682
:::tip
47-
You can find all available environment variables [here](../mergince/#how-to-deploy-mergin-maps-ce) together with a tutorial how to set them up.
83+
You can find all available environment variables [here](../mergince/#deployment) together with a tutorial how to set them up.
4884
:::
4985

5086
Further, you need to set a default role for people in your workspace. **Pick one** of these options
@@ -63,7 +99,7 @@ You can specify the maximum storage for your shiny new workspace 🌟 with the f
6399
New users can be created from <MainPlatformName /> administration panel, by navigating to `<your_url>/admin`.
64100
:::
65101

66-
1. Make sure projects volume mounts in `docker-compose` file still match (You can set up new volumes by following the [quick start guide](../mergince/#how-to-deploy-mergin-maps-ce)). Switch to new server version and PostgreSQL to at least version 12 (14 recommended) by running new docker containers:
102+
1. Make sure projects volume mounts in `docker-compose` file still match (You can set up new volumes by following the [quick start guide](../mergince/#deployment)). Switch to new server version and PostgreSQL to at least version 12 (14 recommended) by running new docker containers:
67103
```bash
68104
$ docker-compose -f docker-compose.yml up
69105
```

0 commit comments

Comments
 (0)