Warning
Backup database and other imporant data (e.g., configuration) before upgrade!
In case of using Docker, just use the tag in :ref:`docker-compose.yml` or pull the new Docker image and restart using down/up:
$ docker pull datastewardshipwizard/wizard-server
$ docker pull datastewardshipwizard/wizard-client
$ docker pull datastewardshipwizard/document-worker
$ docker-compose down
$ docker-compose up -d
All you need to do is download or checkout new version from our repositories and rebuild the application (according to guidelines above):
$ git checkout vX.Y.Z
If you need to upgrade MongoDB version, follow the official instructions in their documentation.
Usually, nothing special is required for upgrade. Internal structure changes are migrated automatically using DB migrations and Metamodel migrations (since 1.8.0). See below the changes that needs to be done by you (since 1.10.0):
- To unify configuration, document-worker now supports and prefers YAML configuration files.
- Local/custom
template.json
files must be updated (renamed allowedKMs to allowedPackages, and several new attributes:description
for template andshortName
+color
for each format) - see the example :ref:`config-dmptemplates-json`.
(nothing)
- Configuration of client and several features is now moved from
application.yml
file to in-app :ref:`config-settings`; therefore, it must be reconfigured during upgrade process. Additionalsecret
must be configured inapplication.yml
for encryption and JWT tokens (JWT.secret section has been removed), see :ref:`config-server` configuration. It is recommended to first add general.secret (32 chars secret), start DSW, migrate options fromapplication.yml
to :ref:`config-settings` and then optionally clean upapplication.yml
file. - User fiels
name
andsurname
has been renamed tofirstName
andlastName
- it needs be updated if used in custom mail or document templates. - Recommended version of MongoDB is updated to 4.2.3.
- There is a significant change related to new Document Worker that handles generation of documents from templates and filled questionnaires. You need to run RabbitMQ and document-worker with correct configuration according to server, see :ref:`docker-compose.yml` and :ref:`configuration` for details.
- Changing the major version actually does not mean any problem in migration, it has been made due to significant internal changes (restructuring, new repositories, etc.)
- If you are using Docker for running DSW, you need to change it according to new documentation of :ref:`docker-compose.yml` and :ref:`configuration`.
- Crontab image is no longer needed, see :ref:`config-feedback-sync`.
- A DMP template configuration file must contain list of
allowedKMs
(see the default root template).
- Custom DMP templates needs to be upgraded to a new structure (see the default root template).
Important
DS Wizard components (server, client, document worker, registry) should always use matching version (compatibility is assured)!
The DS Wizard is compatible with all recent versions of web browsers Chrome, Opera, Firefox, and Edge. We do not recomment use of Internet Explorer. Internally, there are components between is are following compatibility of versions:
DS Wizard | KM Metamodel | Registry |
---|---|---|
2.4.0 | 5 | 2.4.0 |
2.3.0 | 5 | 2.3.0 |
2.2.0 | 5 | 2.2.0 |
2.1.0 | 5 | 2.1.0 |
2.0.0 | 5 | 2.0.0 |
1.10.0 | 4 | 1.2.0 |
1.9.0 | 3 | 1.1.0 |
1.8.0 | 3 | 1.0.0 |
1.7.0 | 2 | -- |
1.6.0 | 1 | -- |
1.5.0 (or lower) | -- | -- |