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

Update guide for SecureDrop 1.7.1; bump docs version #142

Merged
merged 3 commits into from
Jan 27, 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
13 changes: 12 additions & 1 deletion docs/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -408,17 +408,28 @@ for how to enable error logging for the *Source Interface*.

.. include:: includes/get-logs.txt

.. _immediate_update:

Immediately Apply a SecureDrop Update
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

SecureDrop will update and reboot once per day. However, if after a SecureDrop
update `is announced`_ you wish to fetch the update immediately, you can SSH
into each server and run:
into each server (via ``ssh app`` and ``ssh mon``) and run:

.. code:: sh

sudo cron-apt -i -s
Copy link
Member Author

@eloquence eloquence Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a side note, these switches are undocumented (not in man page, help output, or README). Since we're deprecating cron-apt, not fleshing this out any further, but just in case of any support questions about it:

-i: Run immediately
-s: Print to stdout


Depending on the nature of the update (e.g., if the ``tor`` package is upgraded
and you are using SSH-over-Tor), your SSH connection may be interrupted, and you
may have to reconnect to see the full output.

.. important::

Except where otherwise indicated, make sure to update both your
*Application Server* and your *Monitor Server*.

.. _`is announced`:
https://securedrop.org/news

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.0"
version = "1.7.1"
# The full version, including alpha/beta/rc tags.
release = "1.7.0"
release = "1.7.1"

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

upgrade/focal_prep.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

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.0
git tag -v 1.7.1

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.0
git checkout 1.7.1

.. important:: If you see the warning ``refname '1.7.0' is ambiguous`` in the
.. important:: If you see the warning ``refname '1.7.1' 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
75 changes: 75 additions & 0 deletions docs/upgrade/1.7.0_to_1.7.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
Upgrade from 1.7.0 to 1.7.1
===========================

SecureDrop 1.7.1 is a bugfix release to address an issue introduced in
SecureDrop 1.7.0 which caused an outage for some long-running SecureDrop
instances. Please see :doc:`1.6.0_to_1.7.0` for important information about
SecureDrop 1.7.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.

Because this release resolves an ongoing outage for some instances, you may
want to :ref:`apply it immediately <immediate_update>`.

Updating Workstations to SecureDrop 1.7.1
-----------------------------------------

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.7.1 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.7.1

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.7.1

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

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

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

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