Version 4.0.23¶
Released: November 13, 2022
Status: End of life
Changes¶
Cabinets¶
Ensure cabinet document is added using the correct method when using the upload wizard.
Docker¶
The Debian container was updated from tag 10.10-slim to 10.13-slim.
Docker images are no longer tagged latest
for minor releases. As per
Docker’s specification, the latest
tag is applied to the latest image
built if no tag is specified. It is not meant to represent the latest version
of an project, just the last image that has been built.
However users commonly (and mistakenly) have come to expect the latest
tag to represent the latest version of the project. The GitLab CI file was
updated to match this expectation.
Search¶
Add help text to the SEARCH_BACKEND_ARGUMENTS
setting.
Statistics¶
Fix statistic queue view navigation context.
Task manager¶
Display exception errors to console when Celery fails to initialize.
Other¶
Backport an object storage documentation chapter fix from version 4.4dev0.
Fixes from version 3.5.12.
Pin
importlib-metadata
to version 4.13.0 to workaround a dependency bug in Kombu.Update tox from version 3.14.6 to 3.27.0.
Removals¶
None
Upgrade process¶
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:
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.5
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¶
If you observe the errors:
mayan.apps.file_caching.models.CachePartitionFile.DoesNotExist: CachePartitionFile matching query does not exist.
or:
FileNotFoundError: [Errno 2] No such file or directory: '/var/lib/mayan/document_file_storage/...
follow the solution outlined in the troubleshooting section: After upgrade to version 4.0
Backward incompatible changes¶
None
Issues closed¶
GitLab issue #1118 [4.2.5] Event create and delete document in cabinet