Version 3.4.6

Released: April 19 2020

Changes

Common

Support was added for custom URL base paths. This allows services Mayan EDMS as a sub URL service. The new setting controlling this feature is named COMMON_URL_BASE_PATH.

Django

Django was updated to version 2.2.12.

Two Django settings were exposed using the setting system. These are: SESSION_COOKIE_NAME and SESSION_ENGINE. SESSION_COOKIE_NAME is relevant when serving multiple installations of Mayan EDMS under the same domain and SESSION_ENGINE is useful to improve performance in large installations.

Dependencies

The checkdependencies command was updated to mark missing production dependencies with a symbol and an ANSI coloration. This makes it easy to spot critical dependencies that may be missing and causing artifacts.

The --csv option was added to the checkdependencies command to output the result as comma delimited values.

Removals

None

Upgrading process

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

Upgrading from Mayan EDMS 3.2.x or earlier

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

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.3.1
```

Upgrading from Mayan EDMS 3.3.x

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.4.6
```
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.

Backward incompatible changes

None

Issues closed

None