Permalink
Fetching contributors…
Cannot retrieve contributors at this time
191 lines (113 sloc) 6.17 KB

Upgrading Weblate

Generic upgrade instructions

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

Always check :ref:`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 :doc:`backup`.

  1. Upgrade configuration file, refer to :file:`settings_example.py` or :ref:`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 :ref:`production`):

    ./manage.py check --deploy
  8. Restart celery worker (see :ref:`celery`).

Version specific instructions

Upgrade from 2.x

If you are upgrading from 2.x release, always first upgrade to 3.0.1 (see :ref:`weblate3:upgrade_3`) 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 :ref:`generic-upgrade-instructions` in order to perform update.

Notable configuration or dependencies changes:

.. seealso:: :ref:`generic-upgrade-instructions`

Upgrade from 3.1 to 3.2

Please follow :ref:`generic-upgrade-instructions` in order to perform update.

Notable configuration or dependencies changes:

  • Rate limiting configuration has been changed, please see :ref:`rate-limit`.
  • 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 :ref:`celery` for more information.
  • There are several changes in :file:`settings_example.py`, most notable Celery configuration and middleware changes, please adjust your settings accordingly.
.. seealso:: :ref:`generic-upgrade-instructions`


Upgrade from 3.2 to 3.3

Please follow :ref:`generic-upgrade-instructions` in order to perform update.

Notable configuration or dependencies changes:

.. seealso:: :ref:`generic-upgrade-instructions`


Upgrade from 3.3 to 3.4

Please follow :ref:`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 :ref:`celery`.
.. seealso:: :ref:`generic-upgrade-instructions`

Upgrading from Python 2 to Python 3

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 :ref:`translation-memory` using :djadmin:`dump_memory`:

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

  3. Delete :ref:`translation-memory` database :djadmin:`delete_memory`:

    ./manage.py delete_memory --all
  4. Restore your :ref:`translation-memory` using :djadmin:`import_memory`.

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

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

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

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 :djadmin:`importusers`.