diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/siteadmin/relnotes.rst | 5 | ||||
| -rw-r--r-- | docs/source/siteadmin/upgrading.rst | 107 |
2 files changed, 55 insertions, 57 deletions
diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst index b589fa6d..8546e20b 100644 --- a/docs/source/siteadmin/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst @@ -23,9 +23,8 @@ This chapter has important information about our current and previous releases. 0.11.0 ====== -This release of MediaGoblin drops support for Python 2 and removes all Python 2 -compatibility code, significantly reducing the work of maintaining MediaGoblin -going forward. Please see details about upgrading below. +Following our final Python 2-compatible release of 0.10.0, this release drops +support for Python 2 and removes all Python 2 compatibility code. This release also reinstates audio spectrograms with a completely rewritten Python 3 replacement for the previous Python 2-only audio feature by Fernando diff --git a/docs/source/siteadmin/upgrading.rst b/docs/source/siteadmin/upgrading.rst index a4a851d1..9507cf24 100644 --- a/docs/source/siteadmin/upgrading.rst +++ b/docs/source/siteadmin/upgrading.rst @@ -15,69 +15,68 @@ 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! +*ALWAYS* take a backup 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! +Although not strictly necessary, we recommend you 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:: -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 + git fetch && git checkout -q v0.11.0 && git submodule update + +2. Remove your existing installation:: + + make distclean + +3. Install MediaGoblin (changed for 0.11.0, see notes section above):: + + ./bootstrap.sh && VIRTUALENV_FLAGS='--system-site-packages' ./configure && make + + (As of 0.11.0, the upgrade instructions have been updated to use + ``--system-site-package`` option for consistency with the deployment + instructions. If this approach causes any problems with for you, re-run + ``make distclean`` and then ``./bootstrap.sh && ./configure && make`` without + ``--system-site-packages``.) + +4. Update the database:: + + ./bin/gmg dbupdate + +5. Restart the Paster and Celery processes. If you followed ":doc:`deploying`", + this may be something like:: + + sudo systemctl restart mediagoblin-paster.service + sudo systemctl start mediagoblin-celeryd.service + + To see the logs for troubleshooting, use something like:: + + sudo journalctl -u mediagoblin-paster.service -f + sudo journalctl -u mediagoblin-celeryd.service -f + +6. View your site and hover your cursor over "MediaGoblin" to confirm the + version number you're running. + + +Upgrading to Python 3 +--------------------- + +Refer to the "Dependences" and "Configure PostgreSQL" sections of +":doc:`deploying`" to install the necessary Python 3 dependencies. Then follow +the instructions for "Upgrade (already on Python 3)" above. 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 +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. In this situation use the +same process for "Upgrade (already on Python 3)" above. |