Upgrading Weblate

Docker image upgrades

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

See also

Upgrading the Docker container

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. Stop wsgi and Celery processes. The upgrade can perform incompatible changes in the database, so it is always safer to avoid old processes running while upgrading.

2. Upgrade Weblate code.

   For pip installs it can be achieved by:

   pip install -U "Weblate[all]==version"
   

   Or, if you just want to get the latest released version:

   pip install -U "Weblate[all]"
   

   If you don’t want to install all of the optional dependencies do:

   pip install -U Weblate
   

   With Git checkout you need to fetch new source code and update your installation:

   cd weblate-src
   git pull
   # Update Weblate inside your virtualenv
   . ~/weblate-env/bin/pip install -e '.[all]'
   # Install dependencies directly when not using virtualenv
   pip install --upgrade -r requirements.txt
   # Install optional dependencies directly when not using virtualenv
   pip install --upgrade -r requirements-optional.txt
   

3. New Weblate release might have new Optional dependencies, please check if they cover features you want.

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

5. Upgrade database structure:

   weblate migrate --noinput
   

6. Collect updated static files (see Running server and Serving static files):

   weblate collectstatic --noinput --clear
   

7. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

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

   weblate compilemessages
   

9. Verify that your setup is sane (see also Production setup):

   weblate check --deploy
   

10. 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 then continue upgrading in the 3.x series. Upgrades skipping this step are not supported and will break.

See also

Upgrade from 2.20 to 3.0 in Weblate 3.0 documentation

Upgrade from 3.x

If you are upgrading from 3.x release, always first upgrade to 4.0.4 or 4.1.1 and then continue upgrading in the 4.x series. Upgrades skipping this step are not supported and will break.

See also

Upgrade from 3.11 to 4.0 in Weblate 4.0 documentation

Upgrade from 4.0 to 4.1

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are several changes in settings_example.py, most notable middleware changes, please adjust your settings accordingly.

• There are new file formats, you might want to include them in case you modified the WEBLATE_FORMATS.

• There are new quality checks, you might want to include them in case you modified the CHECK_LIST.

• There is change in DEFAULT_THROTTLE_CLASSES setting to allow reporting of rate limiting in the API.

• There are some new and updated requirements.

• There is a change in INSTALLED_APPS.

• The MT_DEEPL_API_VERSION setting has been removed in Version 4.7. The DeepL machine translation now uses the new MT_DEEPL_API_URL instead. You might need to adjust MT_DEEPL_API_URL to match your subscription.

See also

Generic upgrade instructions

Upgrade from 4.1 to 4.2

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• Upgrade from 3.x releases is not longer supported, please upgrade to 4.0 or 4.1 first.

• There are some new and updated requirements.

• There are several changes in settings_example.py, most notable new middleware and changed application ordering.

• The keys for JSON based formats no longer include leading dot. The strings are adjusted during the database migration, but external components might need adjustment in case you rely on keys in exports or API.

• The Celery configuration was changed to no longer use memory queue. Please adjust your startup scripts and CELERY_TASK_ROUTES setting.

• The Weblate domain is now configured in the settings, see SITE_DOMAIN (or WEBLATE_SITE_DOMAIN). You will have to configure it before running Weblate.

• The username and email fields on user database now should be case insensitive unique. It was mistakenly not enforced with PostgreSQL.

See also

Generic upgrade instructions

Upgrade from 4.2 to 4.3

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are some changes in quality checks, you might want to include them in case you modified the CHECK_LIST.

• The source language attribute was moved from project to a component what is exposed in the API. You will need to update Weblate Client in case you are using it.

• The database migration to 4.3 might take long depending on number of strings you are translating (expect around one hour of migration time per 100,000 source strings).

• There is a change in INSTALLED_APPS.

• There is a new setting SESSION_COOKIE_AGE_AUTHENTICATED which complements SESSION_COOKIE_AGE.

• In case you were using hub or lab to integrate with GitHub or GitLab, you will need to reconfigure this, see GITHUB_CREDENTIALS and GITLAB_CREDENTIALS.

Changed in version 4.3.1:

• The Celery configuration was changed to add memory queue. Please adjust your startup scripts and CELERY_TASK_ROUTES setting.

Changed in version 4.3.2:

• The post_update method of add-ons now takes extra skip_push parameter.

See also

Generic upgrade instructions

Upgrade from 4.3 to 4.4

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There is a change in INSTALLED_APPS, weblate.configuration has to be added there.

• Django 3.1 is now required.

