1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00

Doc: Add Share Notebook doc

This commit is contained in:
Laurent Cozic 2021-08-09 11:48:29 +01:00
parent f90885709c
commit 7061d6c05d
5 changed files with 53 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

53
readme/share_notebook.md Normal file
View File

@ -0,0 +1,53 @@
Using Joplin Cloud you can share notebooks between users and collaborate on them - i.e. any participant can view or modify notes in the shared notebook.
# How does it work?
When connected to Joplin Cloud, a new "Share notebook" menu item is available when right-clicking on a notebook.
![Context menu share notebook option](https://joplinapp.org/images/share_notebook/Sidebar.png)
Click on it, and it will display a new dialog where you can add any number of recipients. From this dialog you can also remove a recipient or unshare the whole notebook, in which case it will be removed from everybody's note collection, except yours.
![Share notebook dialog](https://joplinapp.org/images/share_notebook/Dialog.png)
Once this is done, the recipient(s) will receive a notification in Joplin the next time they synchronise their data:
![Share notebook notification](https://joplinapp.org/images/share_notebook/Notification.png)
Then, finally, once the invitation is accepted, Joplin will download all the shared notebooks and notes. A shared notebook is denoted by the usual Share icon. Now the invited user can read or modify the shared notes, add attachments, etc. and the changes will be visible to everyone with access to the notebook.
![Share notebook sidebar](https://joplinapp.org/images/share_notebook/SidebarShared.png)
# FAQ
## What's the availability of the notebook sharing feature?
The notebook sharing feature is available on Joplin Cloud.
On desktop, you can share notebooks and of course view or modify any notebook that has been shared with you.
On mobile and CLI, you cannot currently share notebooks, but you can view or modify any notebook that has been shared with you.
## If I share a notebook with someone, what access do they have?
Currently they have full access to the data, including reading, writing and deleting notebooks or notes. In a future version, access control might be implemented. For example, to only give read-only access to the shared notebook.
## What can actually be shared?
All the sub-notebooks, notes and resources within the shared notebook are shared.
## Does it work with End-To-End-Encryption?
Yes and no. It is possible to use the share notebook feature even with E2EE enabled, however any shared notebook or note will not be encrypted, otherwise you would have had to give your master key password to the people you share with, which you'd probably not want to do.
In a future version, this might be supported. For example by automatically creating a new master key for the shared notebook. You would then provide the recipients with that master key password.
## What can it be used for?
Some ideas:
* Plan a trip with friends or within a small organisation. For example, the notes could contain the maps, hotel and flight reservations, etc. or any document or note relevant to the trip. And all participants would have access to them.
* Work on a project with colleagues. Everybody can access various work-related documents, add to them, modify them, etc. That could serve as a knowledge base for a project.
* Another possible use, which has been requested many times, is to support multiple profiles. You could create a main profile that have access to all notes, and in there create a Work and Personal notebook. Then you would create a separate account for work. You can then share your Work notebook with that other account. That way the work account will only have access to the Work notebooks. You can use this technique in various ways to split your notebooks between multiple accounts and ensure strict separation between datasets.