nextcloud / nextcloud/documentation

Encryption chapter(s) revision(s)

Open
#11,545 2 comments 0 reactions 1 assignee View on GitHub

@joshtrichards is already working on this.

Since Feb 14, 2024.

1. to develop feature: encryption (client-side) feature: encryption (server-side) manual: admin overview
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

The Encryption chapter needs some love.

Note: WIP (expect this list to change/get updated as changes are made/PRs are merged/etc)

TODO:

(Mostly being addressed via PR #13754)

  • Add: Mention E2EE != the encryption documented in the Admin Manual Encryption chapter
  • Add: Warning that E2EE not to be used with default encryption
  • Fix: Old remarks about "Encrypting files increases their size by roughly 35%" isn't accurate since the base64 -> binary change
  • Add context in the overview (or wherever it ends up making sense) of different ways of encrypting day / comparisons (without getting too down in the weeds) so that reader can make informed decision regarding server-side, client-side, disk encryption, etc.
  • Streamline and re-organize (and expand where appropriate) the general setup process
  • Get some feedback from various other relevant folks
  • (probably some other things which will get added here)

After:

Then (will probably move the below to their own issue and revise the list after the above is completed):

Out of scope but related:

  • Add a setup check or warning if both encryption and end_to_end_encryption apps are enabled together (not a supported configuration)
  • Encryption details section could use some love
  • Consider/assess downsides (if any) to changing encryption app name from Default encryption module to Server-side encryption module to greater clarity

Thanks for helping improve our documentation!
  • There is always room for improvement!
  • All contributions (changes and change ideas) - from the largest to the tiniest - help make Nextcloud better and easier to use!

Notes
  • Please be patient: this is a large open source project that is overseen by a mixture of volunteers and non-volunteers which are all ultimately busy.
  • If your suggestion is a troubleshooting scenario or one you're not 100% certain about, please post for feedback on the Nextcloud Help Forum first.
    • Then return here to bring back your experience to help improve the documentation for clarity, etc. (and link back to the forum discussion in your report!)
Protip: If you want to help move things along (or just help out in other ways too) here are some suggestions:
  • Look for areas where you can assist - even seemingly unrelated areas - because doing so frees up resources for your favorite topics and ideas.
  • Submit a proposed change - that attempts to addresses your issue - as a pull request.
  • Participate in a discussion on some other unresolved submitted idea ("issues") to help move it along.
  • Post a comment or review on someone else's proposed change ("pull request") to help move it along.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.