From e9dcb1771942e39cd12800fbfe041122b0cfb81b Mon Sep 17 00:00:00 2001 From: Ben Sturmfels Date: Thu, 23 Mar 2023 23:14:39 +1100 Subject: [PATCH] Update upgrading and deployment docs --- docs/source/siteadmin/deploying.rst | 8 ++++---- docs/source/siteadmin/relnotes.rst | 10 ++++++++++ docs/source/siteadmin/upgrading.rst | 25 ++++++++++++++++--------- setup.cfg | 7 +++++++ 4 files changed, 37 insertions(+), 13 deletions(-) diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index 77d2dc9e..c7931131 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -483,16 +483,16 @@ created:: sudo find /srv/mediagoblin.example.org -type d -exec chmod 755 {} \; sudo find /srv/mediagoblin.example.org -type f -exec chmod 644 {} \; sudo find /srv/mediagoblin.example.org/mediagoblin/user_dev/crypto -type d -exec chmod 750 {} \; - sudo find /opt/mediagoblin.example.org/mediagoblin/user_dev/crypto -type f -exec chmod 640 {} \; - sudo find /opt/mediagoblin.example.org/mediagoblin/bin -type f -exec chmod 750 {} \; + sudo find /srv/mediagoblin.example.org/mediagoblin/user_dev/crypto -type f -exec chmod 640 {} \; + sudo find /srv/mediagoblin.example.org/mediagoblin/bin -type f -exec chmod 750 {} \; # Fedora sudo chown --no-dereference --recursive mediagoblin:nginx /srv/mediagoblin.example.org sudo find /srv/mediagoblin.example.org -type d -exec chmod 755 {} \; sudo find /srv/mediagoblin.example.org -type f -exec chmod 644 {} \; sudo find /srv/mediagoblin.example.org/mediagoblin/user_dev/crypto -type d -exec chmod 750 {} \; - sudo find /opt/mediagoblin.example.org/mediagoblin/user_dev/crypto -type f -exec chmod 640 {} \; - sudo find /opt/mediagoblin.example.org/mediagoblin/bin -type f -exec chmod 750 {} \; + sudo find /srv/mediagoblin.example.org/mediagoblin/user_dev/crypto -type f -exec chmod 640 {} \; + sudo find /srv/mediagoblin.example.org/mediagoblin/bin -type f -exec chmod 750 {} \; .. note:: diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst index 5be3ca2d..54701e2d 100644 --- a/docs/source/siteadmin/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst @@ -56,6 +56,16 @@ If you have any problems, please drop in to the `#mediagoblin IRC chat tracker `_ or drop us an email to `mediagoblin-devel@gnu.org `_. +**Upgrading:** + +For detailed instructions on installing or upgrading, see ":doc:`upgrading`" and +":doc:`deploying`". + +If you have any problems, please drop in to the `#mediagoblin IRC chat +`_, report an issue on our `issue +tracker `_ or drop us an email to +`mediagoblin-devel@gnu.org `_. + **Changes:** - Convert README to Markdown for better display on SourceHut, add goblin, fix links (Ben Sturmfels) diff --git a/docs/source/siteadmin/upgrading.rst b/docs/source/siteadmin/upgrading.rst index 7cf6ad8a..6e427450 100644 --- a/docs/source/siteadmin/upgrading.rst +++ b/docs/source/siteadmin/upgrading.rst @@ -28,30 +28,37 @@ MediaGoblin/Celery processes before upgrading. Upgrade ------- -1. Update to the latest release. In your ``mediagoblin`` directory, run:: +1. Switch to the user you used to deploy MediaGoblin, which may be "mediagoblin" + if you followed the deployment guide:: - git fetch && git checkout -q v0.12.0 && git submodule update + sudo su mediagoblin --shell=/bin/bash -2. Note down any plugins you have installed by reviewing your +2. Update to the latest release. In your ``mediagoblin`` directory, run:: + + git fetch && git checkout -q v0.12.1rc1 && git submodule update + +3. Note down any plugins you have installed by reviewing your ``mediagoblin.ini`` configuration. These will be removed by the following steps and must be re-installed. -3. Remove your existing installation:: +4. Remove your existing installation:: make distclean -4. Recreate the virtual environment and install MediaGoblin:: +5. Recreate the virtual environment and install MediaGoblin:: ./bootstrap.sh && ./configure && make -5. Re-install any ":doc:`plugins`" you had previously installed. Skipping these + You may need to update file permissions as mentioned in ":doc:`deploying`". + +6. Re-install any ":doc:`plugins`" you had previously installed. Skipping these may result in errors updating the database. -6. Update the database:: +7. Update the database:: ./bin/gmg dbupdate -7. Restart the Paster and Celery processes. If you followed ":doc:`deploying`", +8. Restart the Paster and Celery processes. If you followed ":doc:`deploying`", this may be something like:: sudo systemctl restart mediagoblin-paster.service @@ -62,7 +69,7 @@ Upgrade sudo journalctl -u mediagoblin-paster.service -f sudo journalctl -u mediagoblin-celeryd.service -f -8. View your site and hover your cursor over the "MediaGoblin" link in the +9. View your site and hover your cursor over the "MediaGoblin" link in the footer to confirm the version number you're running. diff --git a/setup.cfg b/setup.cfg index 24bc7873..edb7c814 100644 --- a/setup.cfg +++ b/setup.cfg @@ -69,6 +69,13 @@ install_requires = werkzeug>=0.7,<2.0.0 # 2.0.0 breaks legacy API and submission tests. wtforms>2.1,<3.0 # Removed the "ext" module in 3.0. + # Temporary fixes for Debian 11. + sphinxcontrib-qthelp + sphinxcontrib-jsmath + sphinxcontrib-htmlhelp + sphinxcontrib-devhelp + sphinxcontrib-applehelp + # For now we're expecting that users will install this from # their package managers. # 'lxml', -- 2.38.5