Skip to content

Commit

Permalink
Add upgrade guide for 2.11.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nathandyer committed Dec 12, 2024
1 parent 61f8a90 commit fbd04c9
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ Get Started
:maxdepth: 2
:hidden:

upgrade/2.10.1_to_2.11.0.rst
upgrade/2.10.0_to_2.10.1.rst
upgrade/2.9.0_to_2.10.0.rst
upgrade/2.8.0_to_2.9.0.rst
Expand Down
2 changes: 0 additions & 2 deletions docs/upgrade/2.10.0_to_2.10.1.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _latest_upgrade_guide:

Upgrade from 2.10.0 to 2.10.1
=============================

Expand Down
93 changes: 93 additions & 0 deletions docs/upgrade/2.10.1_to_2.11.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
.. _latest_upgrade_guide:

Upgrade from 2.10.1 to 2.11.0
=============================

Preparing for the Ubuntu 24.04 (Noble) migration
------------------------------------------------

The 2.11.0 release includes a number of features that will help ensure
your SecureDrop server is prepared for the automated migration to Ubuntu 24.04
(Noble) in early 2025.

After updating to SecureDrop 2.11.0 using the steps below, it's important
that you review our :doc:`Ubuntu 24.04 (Noble) migration guide <../admin/maintenance/noble_migration_prep>`,
and run the ``securedrop-noble-migration-check`` script prior to January 31st, 2025
to ensure your server is ready for the migration.


Update Servers to SecureDrop 2.11.0
------------------------------------

Servers running Ubuntu 20.04 will be updated to the latest version of SecureDrop
automatically within 24 hours of the release.

Update Workstations to SecureDrop 2.11.0
----------------------------------------

.. important:: We always recommend backing up your workstations prior to
an upgrade, but we *especially* recommend it before a major Tails version
bump. This upgrade is an excellent occasion to make sure you have fresh
backups for each of your Tails drives. See our :ref:`backup instructions <backup_workstations>`
for more information.

Update to SecureDrop 2.11.0 using the graphical updater
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

On the next boot of your SecureDrop *Journalist* and *Admin Workstations*,
the *SecureDrop Workstation Updater* will alert you to workstation updates. You
must have `configured an administrator password <https://tails.net/doc/first_steps/welcome_screen/administration_password/>`_
on the Tails welcome screen in order to use the graphical updater.

Perform the update to 2.11.0 by clicking "Update Now":

.. image:: ../images/securedrop-updater.png

Fallback: Perform a manual update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the graphical updater fails and you want to perform a manual update instead,
first delete the graphical updater's temporary flag file, if it exists (the
``.`` before ``securedrop`` is not a typo): ::

rm ~/Persistent/.securedrop/securedrop_update.flag

This will prevent the graphical updater from attempting to re-apply the failed
update and has no bearing on future updates. You can now perform a manual
update by running the following commands: ::

cd ~/Persistent/securedrop
git fetch --tags
gpg --keyserver hkps://keys.openpgp.org --recv-key \
"2359 E653 8C06 13E6 5295 5E6C 188E DD3B 7B22 E6A3"
git tag -v 2.11.0

The output should include the following two lines: ::

gpg: using RSA key 2359E6538C0613E652955E6C188EDD3B7B22E6A3
gpg: Good signature from "SecureDrop Release Signing Key <[email protected]>" [unknown]


Please verify that each character of the fingerprint above matches what is
on the screen of your workstation. A warning that the key is not certified
is normal and expected. If the output includes the lines above, you can check
out the new release: ::

git checkout 2.11.0

.. important:: If you do see the warning "refname '2.11.0' is ambiguous" in the
output, we recommend that you contact us immediately at [email protected]
(`GPG encrypted <https://securedrop.org/sites/default/files/fpf-email.asc>`__).

Finally, run the following commands: ::

sudo apt update
./securedrop-admin setup
./securedrop-admin tailsconfig

Getting Support
---------------

Should you require further support with your SecureDrop installation, we are
happy to help!

.. include:: ../includes/getting-support.txt

0 comments on commit fbd04c9

Please sign in to comment.