Skip to content

Commit 7a92483

Browse files
committed
feat: Add documentation about e2ee
Signed-off-by: Louis Chemineau <[email protected]>
1 parent 008f9d2 commit 7a92483

13 files changed

+279
-1
lines changed

β€Žuser_manual/files/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ Files & synchronization
1010
deleted_file_management
1111
desktop_mobile_sync
1212
encrypting_files
13+
using_e2ee
1314
sharing
1415
file_drop
1516
large_file_upload
1617
quota
1718
version_control
1819
projects
1920
transfer_ownership
20-
federated_cloud_sharing
21+
federated_cloud_sharing

β€Žuser_manual/files/using_e2ee.rst

+277
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,277 @@
1+
=============================================
2+
Using end-to-end encryption
3+
=============================================
4+
5+
If enabled server side, Nextcloud provides the possibility to encrypt your files on your devices.
6+
This is called end-to-end encryption, or E2EE, because the files are encrypted on your device and only decrypted on your device.
7+
This means that the server never sees the unencrypted files.
8+
9+
Enabling E2EE
10+
-------------
11+
12+
If your administrator enabled the end-to-end encryption app, you can start using it from one of your devices.
13+
Open the settings of the Nextcloud client and look for the EE2E encryption settings.
14+
15+
.. raw:: html
16+
17+
<details>
18+
<summary>Desktop</summary>
19+
20+
.. image:: ../images/e2ee-desktop-setup.png
21+
:width: 750px
22+
:alt: Setup E2EE on the desktop client
23+
24+
.. raw:: html
25+
26+
</details>
27+
28+
29+
.. raw:: html
30+
31+
<details>
32+
<summary>Android</summary>
33+
34+
.. image:: ../images/e2ee-android-setup.png
35+
:width: 400px
36+
:alt: Setup E2EE on Android
37+
38+
.. raw:: html
39+
40+
</details>
41+
42+
43+
.. raw:: html
44+
45+
<details>
46+
<summary>iOS</summary>
47+
48+
.. image:: ../images/e2ee-ios-setup.png
49+
:width: 400px
50+
:alt: Setup E2EE on iOS
51+
52+
.. raw:: html
53+
54+
</details>
55+
56+
57+
.. raw:: html
58+
59+
<details>
60+
<summary>Web</summary>
61+
62+
.. warning::
63+
It is not possible to enable E2EE in the browser.
64+
65+
.. raw:: html
66+
67+
</details>
68+
69+
70+
.. raw:: html
71+
72+
<br />
73+
74+
Encrypting a folder
75+
-----------------------
76+
77+
.. warning::
78+
79+
You can only encrypt empty folders.
80+
81+
82+
.. raw:: html
83+
84+
<details>
85+
<summary>Desktop</summary>
86+
87+
.. image:: ../images/e2ee-desktop-encrypt.png
88+
:width: 750px
89+
:alt: Encrypting a folder on the desktop client
90+
91+
.. raw:: html
92+
93+
</details>
94+
95+
96+
.. raw:: html
97+
98+
<details>
99+
<summary>Android</summary>
100+
101+
.. image:: ../images/e2ee-android-encrypt.png
102+
:width: 400px
103+
:alt: Encrypting a folder on an Android device
104+
105+
.. raw:: html
106+
107+
</details>
108+
109+
110+
.. raw:: html
111+
112+
<details>
113+
<summary>iOS</summary>
114+
115+
.. image:: ../images/e2ee-ios-encrypt.png
116+
:width: 400px
117+
:alt: Encrypting a folder on an iOS device
118+
119+
.. raw:: html
120+
121+
</details>
122+
123+
124+
.. raw:: html
125+
126+
<details>
127+
<summary>Web</summary>
128+
129+
.. warning::
130+
131+
It is not possible to encrypt a folder in the browser.
132+
133+
.. raw:: html
134+
135+
</details>
136+
137+
138+
.. raw:: html
139+
140+
<br />
141+
142+
Adding an E2EE device
143+
---------------------
144+
145+
.. raw:: html
146+
147+
<details>
148+
<summary>Desktop</summary>
149+
150+
.. image:: ../images/e2ee-desktop-add.png
151+
:width: 750px
152+
:alt: Setup a new desktop client
153+
154+
.. raw:: html
155+
156+
</details>
157+
158+
159+
.. raw:: html
160+
161+
<details>
162+
<summary>Android</summary>
163+
164+
.. image:: ../images/e2ee-android-add.png
165+
:width: 400px
166+
:alt: Setup a new Android device
167+
168+
.. raw:: html
169+
170+
</details>
171+
172+
173+
.. raw:: html
174+
175+
<details>
176+
<summary>iOS</summary>
177+
178+
.. image:: ../images/e2ee-ios-add.png
179+
:width: 400px
180+
:alt: Setup a new iOS device
181+
182+
.. raw:: html
183+
184+
</details>
185+
186+
187+
.. raw:: html
188+
189+
<details>
190+
<summary>Web</summary>
191+
192+
In the browser, you'll first have to enable E2EE in the personal settings. This needed, as E2EE is less secure in the browser as you need to fully trust your administrator to not alter the source code that your browser will execute.
193+
E2EE folders are currently read-only. Therefore, it is not possible to add, remove, edit, or share an E2EE file from the browser.
194+
195+
.. image:: ../images/e2ee-web-add-1.png
196+
:width: 750px
197+
:alt: Setup a new browser session step 1
198+
199+
.. image:: ../images/e2ee-web-add-2.png
200+
:width: 750px
201+
:alt: Setup a new browser session step 2
202+
203+
.. image:: ../images/e2ee-web-add-3.png
204+
:width: 750px
205+
:alt: Setup a new browser session step 3
206+
207+
.. raw:: html
208+
209+
</details>
210+
211+
212+
.. raw:: html
213+
214+
<br />
215+
216+
217+
Displaying the mnemonic
218+
-----------------------
219+
220+
.. raw:: html
221+
222+
<details>
223+
<summary>Desktop</summary>
224+
225+
.. image:: ../images/e2ee-desktop-mnemonic.png
226+
:width: 750px
227+
:alt: Displaying the mnemonic on the desktop client
228+
229+
.. raw:: html
230+
231+
</details>
232+
233+
234+
.. raw:: html
235+
236+
<details>
237+
<summary>Android</summary>
238+
239+
.. image:: ../images/e2ee-android-mnemonic.png
240+
:width: 400px
241+
:alt: Displaying the mnemonic on an Android device
242+
243+
.. raw:: html
244+
245+
</details>
246+
247+
248+
.. raw:: html
249+
250+
<details>
251+
<summary>iOS</summary>
252+
253+
.. image:: ../images/e2ee-ios-mnemonic.png
254+
:width: 400px
255+
:alt: Displaying the mnemonic on an iOS device
256+
257+
.. raw:: html
258+
259+
</details>
260+
261+
262+
.. raw:: html
263+
264+
<details>
265+
<summary>Web</summary>
266+
267+
.. warning::
268+
269+
It is not possible to display the mnemonic in the browser.
270+
271+
.. raw:: html
272+
273+
</details>
274+
275+
.. raw:: html
276+
277+
<br />
144 KB
Loading
Loading
162 KB
Loading
70.5 KB
Loading
52.9 KB
Loading
58.4 KB
Loading
74.7 KB
Loading
48.7 KB
Loading
111 KB
Loading
131 KB
Loading
65.3 KB
Loading

0 commit comments

Comments
Β (0)