Upgrading Weblate

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.

  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 javacript 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
    

Changed in version 3.0: If you are upgrading from 2.x release, always first upgrade to 3.0 (see Upgrade from 2.20 to 3.0) and the continue ugprading in the 3.x series. Upgrades skipping this step are not supported.

Version specific instructions

Upgrade from 3.0 to 3.1

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

Upgrading from Python 2.x to 3.x

The upgrade from Python 2.x to 3.x, should work without major problems. Take care about some changed module names when installing dependencies (eg. pydns vs. py3dns).

The Whoosh index has to be rebuilt as it’s encoding depends on Python version, you can do that using following command:

./manage.py rebuild_index --clean --all

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 Poootle and import them using importusers.