Version 3.3.18

Released: March 13, 2021

Status: End of life

The purpose of this version is to help users migrating from version prior to series 3.3 and from custom version of the 3.3 series.

Changes

Dependencies

Updated the Transifex client to version 0.13.7. Version 0.13.6 appears to have been deleted, this caused the build scripts to stop.

Recent changes to the Cryptography library require the Rust language as a build time dependency unless a recent version of PIP is used. The build script will now use PIP version 21.0.1 to accomplish this.

File metadata

Migration 0003 of the File metadata was optimized to reduce time and memory usage.

GitLab CI

Improvements from more recent version were backported to allow this series to continue build.

Changes

Backport Makefile improvements.

Other

Update contributed LDAP setting file.

Removals

None

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.0.7

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.2.0

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.17
```
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
```
Clear the browser cache to avoid loading old web assets.

The upgrade procedure is now complete.

Backward incompatible changes

None

Issues closed

None