docs: document Tor proof-of-work defense via `securedrop-admin sdconfig` - Githubissues

freedomofpress / securedrop-docs

Documentation for the SecureDrop project

https://docs.securedrop.org/

Other

22 stars 26 forks source link

docs: document Tor proof-of-work defense via `securedrop-admin sdconfig` #569

Closed cfm closed 2 months ago

cfm commented 2 months ago

Status

Ready for review

Description of Changes

Closes #568 by:

explaining Tor's proof-of-work defense; and
giving instructions on how to enable and disable it.

Testing

[x] Visual review.
[x] Is this a fair summary of our decision to enable this feature in sdconfig by default going forward?

https://github.com/freedomofpress/securedrop-docs/blob/1b9209ec5511de0fb4ac34fbb30531cea8242f96/docs/admin/deployment/tor_pow.rst?plain=1#L13-L15

Release

This should be called out prominently in the v2.9.0 release notes.

Checklist (Optional)

[x] Doc linting (make docs-lint) passed locally
[x] Doc link linting (make docs-linkcheck) passed
[x] You have previewed (make docs) docs at http://localhost:8000

cfm commented 2 months ago

Thanks, @nathandyer! I've replied to your review feedback inline.

I don't feel strongly either way about linking to these instructions from https://github.com/freedomofpress/securedrop-docs/pull/569#discussion_r1638794961. We want this to be a transparent improvement to SecureDrop's Tor performance, rather than something administrators should have to think about. (Though we should absolutely flag it in the release notes as a heads-up.)