Skip to content

Commit

Permalink
Merge pull request #5248 from freedomofpress/docs-122-to-130
Browse files Browse the repository at this point in the history
Add 1.2.2->1.3.0 upgrade guide; remove old Xenial docs
  • Loading branch information
zenmonkeykstop authored May 12, 2020
2 parents 96d8b8d + fcdf7b4 commit 1017416
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 142 deletions.
79 changes: 0 additions & 79 deletions docs/development/xenial_support.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/includes/trusty-warning.txt

This file was deleted.

3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ anonymous sources.
:name: upgradetoc
:maxdepth: 2

upgrade/1.2.2_to_1.3.0.rst
upgrade/1.2.1_to_1.2.2.rst
upgrade/1.2.0_to_1.2.1.rst
upgrade/1.1.0_to_1.2.0.rst
upgrade/1.0.0_to_1.1.0.rst
upgrade/xenial_after_april_30.rst

.. toctree::
:caption: Developer Documentation
Expand Down Expand Up @@ -128,7 +128,6 @@ anonymous sources.
development/release_management
development/dockerbuildmaint
development/qubes_staging
development/xenial_support

.. toctree::
:caption: Threat Model
Expand Down
8 changes: 4 additions & 4 deletions docs/upgrade/1.0.0_to_1.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ Upgrading workstations to Tails 4
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 1.1.0.
the Tails desktop) is at 1.1.0 or a later version.

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 1.1.0", you are *not* ready to proceed
with the upgrade to Tails 4, and you must first update the workstation using
the procedure described in the previous section.
the output is not "HEAD detached at 1.1.0" or a later 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 the previous section.

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 Down
113 changes: 113 additions & 0 deletions docs/upgrade/1.2.2_to_1.3.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
Upgrade from 1.2.2 to 1.3.0
===========================

Automatic server upgrades
-------------------------
As with previous releases, your servers will be upgraded to the latest version
of SecureDrop automatically within 24 hours of the release.

Please note that the automated upgrade path from 1.2.2 to 1.3.0
will be supported throughout the 1.3.x and 1.4.x release series. Automated
upgrades from 1.2.2 will not be supported to the 1.5.x release series or later.
If your servers fail to automatically upgrade to 1.3.0 after this release,
please :ref:`contact us <contact_us>` as soon as possible.

Updating Workstations to SecureDrop 1.3.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/startup_options/administration_password/>`_
on the Tails welcome screen in order to use the graphical updater.

Perform the update to 1.3.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.3.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.3.0

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

Upgrading Tails
---------------
If you have already upgraded your workstations to the Tails 4 series, follow the
graphical prompts to update to the latest version.

.. important::

If you are still running Tails 3.x on any workstation, we urge you to update
to the Tails 4 series as soon as possible. Tails 3.x is no longer receiving
security updates, and is no longer supported by the SecureDrop team.
Please see our
:ref:`instructions for upgrading to Tails 4 <upgrade_to_tails_4>`.

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

Troubleshooting Kernel Issues
-----------------------------
SecureDrop 1.3.0 includes a kernel update on the *Application* and *Monitor
Servers*, from version 4.14.154 to version 4.14.175. As with all kernel updates,
we have extensively tested this update against
:ref:`recommended hardware <Specific Hardware Recommendations>`.

If you are running SecureDrop on hardware that is not officially supported, you
may encounter compatibility issues with the new kernel. For example, the servers
may not boot, or you may lose network connectivity. If this happens, you can
temporarily downgrade to the previous kernel version.

.. important::

To ensure continued secure operation of your SecureDrop instance, it is of
critical importance to resolve any compatibility issues with the new kernel
as quickly as possible. If you encounter problems with this update, please
get in touch with us urgently, so we can help you run the latest supported
kernel version.

For information on how to downgrade to the previous kernel, and for additional
troubleshooting information, please see our :doc:`Kernel Troubleshooting Guide <../kernel_troubleshooting>`.

.. _contact_us:

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

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

.. include:: ../includes/getting-support.txt
51 changes: 0 additions & 51 deletions docs/upgrade/xenial_after_april_30.rst

This file was deleted.

0 comments on commit 1017416

Please sign in to comment.