documentation icon indicating copy to clipboard operation
documentation copied to clipboard

feat: Add documentation about e2ee

Open artonge opened this issue 9 months ago • 14 comments

@marinofaggiana @mgallien @alperozturk96 can you add screenshots for your respective platform?

Note: the android screenshots are in French, so they need to be replaced.

Screenshot 2025-03-05 at 11-04-41 Using end-to-end encryption — Nextcloud latest User Manual latest documentation

Fix https://github.com/nextcloud/end_to_end_encryption/issues/936

artonge avatar Mar 04 '25 16:03 artonge

Hello, some suggestions:

  • from one of your device -> from one of your devices
  • "On the browser, you'll first have to enable e2ee in the browser" -> "In the browser, you'll first have to allow end to end encryption in the personal settings."
  • I would put the section "encrypting a folder" right after "enabling e2ee", and put the section "adding an e2ee device" after that. IMO this better represents the most common workflow.
  • in "encrypting a folder", maybe first show how to create a new folder in the client, which can then be encrypted (probably the most common use case, and users might not know that you can create folders via the ...-menu)
  • in "adding an e2ee device > web" maybe add that it is currently read-only, and that these folders cannot be shared with users/groups

Thank you for this documentation!

alexanderdd avatar Mar 04 '25 16:03 alexanderdd

@artonge If these are okay I can update the PR.

e2ee-android-adde2ee-android-add e2ee-android-mnemonice2ee-android-mnemonic e2ee-android-setupe2ee-android-setup

alperozturk96 avatar Mar 05 '25 14:03 alperozturk96

@artonge If these are okay I can update the PR.

I would invert add and mnemonic, no?

artonge avatar Mar 05 '25 14:03 artonge

@artonge If these are okay I can update the PR.

I would invert add and mnemonic, no?

Ahh, yes that's right. I fixed the titles

alperozturk96 avatar Mar 05 '25 14:03 alperozturk96

Ping @mgallien @marinofaggiana

artonge avatar Mar 17 '25 14:03 artonge

X A B C
Not configured Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 13 55 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 14 15 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 15 40
Configured Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 11 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 22 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 30

marinofaggiana avatar Mar 17 '25 15:03 marinofaggiana

Already configured:

Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 11

Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 22

Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 30

marinofaggiana avatar Mar 17 '25 15:03 marinofaggiana

ideally also include documentation on how to share an e2ee folder with groups and how to create a file drop link, according to https://nextcloud.com/blog/desktop-3-8-end-to-end-encryption-levels-up-with-sharing-and-file-drop/ this is already possible

alexanderdd avatar Mar 31 '25 12:03 alexanderdd

@alperozturk96 still some missing screenshots:

  • images/e2ee-android-encrypt.png - View showing how to set up encryption for a folder
  • images/e2ee-android-add.png - View showing how to set up encryption when it was already set on another device

@marinofaggiana still some missing screenshots:

  • images/e2ee-ios-encrypt.png - View showing how to set up encryption for a folder
  • images/e2ee-ios-add.png - View showing how to set up encryption when it was already set on another device

@alperozturk96 @marinofaggiana @mgallien can all of you also add screenshots for the sharing flow?

artonge avatar Apr 01 '25 10:04 artonge

@artonge I added the missing screenshots. What do you mean by sharing flow?

alperozturk96 avatar Apr 03 '25 07:04 alperozturk96

What do you mean by sharing flow?

Sharing an E2EE folder with someone else. But thinking about it, it is probably the exact same as for non E2EE folders. Feel free to ignore if this is the case.

artonge avatar Apr 03 '25 08:04 artonge

What do you mean by sharing flow?

Sharing an E2EE folder with someone else. But thinking about it, it is probably the exact same as for non E2EE folders. Feel free to ignore if this is the case.

There is no "Share" option in the three-dot menu when I checked it on the Web. On Android, I also noticed empty tabs. We should add these.

Could you check it for iOS @marinofaggiana ?

alperozturk96 avatar Apr 03 '25 08:04 alperozturk96

regarding the sharing work flow on desktop files client there is nothing specific in the UI for end-to-end encryption that said sharing with end-to-end encrypted folders is done in a specific way only the top folder can be shared and then all the content is shared to the other user (I guess @alperozturk96 @marinofaggiana it is implemented like this on all platforms ?) @artonge anything I can help on the sharing part ?

mgallien avatar Apr 10 '25 08:04 mgallien

I just came back to see if this is already merged. Looks like it needs more time.

Sidenote, I found that there is already some public documentation here https://github.com/nextcloud/end_to_end_encryption/blob/master/README.md - maybe it can be a reference. And once the documentation is published via this pull request here, that Readme should probably be shortened and include a link to the docs (to not have double documentation.

And there is also https://docs.nextcloud.com/desktop/latest/architecture.html#end-to-end-encryption

alexanderdd avatar May 21 '25 08:05 alexanderdd

@artonge there are 2 images missing to build the docs. This stops any doc updates as the CI fails.

/home/runner/actions-runner/_work/documentation/documentation/user_manual/files/using_e2ee.rst:131: WARNING: image file not readable: images/e2ee-ios-encrypt.png [image.not_readable] /home/runner/actions-runner/_work/documentation/documentation/user_manual/files/using_e2ee.rst:194: WARNING: image file not readable: images/e2ee-ios-add.png [image.not_readable]

Could you append a fix by adding these 2 images? Thanks!

christianlupus avatar Oct 02 '25 11:10 christianlupus

@AndyScherzinger please don't merge with red CI :pray: @marinofaggiana can you add those images?

artonge avatar Oct 02 '25 13:10 artonge

@artonge https://github.com/nextcloud/documentation/pull/13750

alperozturk96 avatar Oct 02 '25 13:10 alperozturk96

@artonge sure thing, but I got asked to force merge 😔

AndyScherzinger avatar Oct 02 '25 14:10 AndyScherzinger

@artonge Yeap my fault. I didn't see it but should be okay now via https://github.com/nextcloud/documentation/pull/13750

alperozturk96 avatar Oct 02 '25 14:10 alperozturk96

Thanks and sorry for nagging here. :pray:

christianlupus avatar Oct 02 '25 16:10 christianlupus