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 install docs #21

Merged
merged 3 commits into from
Mar 27, 2020
Merged

Add install docs #21

merged 3 commits into from
Mar 27, 2020

Conversation

zenmonkeykstop
Copy link
Contributor

Adds installation docs page in Admin section.

Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

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

First pass visual review.

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@rocodes rocodes left a comment

Choose a reason for hiding this comment

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

LGTM - few changes as a result of our walkthrough

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@emkll emkll left a comment

Choose a reason for hiding this comment

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

docs look great @zenmonkeykstop , left a few comments inline

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved

securedrop-admin --uninstall

This will remove all associated VMs and configuration details, and uninstall the ``dom0`` SecureDrop Workstation package.
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

IMO if we expect that warnings will be shown then we should note it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a bug that we should fix. We should not expect users to interpret error messages to figure out if they're "okay" ones.

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/known_issues.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member

eloquence commented Mar 23, 2020

Regarding the recommendation for the default user password:

  • Any user with FDE passphrase can boot into single user mode, so this password provides limited protection against system compromise.
  • It does provide some weak protection in the case where the laptop is left unattended, or against naive compromise attempts.
  • User will have to type this password every time they log in and will never be able to copy/paste it, so a password like @LK$#\x<L:#$ seems highly undesirable.

With these tradeoffs in mind, I think we should use language like this:

We recommend setting a strong password or passphrase that you are comfortable typing repeatedly.

Qubes itself provides a strength indicator while you set the password, so I think this is sufficient guidance. Thoughts?

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member

Screenshots for the attach flow:
ws2px2e
gOfDuFA

@emkll
Copy link
Contributor

emkll commented Mar 25, 2020

Provided the finding/changes in freedomofpress/securedrop-workstation#510 are valid, we should make an update to these docs as well.

docs/admin/hardware.rst Outdated Show resolved Hide resolved
docs/admin/hardware.rst Outdated Show resolved Hide resolved
docs/admin/hardware.rst Outdated Show resolved Hide resolved
docs/admin/hardware.rst Outdated Show resolved Hide resolved
docs/admin/hardware.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member

Added some notes to BIOS section; thanks a lot for putting this together and for your patience w/ review, these docs are really looking great already.

docs/admin/hardware.rst Outdated Show resolved Hide resolved
docs/admin/hardware.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member

Couple small comments re: the BIOS docs, and would still recommend copy/paste instructions for the steps performed in the work VM, but otherwise this LGTM from my end :)

@zenmonkeykstop
Copy link
Contributor Author

Thanks, pushed a rebased version to keep the commit count down :)

eloquence
eloquence previously approved these changes Mar 27, 2020
rocodes
rocodes previously approved these changes Mar 27, 2020
@eloquence
Copy link
Member

Looks great, doing a quick final visual review before merging. :)

docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
docs/admin/install.rst Outdated Show resolved Hide resolved
Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for all your hard work on this. :shipit:

@eloquence eloquence merged commit 6e1ef50 into master Mar 27, 2020
@eloquence eloquence mentioned this pull request Mar 30, 2020
@eloquence eloquence deleted the add-install-docs branch August 24, 2022 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants