Upgrading Weblate

Docker image upgrades

The official Docker image (see Installing using Docker) has all upgrade steps integrated. There are no manual step besides pulling latest version.

Generic upgrade instructions

Before upgrading, please check the current Software requirements as they might have changed. Once all requirements are installed or updated, please adjust your settings.py to match changes in the configuration (consult settings_example.py for correct values).

Always check Version specific instructions before upgrade. In case you are skipping some versions, please follow instructions for all versions you are skipping in the upgrade. Sometimes it’s better to upgrade to some intermediate version to ensure a smooth migration. Upgrading across multiple releases should work, but is not as well tested as single version upgrades.

Note

It is recommended to perform a full database backup prior to upgrade so that you can roll back the database in case upgrade fails, see Backing up and moving Weblate.

  1. Upgrade configuration file, refer to settings_example.py or Version specific instructions for needed steps.

  2. Upgrade database structure:

    ./manage.py migrate --noinput
    
  3. Collect updated static files (mostly javascript and CSS):

    ./manage.py collectstatic --noinput
    
  4. Update language definitions (this is not necessary, but heavily recommended):

    ./manage.py setuplang
    
  5. Optionally upgrade default set of privileges definitions (you might want to add new permissions manually if you have heavily tweaked access control):

    ./manage.py setupgroups
    
  6. If you are running version from Git, you should also regenerate locale files every time you are upgrading. You can do this by invoking:

    ./manage.py compilemessages
    
  7. Verify that your setup is sane (see also Production setup):

    ./manage.py check --deploy
    
  8. Restart celery worker (see Background tasks using Celery).

Version specific instructions

Upgrade from 2.x

If you are upgrading from 2.x release, always first upgrade to 3.0.1 and the continue upgrading in the 3.x series. Upgrades skipping this step are not supported and will break.

Upgrade from 3.0.1 to 3.1

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • Several no longer needed applications have been removed from INSTALLED_APPS.
  • The settings now recommend using several Django security features, see SSL/HTTPS.
  • There is new dependency on the jellyfish module.

Upgrade from 3.1 to 3.2

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • Rate limiting configuration has been changed, please see Rate limiting.
  • Microsoft Terminology machine translation was moved to separate module and now requires zeep module.
  • Weblate now uses Celery for several background tasks. There are new dependencies and settings because of this. You should also run Celery worker as standalone process. See Background tasks using Celery for more information.
  • There are several changes in settings_example.py, most notable Celery configuration and middleware changes, please adjust your settings accordingly.

Upgrade from 3.2 to 3.3

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • The DEFAULT_CUSTOM_ACL settings was replaced by DEFAULT_ACCESS_CONTROL. If you were using that please update your settings.py.
  • Increase required translate-toolkit version to 2.3.1.
  • Increase required social auth module versions (2.0.0 for social-auth-core and 3.0.0 for social-auth-app-django).
  • The CELERY_RESULT_BACKEND should be now configured unless you are using eager mode, see Configuration and defaults.
  • There is new weblate.middleware.ProxyMiddleware middleware needed if you use IP_BEHIND_REVERSE_PROXY.

Upgrade from 3.3 to 3.4

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • The Celery now uses multiple queues, it is recommended to update to new worker setup which utilizes this, see Background tasks using Celery.
  • There is new depedency on diff-match-patch and translation-finder.

Upgrade from 3.4 to 3.5

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • There are several new checks included in the CHECK_LIST.

Upgrade from 3.5 to 3.6

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • The automatic detection of file format has been removed. Please adjust your translation components configuration prior to upgrade. The upgrade should be able to gracefully handle most of situations, but can fail in some corner cases.
  • If you have manually changed WEBLATE_FORMATS, you will have to remove AutoFormat from it.
  • During the upgrade, the notifications settings need to be converted. This can be lengthty operation in case you have lot of users.

Upgrade from 3.6 to 3.7

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • The Celery now uses separate queue for notifications, it is recommended to update to new worker setup which utilizes this, see Background tasks using Celery.
  • There are new (bleach, gobject, pycairo) and updated (translation-finder) dependencies, you will now need Pango and Cairo system libraries as well, see Pango and Cairo.
  • There are new addons, you might want to include them in case you modified the WEBLATE_ADDONS.
  • There are new file formats, you might want to include them in case you modified the WEBLATE_FORMATS.
  • There is change in the CSRF_FAILURE_VIEW.
  • There is new app weblate.fonts to be included in INSTALLED_APPS.

