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.

Sign up for GitHub

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 Qubes docs references to debian-10; add tip re: aufs-dkms #5269

Merged
merged 3 commits into from
May 18, 2020
Merged

Update Qubes docs references to debian-10; add tip re: aufs-dkms #5269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8f5454
Cleanup commit: whitespace
eloquence May 18, 2020
bf9a3fa
Update Qubes references to debian-10, add tip for aufs-dkms
eloquence May 18, 2020
d731795
Dev docs: Debian 9 -> Debian "stable"
May 18, 2020
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
15 changes: 7 additions & 8 deletions docs/development/qubes_staging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Standalone (HVM) Qubes VMs for use with staging:
- ``sd-staging-app-base``, a base VM for the *SecureDrop Application Server*
- ``sd-staging-mon-base``, a base VM for the *SecureDrop Monitor Server*

While the development VM, ``sd-dev``, is based on Debian 9, the other VMs
While the development VM, ``sd-dev``, is based on Debian 10, the other VMs
will be based on Ubuntu Xenial.

.. note:: The staging server VM names were recently changed from ``sd-app`` and
Expand Down Expand Up @@ -299,21 +299,21 @@ environment. In from the root of the SecureDrop project in ``sd-dev``, run:

make staging

The ``make staging`` command invokes the ``qubes-staging`` Molecule scenario.
The ``make staging`` command invokes the ``qubes-staging`` Molecule scenario.
You can also run constituent Molecule actions directly, rather than using
the Makefile target:
the Makefile target:

.. code:: sh

molecule create -s qubes-staging
molecule converge -s qubes-staging
molecule test -s qubes-staging

.. note::
.. note::

If the Molecule converge scenario fails with an error like ``"stderr":
"app: Failed to clone appmenus, qvm-appmenus missing\`` you may be running
into a bug in Qubes that prevents non-dom0 VMs from cloning new VMs. A
If the Molecule converge scenario fails with an error like ``"stderr":
"app: Failed to clone appmenus, qvm-appmenus missing\`` you may be running
into a bug in Qubes that prevents non-dom0 VMs from cloning new VMs. A
workaround is described `here <https://github.com/freedomofpress/securedrop/issues/3936>`_.

That's it. You should now have a running, configured SecureDrop staging instance
Expand All @@ -324,4 +324,3 @@ to provision staging VMs on-demand. To remove the staging instance, use the Mole
.. code:: sh

molecule destroy -s qubes-staging

8 changes: 6 additions & 2 deletions docs/development/setup_development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,20 +52,24 @@ Install Docker_.
Qubes
~~~~~

Create a StandaloneVM based on Debian 9, called ``sd-dev``.
Create a StandaloneVM based on Debian 10, called ``sd-dev``.
You can use the **Q** menu to configure a new VM, or run
the following in ``dom0``:

.. code:: sh

qvm-clone --class StandaloneVM debian-9 sd-dev
qvm-clone --class StandaloneVM debian-10 sd-dev
qvm-start sd-dev
qvm-sync-appmenus sd-dev

The commands above will created a new StandaloneVM, boot it, then update
the Qubes menus with applications within that VM. Open a terminal in
``sd-dev``, and proceed with installing `Docker CE for Debian`_.

.. tip:: If you experience an error with the ``aufs-dkms`` dependency when
installing Docker CE, you can safely skip that package using the
``--no-install-recommends`` argument for ``apt``.

Fork & Clone the Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 2 additions & 2 deletions docs/development/virtual_environments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,8 @@ Log out, then log in again. Verify that libvirt is installed and KVM is availabl
kvm-ok


Debian 9 setup
^^^^^^^^^^^^^^
Debian stable setup
^^^^^^^^^^^^^^^^^^^

Install Vagrant, libvirt, QEMU, and their dependencies:

Expand Down