Skip to content

Commit

Permalink
Merge pull request #410 from MerginMaps/migration_to_2023.6.1
Browse files Browse the repository at this point in the history
Update migration guide of CE 2023.6.1
  • Loading branch information
varmar05 authored Jan 10, 2024
2 parents e7937c9 + 55989bd commit 5316d7d
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 66 deletions.
50 changes: 43 additions & 7 deletions src/dev/ce-migration/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,53 @@
# Migration Guides

Migration guides are here to help you migrate to the latest version of our [<MainPlatformName /> Community Edition](../mergince/).

::: warning
Migrations must be performed one by one and cannot be skipped.

Make sure to always back up your database data before doing a migration.
:::

[[toc]]

Migration guides are here to help you migrate to the latest version of [<MainPlatformName /> Community Edition](../mergince/).
## Migration guide from 2023.2.0+ to 2023.6.1

⚠️ 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.

-----

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`.
Perform the migration:

1. Start up your docker containers
```bash
$ docker-compose -f docker-compose.yml up # or similarly, based on your deployment
```

2. Check that you are on a correct version (`b6cb0a98ce20`)
```bash
$ docker exec merginmaps-server flask db current
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
b6cb0a98ce20 # <--- important
```

- If you do not see the version number on the last line, run the following command:
```bash
$ docker exec merginmaps-server flask db stamp b6cb0a98ce20
```

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

## Migration guide from any previous version to 2023.2
## Migration guide from any previous version to 2023.2.0

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.

:::tip
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.
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.
:::

**Upgrading to 2023.2**
Expand Down Expand Up @@ -44,7 +80,7 @@ Specify its name with the following environment variable:
- `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.

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

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

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:
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:
```bash
$ docker-compose -f docker-compose.yml up
```
Expand Down
Loading

0 comments on commit 5316d7d

Please sign in to comment.