Upgrade from 3.7 to 3.8

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • There is new app django.contrib.humanize to be included in INSTALLED_APPS.

Upgrade from 3.8 to 3.9

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • There are several new checks included in the CHECK_LIST.
  • There are several updated and new dependencies.
  • Sentry is now supported through modern Sentry SDK instead of Raven, please adjust your configuration to use new SENTRY_DSN.
  • There are new addons, you might want to include them in case you modified the WEBLATE_ADDONS.
  • The Celery now uses separate queue for backups, it is recommended to update to new worker setup which utilizes this, see Background tasks using Celery.

Upgrade from 3.9 to 3.10

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

  • The database migration can take long on bigger installations.
  • There is new dependency on the misaka and GitPython modules.

Upgrading from Python 2 to Python 3

Note

Weblate will support Python 2 util 4.0 release currently scheduled on April 2020. This is in line with Django dropping support for Python 2.

Weblate currently supports both Python 2.7 and 3.x. Upgrading existing installations is supported, but you should pay attention to some data stored on the disk as it might be incompatible between these two.

Things which might be problematic include Whoosh indices and file based caches. Fortunately these are easy to handle. Recommended upgrade steps:

  1. Backup your Translation Memory using dump_memory:

    ./manage.py dump_memory > memory.json
    
  2. Upgrade your installation to Python 3.

  3. Delete Translation Memory database delete_memory:

    ./manage.py delete_memory --all
    
  4. Restore your Translation Memory using import_memory.

    ./manage.py import_memory memory.json
    
  5. Recreate fulltext index using rebuild_index:

    ./manage.py rebuild_index --clean --all
    
  6. Cleanup avatar cache (if using file based) using cleanup_avatar_cache.

    ./manage.py cleanup_avatar_cache
    
  7. It is recommended to throw away your caches.

Migrating from other databases to PostgreSQL

If you are running Weblate on other dabatase than PostgreSQL, you should migrate to PostgreSQL as that will be the only supported database backend in the 4.0 release. The following steps will guide you in migrating your data between the databases. Please remember to stop both web and Celery servers prior to the migration, otherwise you might end up with inconsistent data.

Creating a database in PostgreSQL

It is usually a good idea to run Weblate in a separate database, and separate user account:

# If PostgreSQL was not installed before, set the master password
sudo -u postgres psql postgres -c "\password postgres"

# Create a database user called "weblate"
sudo -u postgres createuser -D -P weblate

# Create the database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

Configuring Weblate to use PostgreSQL

Add PostgeSQL as additional database connection to the settings.py:

DATABASES = {
    'default': {
        # Database engine
        'ENGINE': 'django.db.backends.mysql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
        # Additional database options
        'OPTIONS': {
            # In case of using an older MySQL server, which has MyISAM as a default storage
            # 'init_command': 'SET storage_engine=INNODB',
            # Uncomment for MySQL older than 5.7:
            # 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            # If your server supports it, see the Unicode issues above
           'charset': 'utf8mb4',
           # Change connection timeout in case you get MySQL gone away error:
           'connect_timeout': 28800,
        }
    },
    'postgresql': {
        # Database engine
        'ENGINE': 'django.db.backends.postgresql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
    }
}

Create empty tables in the PostgreSQL

Run migrations and drop any data inserted into the tables:

python manage.py migrate --database=postgresql
python manage.py sqlflush --database=postgresql | psql

Dump legacy database and import to PostgreSQL

python manage.py dumpdata --all --output weblate.json
python manage.py loaddata weblate.json --database=postgresql

Adjust configuration

Adjust DATABASES to use just PostgreSQL database as default, remove legacy connection.

Weblate should be now ready to run from the PostgreSQL database.

Migrating from Pootle

As Weblate was originally written as replacement from Pootle, it is supported to migrate user accounts from Pootle. You can dump the users from Pootle and import them using importusers.