Skip to content

Feature: Add page about event view #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions source/desktop/vault-events.rst
Original file line number Diff line number Diff line change
@@ -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.
Binary file added source/img/desktop/event-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down