Skip to content

Commit

Permalink
Add upgrade instructions for Fedora template, screenshots, add gettin…
Browse files Browse the repository at this point in the history
…g support blub.
  • Loading branch information
rocodes authored and Conor Schaefer committed May 28, 2020
1 parent b2af85c commit 29320bb
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/admin/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Pre-install tasks:
#. Download and verify Qubes OS
#. Install Qubes OS
#. Apply updates to system templates
#. Install Fedora 31 base template

Install tasks:
~~~~~~~~~~~~~~
Expand Down Expand Up @@ -151,6 +152,11 @@ Before installing SecureDrop Workstation, you must set up network and Tor access

- Once Tor has connected, select **Q > System Tools > Qubes Update** to update the system VMs. in the ``[Dom0] Qubes Updater`` window, first check ``Enable updates for qubes without known available updates``, then check all entries in the list above. Then, click **Next**. The system's VMs will be updated sequentially - this may take some time. When the updates are complete, click **Finish**.

Install Fedora 31 template
~~~~~~~~~~~~~~~~~~~~~~~~~~

See :doc:`upgrading_to_fedora_31`.

Install tasks
-------------

Expand Down
51 changes: 51 additions & 0 deletions docs/admin/upgrading_to_fedora_31.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Upgrading to Fedora 31
======================

.. include:: ../includes/top-warning.rst

.. note:: This advisory was written in May 2020, and will be removed when a new version of Qubes that contains the Fedora 31 template is released.

Why do I need to upgrade?
-------------------------

SecureDrop Workstation makes use of the Fedora-based ``work`` and ``vault`` VMs, which are part of a Qubes installation by default. In Qubes 4.0.3, these VMs are based on a Fedora 30 template.

As of June 2020, Fedora 30 templates will be end-of-life. If you are provisioning SecureDrop Workstation for the first time, you will need to update your Fedora template manually from Fedora 31 *before* installing SecureDrop Workstation.

If you are an existing SecureDrop Workstation user, you should also upgrade to a Fedora 31 template.

Install Fedora-31 template
--------------------------

In a ``dom0`` terminal (**Qubes Application Menu > Terminal Emulator**), type the following to download the Fedora 31 template:

.. code:: sh
sudo qubes-dom0-update qubes-template-fedora-31
You will see some information from the package manager, including a progress bar.

When the download has concluded, you will be prompted to install the package. Type ``y`` to proceed with the installation.

Update the Fedora-31 template
-----------------------------

Once the template is installed, update it using the Qubes updater (**System Tools > Qubes Update**).

Configure VMs to use the new template
-------------------------------------

VMs not managed by SecureDrop Workstation must be manually configured in order to use the Fedora 31 template.

It is most important to update the ``work`` and ``vault`` VMs to Fedora 31; however, you may also choose to update ``sys-net``, ``sys-usb``, and ``sys-firewall``.

To update a VM's base template, find the VM in the Qubes Application Menu and click **Qube settings**. Click the drop-down menu beside **Template:** and select ``fedora-31`` from the list, then click **OK.** Note that, if the VM is running, the change will only take effect once it has been shut down and rebooted.

|screenshot_qsettings_fedora31|

.. |screenshot_qsettings_fedora31| image:: ../images/screenshot_qsettings_fedora31.png

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

.. include:: ../includes/getting_support.rst
Binary file added docs/images/screenshot_qsettings_fedora31.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/includes/getting_support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If you are part of the SecureDrop Workstation Pilot and you have questions about this process or about any other aspect of SecureDrop Workstation, please reach out to us.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,14 @@ against malware and other security risks. It is built on Qubes OS and requires a
.. toctree::
:maxdepth: 2
:caption: Guide for Administrators

admin/hardware
admin/install
admin/securing_workstation
admin/troubleshooting_connection
admin/provisioning_usb
admin/known_issues
admin/upgrading_to_fedora_31
admin/workstation_architecture


Expand Down

0 comments on commit 29320bb

Please sign in to comment.