.. MediaGoblin Documentation

   Written in 2020 by MediaGoblin contributors

   To the extent possible under law, the author(s) have dedicated all
   copyright and related and neighboring rights to this software to
   the public domain worldwide. This software is distributed without
   any warranty.

   You should have received a copy of the CC0 Public Domain
   Dedication along with this software. If not, see
   <http://creativecommons.org/publicdomain/zero/1.0/>.

======================
 Upgrading MediaGoblin
======================

Updating to a new release of MediaGoblin
----------------------------------------

Preparation
~~~~~~~~~~~

*ALWAYS* do backups before upgrading, especially before running migrations! That
way if something goes wrong, we can fix things!

And be sure to shut down your current MediaGoblin/Celery processes before
upgrading!

.. note::

   Previous versions of the upgrade docs recommended ``./bootstrap.sh &&
   ./configure && make`` without ``--system-site-packages``. This ignores any
   system-wide Python modules and installs everything from the Python Package
   Index. That's not strictly a problem, but is inconsistent with the
   ":doc:`deploying`" instructions. If you have problems with dependencies, feel
   free to revert to this approach.


Upgrade (already on Python 3)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Update to the latest release.  In your ``mediagoblin`` directory, run:
   ``git fetch && git checkout -q v0.11.0 && git submodule update``
2. Remove your existing installation:
   ``make distclean``
3. Install MediaGoblin:
   ``./bootstrap.sh && VIRTUALENV_FLAGS='--system-site-packages' ./configure && make``
4. Update the database:
   ``./bin/gmg dbupdate``
5. Restart the Paster and Celery processes


Upgrade (upgrading to Python 3)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Refer to the "Dependences" and "Configure PostgreSQL" sections of
   ":doc:`deploying`" to install the necessary Python 3 dependencies.
2. Update to the latest release.  In your ``mediagoblin`` directory, run:
   ``git fetch && git checkout -q v0.11.0 && git submodule update``
3. Remove your existing installation:
   ``make distclean``
4. Install MediaGoblin:
   ``./bootstrap.sh && VIRTUALENV_FLAGS='--system-site-packages' ./configure && make``
5. Update the database:
   ``./bin/gmg dbupdate``
6. Restart the Paster and Celery processes


Updating your system Python
---------------------------

Upgrading your operating system or installing a new version of
Python may break MediaGoblin. This typically occurs because Python virtual
environment is referring to a copy of Python that no longer exists. To fix this:

1. In your ``mediagoblin`` directory, remove your existing installation:
   ``make disclean``
2. Install MediaGoblin:
   ``./bootstrap.sh && VIRTUALENV_FLAGS='--system-site-packages' ./configure && make``
3. Update the database:
   ``./bin/gmg dbupdate``
4. Restart the Paster and Celery processes