Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 1.7.1 to 1.8.0 update guide (i.e. everything but Focal) #165

Merged
merged 2 commits into from
Mar 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/backup_and_restore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Migrating Using a V2+V3 or V3-Only Backup

cd ~/Persistent/securedrop/
git fetch --tags
git tag -v 1.7.1
git tag -v 1.8.0

The output should include the following two lines:

Expand All @@ -239,10 +239,10 @@ Migrating Using a V2+V3 or V3-Only Backup

.. code:: sh

git checkout 1.7.1
git checkout 1.8.0

.. important::
If you see the warning ``refname '1.7.1' is ambiguous`` in the
If you see the warning ``refname '1.8.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>`__).
Expand Down Expand Up @@ -385,7 +385,7 @@ source accounts, and journalist accounts. To do so, follow the steps below:

cd ~/Persistent/securedrop/
git fetch --tags
git tag -v 1.7.1
git tag -v 1.8.0

The output should include the following two lines:

Expand All @@ -405,11 +405,11 @@ source accounts, and journalist accounts. To do so, follow the steps below:

.. code:: sh

git checkout 1.7.1
git checkout 1.8.0


.. important::
If you see the warning ``refname '1.7.1' is ambiguous`` in the
If you see the warning ``refname '1.8.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>`__).

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@
# built documents.
#
# The short X.Y version.
version = "1.7.1"
version = "1.8.0"
# The full version, including alpha/beta/rc tags.
release = "1.7.1"
release = "1.8.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ anonymous sources.
:maxdepth: 2

upgrade/focal_migration.rst
upgrade/1.7.1_to_1.8.0.rst
upgrade/1.7.0_to_1.7.1.rst
upgrade/1.6.0_to_1.7.0.rst
upgrade/1.5.0_to_1.6.0.rst

.. toctree::
:caption: Developer Documentation
Expand Down
6 changes: 3 additions & 3 deletions docs/set_up_admin_tails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ signed with the release signing key:

cd ~/Persistent/securedrop/
git fetch --tags
git tag -v 1.7.1
git tag -v 1.8.0

The output should include the following two lines:

Expand All @@ -158,9 +158,9 @@ screen of your workstation. If it does, you can check out the new release:

.. code:: sh

git checkout 1.7.1
git checkout 1.8.0

.. important:: If you see the warning ``refname '1.7.1' is ambiguous`` in the
.. important:: If you see the warning ``refname '1.8.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>`__).

Expand Down
2 changes: 2 additions & 0 deletions docs/update_tails_usbs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ We recommend that you :ref:`back up your existing configuration <backup_workstat

.. |Update Notification| image:: images/tails_update_notification.png

.. _Update Tails Manually:

Update Manually
---------------

Expand Down
98 changes: 0 additions & 98 deletions docs/upgrade/1.5.0_to_1.6.0.rst

This file was deleted.

109 changes: 109 additions & 0 deletions docs/upgrade/1.7.1_to_1.8.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
Upgrade from 1.7.1 to 1.8.0
===========================

.. important::

You must migrate your SecureDrop servers to Ubuntu 20.04 before **April 30,
2021** to keep your SecureDrop instance operational. This migration will require
physical access to the servers. Please see our :doc:`migration guide <focal_migration>`
for instructions.

Updating Servers to SecureDrop 1.8.0
rocodes marked this conversation as resolved.
Show resolved Hide resolved
------------------------------------
Your servers will be updated to the latest version of SecureDrop automatically
within 24 hours of the release.

.. _updating_workstations_180:

Updating Workstations to SecureDrop 1.8.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.boum.org/doc/first_steps/welcome_screen/administration_password/>`_
on the Tails welcome screen in order to use the graphical updater.

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

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

Performing 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 \
"2224 5C81 E3BA EB41 38B3 6061 310F 5612 00F4 AD77"
git tag -v 1.8.0

The output should include the following two lines: ::

gpg: using RSA key 22245C81E3BAEB4138B36061310F561200F4AD77
gpg: Good signature from "SecureDrop Release Signing Key"

Please verify that each character of the fingerprint above matches what is
on the screen of your workstation. If it does, you can check out the
new release: ::

git checkout 1.8.0

.. important:: If you do see the warning "refname '1.8.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: ::

./securedrop-admin setup
./securedrop-admin tailsconfig

.. include:: ../includes/always-backup.txt

Updating Tails
--------------
Check the version of Tails on your *Admin* and *Journalist Workstations*
(**Applications ▸ Tails ▸ About Tails**). If your workstations are running Tails
version 4.14 or earlier, you will not receive an update notification due to a
bug. Perform a :ref:`manual update <Update Tails Manually>`, or reinstate
automatic updates by following the steps in the
`Tails advisory <https://tails.boum.org/news/version_4.14/broken_upgrades/index.en.html>`__.

If you are running Tails 4.15 or later, follow the graphical prompts to update
to the latest version.

Migration to Ubuntu 20.04 and to v3 onion services
--------------------------------------------------
The operating system running on your *Application* and *Monitor Servers*,
Ubuntu 16.04 (Xenial), reaches its end-of-life for security updates on April 30,
2021. You must migrate your servers to Ubuntu 20.04 before April 30, 2021 to
remain secure. Please see our :doc:`migration guide <focal_migration>` for detailed
instructions.

.. important ::

If your servers are running Ubuntu 16.04 after **April 30, 2021**, the
*Source Interface* will be automatically disabled as a security precaution.

Because v2 :ref:`onion services <glossary_onion_service>` are deprecated,
SecureDrop does not support enabling them on Ubuntu 20.04. If you are not already
running v3 onion services (easily recognizable by their 56 character ``.onion``
addresses), you can :doc:`enable them <../v3_services>` prior to the migration
to Ubuntu 20.04, or as part of the same maintenance window.

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

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

.. include:: ../includes/getting-support.txt
25 changes: 14 additions & 11 deletions docs/upgrade_to_tails_4.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
Upgrading workstations from Tails 3 to Tails 4
----------------------------------------------

.. important::

Before upgrading your *Admin Workstation* and your *Journalist Workstation*
to Tails 4, you must first ensure that the version of the SecureDrop code on
the workstation (which is used for administrative tasks and for configuring
the Tails desktop) is at |version|.
.. note::

If unsure, you can always run the ``git status`` command in the
``~/Persistent/securedrop`` directory to determine the current version. If
the output is not "HEAD detached at |version|", you are *not*
ready to proceed with the upgrade to Tails 4, and you must first update the
workstation using the procedure described in our upgrade guides.
This guide will be removed in a future release of this documentation, and
is no longer actively tested as part of SecureDrop QA. If you still use older
Tails USB drives and encounter issues during the upgrade, please get in
touch.

As a precaution, we recommend backing up your workstations before the upgrade
to Tails 4. See our :doc:`Workstation Backup Guide <../backup_workstations>` for
Expand All @@ -37,6 +31,7 @@ On the *Admin* and *Journalist Workstation* USBs, set an administrator password
following commands: ::

cd ~/Persistent/securedrop
./securedrop-admin update
./securedrop-admin setup
./securedrop-admin tailsconfig

Expand All @@ -56,3 +51,11 @@ to restore from a backup, see our :ref:`guide for restoring workstations <restor
Make sure you restore to a Tails drive using Tails 3.16 before attempting
another upgrade to Tails 4.


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

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

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