• In case you are using MySQL or MariaDB, the minimal required versions have increased, see MySQL and MariaDB.

Changed in version 4.4.1:

• Monolingual gettext now uses both msgid and msgctxt when present. This will change identification of translation strings in such files breaking links to Weblate extended data such as screenshots or review states. Please make sure you commit pending changes in such files prior upgrading and it is recommended to force loading of affected component using weblate loadpo.

• Increased minimal required version of translate-toolkit to address several file format issues.

See also

Generic upgrade instructions

Upgrade from 4.4 to 4.5

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• The migration might take considerable time if you had big glossaries.

• Glossaries are now stored as regular components.

• The glossary API is removed, use regular translation API to access glossaries.

• There is a change in INSTALLED_APPS - weblate.metrics should be added.

Changed in version 4.5.1:

• There is a new dependency on the pyahocorasick module.

See also

Generic upgrade instructions

Upgrade from 4.5 to 4.6

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are new file formats, you might want to include them in case you modified the WEBLATE_FORMATS.

• API for creating components now automatically uses Weblate internal URLs, see POST /api/projects/(string:project)/components/.

• There is a change in dependencies and PASSWORD_HASHERS to prefer Argon2 for passwords hashing.

See also

Generic upgrade instructions

Upgrade from 4.6 to 4.7

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are several changes in settings_example.py, most notable middleware changes (MIDDLEWARE), please adjust your settings accordingly.

• The DeepL machine translation now has a generic MT_DEEPL_API_URL setting to adapt to different subscription models more flexibly. The MT_DEEPL_API_VERSION setting is no longer used.

• Django 3.2 is now required.

See also

Generic upgrade instructions

Upgrade from 4.7 to 4.8

Please follow Generic upgrade instructions in order to perform update.

There are no additional upgrade steps needed in this release.

See also

Generic upgrade instructions

Upgrade from 4.8 to 4.9

Please follow Generic upgrade instructions in order to perform update.

• There is a change in storing metrics, the upgrade can take long time on larger sites.

See also

Generic upgrade instructions

Upgrade from 4.9 to 4.10

Please follow Generic upgrade instructions in order to perform update.

• There is a change in per-project groups, the upgrade can take long time on sites with thousands of projects.

• Django 4.0 has made some incompatible changes, see Backwards incompatible changes in 4.0. Weblate still supports Django 3.2 for now, in case any of these are problematic. Most notable changes which might affect Weblate:

  • Dropped support for PostgreSQL 9.6, Django 4.0 supports PostgreSQL 10 and higher.

  • Format of CSRF_TRUSTED_ORIGINS was changed.

• The Docker container now uses Django 4.0, see above for changes.

See also

Generic upgrade instructions

Upgrade from 4.10 to 4.11

Please follow Generic upgrade instructions in order to perform update.

• Weblate now requires Python 3.7 or newer.

• The implementation of Managing per-project access control has changed, removing the project prefix from the group names. This affects API users.

• Weblate now uses charset-normalizer instead of chardet module for character set detection.

• Changed in 4.11.1: There is a change in REST_FRAMEWORK setting (removal of one of the backends in DEFAULT_AUTHENTICATION_CLASSES).

See also

Generic upgrade instructions

Upgrade from 4.11 to 4.12

Please follow Generic upgrade instructions in order to perform update.

• There are no special steps required.

See also

Generic upgrade instructions

Upgrade from 4.12 to 4.13

Please follow Generic upgrade instructions in order to perform update.

• The Language definitions are now automatically updated on upgrade, use UPDATE_LANGUAGES to disable that.

• Handling of context and location has been changed for Windows RC files, HTML files, IDML Format, and Text files file formats. In most cases the context is now shown as location.

• The machine translation services are now configured using the user interface, settings from the configuration file will be imported during the database migration.

See also

Generic upgrade instructions

Upgrade from 4.13 to 4.14

Please follow Generic upgrade instructions in order to perform update.

• The Java formatting checks now match GNU gettext flags. The flags set in Weblate will be automatically migrated, but third-party scripts will need to use java-printf-format instead of java-format and java-format instead of java-messageformat.

• The jellyfish dependency has been replaced by rapidfuzz.

• Changed in 4.14.2: Deprecated insecure configuration of VCS service API keys via _TOKEN/_USERNAME configuration instead of _CREDENTIALS list. In Docker, please add matching _HOST directive. For example see WEBLATE_GITHUB_HOST and GITHUB_CREDENTIALS.

See also

Generic upgrade instructions

