Version 3.5.8

Released: April 15, 2021

Status: Stable

Changes

Dependencies

The Django version used was updated from version 2.2.19 to 2.2.20.

Workflows

The workflow state action to launch sub workflow was fixed.

The current workflow is now also excluded form the sub workflow launch state action selection form.

Removals

None

Upgrading process

Upgrading from Mayan EDMS 3.2.x or earlier

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

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
echo "requirepass mayanredispassword" | 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 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 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 amqp==5.2.0
```

Upgrading from Mayan EDMS 3.4.x or 3.3.x

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

Upgrade to the latest pip version:

sudo -u mayan /opt/mayan-edms/bin/pip install -U pip

Update the Redis configuration to enable password protection:

echo "requirepass mayanredispassword" | sudo tee -a /etc/redis/redis.conf
sudo systemctl restart redis

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.5.8
```
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=mayandbpass 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':'mayandbpass','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 and static media files with:

sudo -u mayan MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan \
MAYAN_DATABASE_PASSWORD=mayandbpass 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':'mayandbpass','USER':'mayan','HOST':'127.0.0.1'}}" \
 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.

Issues closed

None