Version 3.3.9

Released: January 18, 2020

Changes

Documents

The way the default value for the language field of the Document model is set, was updated to avoid triggering a new migrations when changing the default language for documents.

Lock manager

The way the default value for the timeout field of the Lock model is set, was updated to avoid triggering a new migrations when changing the default timeout for locks.

Source code

Some helper scripts were moved to the contrib/scripts folder.

Testing

Two makefile targets were added to make it easier to create the code coverage report.

The Magnum and Travis CI files and setting modules are no longer used and were removed.

A makefile target was added to allow running GitLab CI jobs locally.

GitLab CI jobs were added to test the upgrade process from the current releases to newest version being built.

Removals

Magnum CI configuration files.
Travis CI configuration files.

Upgrading process

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

Upgrading from Mayan EDMS 3.2.x

Update the Redis configuration:

Configure Redis to discard data when it runs out of memory, not save its database, and only keep 2 database:

echo "maxmemory-policy allkeys-lru" | sudo tee -a /etc/redis/redis.conf
echo "save \"\"" | sudo tee -a /etc/redis/redis.conf
echo "databases 2" | sudo tee -a /etc/redis/redis.conf
sudo systemctl restart redis

Install the Python 3 development OS package:
```
sudo apt-get install python3-dev
```

Update the virtualenv to use Python 3:

sudo -u mayan virtualenv --clear /opt/mayan-edms -p /usr/bin/python3

Create a home directory for the Mayan EDMS system user:
```
mkdir /home/mayan
```
Grant ownership to the Mayan EDMS system user:
```
chown mayan:mayan /home/mayan
```

Reinstall the Python client for PostgreSQL and Redis:

sudo -u mayan /opt/mayan-edms/bin/pip install --no-use-pep517 psycopg2==3.2.3 redis==5.2.0

Note

Platforms with the ARM CPU might also need additional requirements:

sudo -u mayan /opt/mayan-edms/bin/pip install --no-use-pep517 psutil==5.8.0

Reinstall the Python client for RabbitMQ if you are using RabbitMQ as a broker:

sudo -u mayan /opt/mayan-edms/bin/pip install --no-use-pep517 amqp==5.3.1

Upgrade steps from any previous version of Mayan EDMS

Remove deprecated requirements:

sudo -u mayan curl https://gitlab.com/mayan-edms/mayan-edms/raw/master/removals.txt -o /tmp/removals.txt \
&& sudo -u mayan /opt/mayan-edms/bin/pip uninstall -y -r /tmp/removals.txt

Update the Mayan EDMS Python package:
```
sudo -u mayan /opt/mayan-edms/bin/pip install mayan-edms==3.3.9
```
the requirements will also be updated automatically.

Make a backup of your supervisord file:

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

Update the supervisord configuration file. Replace the environment variables values show here with your respective settings. This step will refresh the supervisord configuration file with the new queues and the latest recommended layout:

sudo -u mayan MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan \
MAYAN_DATABASE_PASSWORD=mayanuserpass MAYAN_DATABASE_USER=mayan \
MAYAN_DATABASE_HOST=127.0.0.1 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"

or:

sudo -u mayan MAYAN_DATABASES=\"{'default':{'ENGINE':'django.db.backends.postgresql','NAME':'mayan','PASSWORD':'mayanuserpass','USER':'mayan','HOST':'127.0.0.1'}}\" \
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 with:

sudo -u mayan MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan \
MAYAN_DATABASE_PASSWORD=mayanuserpass MAYAN_DATABASE_USER=mayan \
MAYAN_DATABASE_HOST=127.0.0.1 MAYAN_MEDIA_ROOT=/opt/mayan-edms/media/ \
/opt/mayan-edms/bin/mayan-edms.py performupgrade

or:

 sudo -u mayan MAYAN_DATABASES="{'default':{'ENGINE':'django.db.backends.postgresql','NAME':'mayan','PASSWORD':'mayanuserpass','USER':'mayan','HOST':'127.0.0.1'}}" \
 MAYAN_MEDIA_ROOT=/opt/mayan-edms/media/ \
/opt/mayan-edms/bin/mayan-edms.py performupgrade

Add new static media:

sudo -u mayan MAYAN_MEDIA_ROOT=/opt/mayan-edms/media/ \
/opt/mayan-edms/bin/mayan-edms.py preparestatic --noinput

Start supervisord:
```
sudo systemctl start supervisor
```

The upgrade procedure is now complete.

Backward incompatible changes

None

Bugs fixed or issues closed

GitLab issue #759 Permissions list does not show an object until one has been created