diff --git a/source/desktop/vault-events.rst b/source/desktop/vault-events.rst new file mode 100644 index 0000000..88a8ab0 --- /dev/null +++ b/source/desktop/vault-events.rst @@ -0,0 +1,44 @@ +Events and Event View +===================== + +Vault events give information about the vault's status and certain activities. +There are several types of events, including conflict detection or corrupted files. +All vault events are logged in the event view, which can be opened from the main window. + +.. note:: + + Vault events are not persisted on the hard disk. + They are only stored in memory and are lost when the application is closed. + + +.. _desktop/vault-events/event-viewer: + +Event View +------------ + +The event view shows the events of all vaults. +To open the event view, click on the Bell icon in the lower left corner of the main window. +If new, unread events are present, the icon has a small red dot. + +.. image:: ../img/desktop/event-view.png + :scale: 63% + :alt: Event view + + +The event view has an action bar at the top followed by the actual event list. +Events are displayed from newest (top) to oldest (bottom). +You can filter the events by the vault they belong to. +Also, you can clear the event log by clicking on the trash can icon. + + +.. _desktop/vault-events/vault-event: + +Vault Event +----------- + +A vault event consists of a title, its number of appearances in brackets, an affected file, and a timestamp. +If you hover over the event, a button to open a context menu appears. +The context menu contains event-specific actions, mostly to reveal affected files in the file manager. + +If the vault of the event is locked, the event is anonymized. +To view the event details, you need to unlock the corresponding vault first. diff --git a/source/img/desktop/event-view.png b/source/img/desktop/event-view.png new file mode 100644 index 0000000..a8985c4 Binary files /dev/null and b/source/img/desktop/event-view.png differ diff --git a/source/index.rst b/source/index.rst index 47d3b86..4449016 100644 --- a/source/index.rst +++ b/source/index.rst @@ -26,6 +26,7 @@ If you are interested in the security of Cryptomator, have a look at our :ref:`s desktop/password-and-recovery-key.rst desktop/vault-management.rst desktop/volume-type.rst + desktop/vault-events.rst desktop/error-handling.rst desktop/sync-conflicts.rst desktop/advanced-settings.rst