Upgrade a Seafile cluster¶

Major and minor version upgrade¶

Seafile adds new features in major and minor versions. It is likely that some database tables need to be modified or the search index need to be updated. In general, upgrading a cluster contains the following steps:

Upgrade the database
Update symbolic link at frontend and backend nodes to point to the newest version
Update configuration files at each node
Update search index in the backend node

In general, to upgrade a cluster, you need:

Run the upgrade script (for example, ./upgrade/upgrade_4_0_4_1.sh) in one frontend node
Run the minor upgrade script (./upgrade/minor_upgrade.sh) in all other nodes to update symbolic link
Update configuration files at each node according to the documentation for each version
Delete old search index in the backend node if needed

Maintanence upgrade¶

Doing maintanence upgrading is simple, you only need to run the script ./upgrade/minor_upgrade.sh at each node to update the symbolic link.

Specific instructions for each version¶

From 7.0 to 7.1¶

In the background node, Seahub no longer need to be started. Nginx is not needed too.

The way of how office converter work is changed. The Seahub in front end nodes directly access a service in background node.

For front-end nodes¶

seahub_settings.py

OFFICE_CONVERTOR_ROOT = 'http://<ip of node background>'
⬇️
OFFICE_CONVERTOR_ROOT = 'http://<ip of node background>:6000'

seafevents.conf

[OFFICE CONVERTER]
enabled = true
workers = 1
max-size = 10

⬇️
[OFFICE CONVERTER]
enabled = true
workers = 1
max-size = 10
host = <ip of node background>
port = 6000

For backend node¶

seahub_settings.py is not needed. But you can leave it unchanged.

seafevents.conf

[OFFICE CONVERTER]
enabled = true
workers = 1
max-size = 10

⬇️
[OFFICE CONVERTER]
enabled = true
workers = 1
max-size = 10
host = <ip of node background>
port = 6000

From 6.3 to 7.0¶

No special upgrade operations.

From 6.2 to 6.3¶

In version 6.2.11, the included Django was upgraded. The memcached configuration needed to be upgraded if you were using a cluster. If you upgrade from a version below 6.1.11, don't forget to change your memcache configuration. If the configuration in your seahub_settings.py is:

CACHES = {
    'default': {
        'BACKEND': 'django_pylibmc.memcached.PyLibMCCache',
        'LOCATION': '<MEMCACHED SERVER IP>:11211',
    }
}

COMPRESS_CACHE_BACKEND = 'django.core.cache.backends.locmem.LocMemCache'

Now you need to change to:

CACHES = {
    'default': {
        'BACKEND': 'django_pylibmc.memcached.PyLibMCCache',
        'LOCATION': '<MEMCACHED SERVER IP>:11211',
    },
    'locmem': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
    },
}
COMPRESS_CACHE_BACKEND = 'locmem'

From 6.1 to 6.2¶

No special upgrade operations.

From 6.0 to 6.1¶

In version 6.1, we upgraded the included ElasticSearch server. The old server listen on port 9500, new server listen on port 9200. Please change your firewall settings.

From 5.1 to 6.0¶

In version 6.0, the folder download mechanism has been updated. This requires that, in a cluster deployment, seafile-data/httptemp folder must be in an NFS share. You can make this folder a symlink to the NFS share.

cd /data/haiwen/
ln -s /nfs-share/seafile-httptemp seafile-data/httptemp

The httptemp folder only contains temp files for downloading/uploading file on web UI. So there is no reliability requirement for the NFS share. You can export it from any node in the cluster.

From v5.0 to v5.1¶

Because Django is upgraded to 1.8, the COMPRESS_CACHE_BACKEND should be changed

   -    COMPRESS_CACHE_BACKEND = 'locmem://'
   +    COMPRESS_CACHE_BACKEND = 'django.core.cache.backends.locmem.LocMemCache'

From v4.4 to v5.0¶

v5.0 introduces some database schema change, and all configuration files (ccnet.conf, seafile.conf, seafevents.conf, seahub_settings.py) are moved to a central config directory.

Perform the following steps to upgrade:

Run the upgrade script at one fronend node to upgrade the database.

./upgrade/upgrade_4.4_5.0.sh

Then, on all other frontend nodes and the background node, run the upgrade script with SEAFILE_SKIP_DB_UPGRADE environmental variable turned on:

SEAFILE_SKIP_DB_UPGRADE=1 ./upgrade/upgrade_4.4_5.0.sh

After the upgrade, you should see the configuration files has been moved to the conf/ folder.

conf/
  |__ ccnet.conf
  |__ seafile.conf
  |__ seafevent.conf
  |__ seafdav.conf
  |__ seahub_settings.conf

From v4.3 to v4.4¶

There are no database and search index upgrade from v4.3 to v4.4. Perform the following steps to upgrade:

Run the minor upgrade script at frontend and backend nodes

From v4.2 to v4.3¶

v4.3 contains no database table change from v4.2. But the old search index will be deleted and regenerated.

A new option COMPRESS_CACHE_BACKEND = 'django.core.cache.backends.locmem.LocMemCache' should be added to seahub_settings.py

The secret key in seahub_settings.py need to be regenerated, the old secret key lack enough randomness.

Perform the following steps to upgrade:

Run the upgrade script at one fronend node to modify the seahub_settings.py
Modify seahub_settings.py at each node, replacing the old secret key with the new one and add option COMPRESS_CACHE_BACKEND
Run the minor upgrade script at frontend and backend nodes
Delete the old search index (the folder pro-data/search) at the backend node
Delete the old office preview output folder (/tmp/seafile-office-output) at the backend node