Version 4.2.15¶

Released: April 14, 2023

Status: Maintenance

Changes¶

This version includes fixes and merges from version 4.1.12.

CD/CI¶

Local config values are not to be included in the Mayan app settings. Local config values are meant to override CI/CD and test settings, and not meant to be committed as permanent to the repository.

Improve the CD deployment stages. Long setting versions are now used for clarity. Existing Docker volumes are now cleaned up using the official method. Images are always pulled to ensure the latest copy is used even if the image has the same tag as the remote such as when building test images.

Sources¶

Fix sources app migration 0027 backend mapping paths.

Other¶

Include bug fixes and updates from version 4.0.24.

Removals¶

None

Upgrade process¶

Important

If using a direct deployment, Supervisord must be upgraded to version 4.2.2. See troubleshooting section: After upgrade to version 4.1

Docker Compose¶

Check the Docker upgrading chapter for the complete upgrade process.

Direct deployment¶

Upgrading from Mayan EDMS 3.5.x¶

Important

Supervisord must be upgraded to version 4.2.2. See troubleshooting section: After upgrade to version 4.1

Stop supervisord:
```
sudo systemctl stop supervisor
```

Make a backup of your supervisord file:

sudo cp /etc/supervisor/conf.d/mayan-edms.conf /etc/supervisor/conf.d/mayan-edms.conf.bck

Make a backup of your database:

Use the respective backup command for the database:
- PostgreSQL: https://www.postgresql.org/docs/current/backup-dump.html
- MySQL: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html

Upgrade to the latest pip version:

sudo --user=mayan /opt/mayan-edms/bin/pip install --upgrade pip

Remove deprecated requirements:

sudo --user=mayan curl https://gitlab.com/mayan-edms/mayan-edms/raw/master/removals.txt --output /tmp/removals.txt \
&& sudo --user=mayan /opt/mayan-edms/bin/pip uninstall --requirement /tmp/removals.txt --yes

Update the Mayan EDMS Python package:
```
sudo --user=mayan /opt/mayan-edms/bin/pip install mayan-edms==4.4.7
```
the requirements will also be updated automatically.
Update the Redis configuration to serve at least 3 databases:

Replace:
```
databases ...
```
with:
```
databases 3
```
Restart Redis for the changes to take effect:
```
sudo systemctl restart redis
```

Edit the config file at /opt/mayan-edms/media/config.yml:

Replace:

LOCK_MANAGER_BACKEND: ...
LOCK_MANAGER_BACKEND_ARGUMENTS: ...

with:

LOCK_MANAGER_BACKEND: mayan.apps.lock_manager.backends.redis_lock.RedisLock
LOCK_MANAGER_BACKEND_ARGUMENTS: {'redis_url':'redis://:mayanredispassword@<IP address of Redis server>:6379/2'}

Update the supervisord configuration file. Replace the environment variables values shown here with your respective settings. This step will refresh the supervisord configuration file with the new queues and the latest recommended layout:
```
sudo --user=mayan MAYAN_MEDIA_ROOT=/opt/mayan-edms/media/ \
/opt/mayan-edms/bin/mayan-edms.py platformtemplate supervisord | sudo sh -c "cat > /etc/supervisor/conf.d/mayan-edms.conf"
```
Edit the supervisord configuration file and update any setting specific to your installation:
```
sudo vi /etc/supervisor/conf.d/mayan-edms.conf
```

Migrate existing database schema and static media files with:

sudo --user=mayan MAYAN_MEDIA_ROOT=/opt/mayan-edms/media/ \
/opt/mayan-edms/bin/mayan-edms.py performupgrade

Start supervisord:
```
sudo systemctl start supervisor
```
Clear the browser cache to avoid loading old web assets.

The upgrade procedure is now complete.

Troubleshooting¶

Follow the solutions outlined in the troubleshooting section: After upgrade to version 4.1

Backward incompatible changes¶

None

Issues closed¶

None