Upgrade from 4.14 to 4.15

Please follow Generic upgrade instructions in order to perform update.

• Weblate now requires btree_gin extension in PostgreSQL. The migration process will install it if it has sufficient privileges. See Creating a database in PostgreSQL for manual setup.

• The Docker image no longer enables debug mode by default. In case you want it, enable it in the environment using WEBLATE_DEBUG.

• The database migration make take hours on larger instances due to recreating some of the indexes.

• Changed in 4.15.1: The default value for DEFAULT_PAGINATION_CLASS in rest framework settings was changed.

See also

Generic upgrade instructions

Upgrade from 4.15 to 4.16

Please follow Generic upgrade instructions in order to perform update.

• Celery beat is now storing the tasks schedule in the database, CELERY_BEAT_SCHEDULER and INSTALLED_APPS need to be changed for that.

• The deprecated VCS setting for credentials is no longer supported, see Upgrade from 4.13 to 4.14.

• Upgrade of django-crispy-forms requires changes in INSTALLED_APPS.

• Integration of django-cors-headers requires changes in INSTALLED_APPS and MIDDLEWARE.

See also

Generic upgrade instructions

Upgrade from 4.16 to 4.17

Please follow Generic upgrade instructions in order to perform update.

• Migration to rewritten metrics storage might take considerable time on larger Weblate instance (expect around 15 minutes per GB of metrics_metric table). To reduce downtime, you can copy weblate/metrics/migrations/*.py from Weblate 4.17 to 4.16 and start the migration in the background. Once it is completed, perform full upgrade as ususal.

• Docker container now requires PostgreSQL 12 or newer, please see Upgrading PostgreSQL container for upgrade instructions. Weblate itself supports older versions as well, when appropriate Django version is installed.

Warning

Migration on MySQL will try to load all metrics into memory due to limitation of the Python database driver. You might need to prune metrics prior to migration if you want to continue using MySQL. Please consider switching to PostgreSQL, see Migrating from other databases to PostgreSQL.

See also

Generic upgrade instructions

Upgrade from 4.17 to 4.18

Please follow Generic upgrade instructions in order to perform update.

• Dropped support for PostgreSQL 10, 11, MySQL 5.7 and MariaDB 10.2, 10.3.

• Dropped support for Python 3.7.

• The Fluent format format changed identification of some strings, you might need to force reloading of the translation files to see the changes.

• There are several changes in settings_example.py, most notable is change in COMPRESS_OFFLINE_CONTEXT, please adjust your settings accordingly.

See also

Generic upgrade instructions

Upgrading from Python 2 to Python 3

Weblate no longer supports Python older than 3.6. In case you are still running on older version, please perform migration to Python 3 first on existing version and upgrade later. See Upgrading from Python 2 to Python 3 in the Weblate 3.11.1 documentation.

Migrating from other databases to PostgreSQL

If you are running Weblate on other dabatase than PostgreSQL, you should consider migrating to PostgreSQL as Weblate performs best with it. 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 main 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 -E UTF8 -O weblate weblate

Migrating using Django JSON dumps

The simplest approach for migration is to utilize Django JSON dumps. This works well for smaller installations. On bigger sites you might want to use pgloader instead, see Migrating to PostgreSQL using pgloader.

1. Add PostgreSQL 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": "",
    },
}

2. Run migrations and drop any data inserted into the tables:

weblate migrate --database=postgresql
weblate sqlflush --database=postgresql | weblate dbshell --database=postgresql

3. Dump legacy database and import to PostgreSQL

weblate dumpdata --all --output weblate.json
weblate loaddata weblate.json --database=postgresql

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

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

Migrating to PostgreSQL using pgloader

The pgloader is a generic migration tool to migrate data to PostgreSQL. You can use it to migrate Weblate database.

1. Adjust your settings.py to use PostgreSQL as a database.

2. Migrate the schema in the PostgreSQL database:

   weblate migrate
   weblate sqlflush | weblate dbshell
   

3. Run the pgloader to transfer the data. The following script can be used to migrate the database, but you might want to learn more about pgloader to understand what it does and tweak it to match your setup:

   LOAD DATABASE
        FROM      mysql://weblate:password@localhost/weblate
        INTO postgresql://weblate:password@localhost/weblate
   
   WITH include no drop, truncate, create no tables, create no indexes, no foreign keys, disable triggers, reset sequences, data only
   
   ALTER SCHEMA 'weblate' RENAME TO 'public'
   ;
   

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 weblate importusers.