Upgrading

Upgrading a Mayan EDMS Docker container is actually a matter of stopping and deleting the container, downloading the most recent version of the image and starting a container again. The container will take care of updating the database structure to the newest version if necessary.

Important

If upgrading between multiple versions, it is recommended to follow a sequential upgrade path rather than attempting to upgrade directly to the latest release. Start by upgrading to the latest bug version of the previous series before proceeding to the next major version.

Important

Do not delete the volume storing the data, only the container. Deleting the volume will delete all the document files.

Docker Compose installation

Upgrade between minor versions

Stop and delete the container stack:

Important

Do not skip this step. If the stack is not taken down, important internal upgrades processes like database migrations will not be executed.
```
docker compose down
```

Rename the Docker Compose file and keep it for future reference:

mv docker-compose.yml docker-compose.yml.bck
mv .env .env.bck

Download the new Docker Compose files:

curl https://gitlab.com/mayan-edms/mayan-edms/-/raw/master/docker/docker-compose.yml -O
curl https://gitlab.com/mayan-edms/mayan-edms/-/raw/master/docker/.env -O

Edit and the adjust the new Docker Compose and .env files, copying over all relevant values like username, password, etc.
Pull the new image version:
```
docker compose pull
```
Launch the rest of container stack:
```
docker compose up --detach
```
Note

The app container will perform all the necessary migrations to the existing data.

Upgrade between major versions

Note

Upgrade between major versions might vary for each version. Consult the release note for the specifics of upgrading major versions.