cryptomator / docs

Cryptomator Documentation

Cryptomator's Documentation

This is the source repository of Cryptomator's documentation.

Contributing

We prefer contributions to our documentation to be in English, but if you wish to contribute in another language, please contact us.

Steps to Contribute

• Clone this repo
• Make your changes
• Preview changes and clear errors by following our guide below
• Send us a pull request

Ways to Preview Changes and Build Site

Using Docker

• Install Docker

• Build a Docker image as per the Dockerfile included in this repo. You just need to run the command below (don't omit the dot at the end).

  docker build -t cryptomator_docs_image .
  

  Run the commands below in the repo's directory to start a Docker container based on the built image.

  For live preview:

  docker run -p 8000:8000 -v $(pwd)/source:/source -v $(pwd)/build:/build cryptomator_docs_image sphinx-autobuild -b html /source /build/html --host 0.0.0.0
  

  To build site:

  docker run -v $(pwd)/source:/source -v $(pwd)/build:/build cryptomator_docs_image sphinx-build -M html /source /build/html
  

Without Using Docker

• Install pip

• Install sphinx, sphinx_rtd_theme, and sphinx-autobuild

  pip install sphinx sphinx_rtd_theme sphinx-autobuild
  

  For live preview:

  make clean livehtml
  

  To build site:

  make clean html
  

docs's Issues

[Desktop] Reworking documentation for 1.6.0

• Health Check
• Vault Format 8
• Open vault
• Document vault options
• Known issues

Add hint that Cryptomator is case-sensitive

Description

When files on a cryptomator drive (via Dokany on an internal NTFS drive) are accessed through a name with differing case representation they cannot be found.

System Setup

• Operating system and version: Windows 10
• Cryptomator version: 1.5.3
• Drive: [Dokany/FUSE/WebDAV] Dokany

Steps to Reproduce

I tried NodeJS, but this shouldn't matter at all:

> let fs=require("fs")
> fs.writeFileSync("test.dat", "test")
> fs.readFileSync("test.dat")
<Buffer 74 65 73 74>
> fs.readFileSync("Test.dat")
Uncaught Error: ENOENT: no such file or directory, open 'Test.dat'
    at Object.openSync (fs.js:461:3)
    at Object.readFileSync (fs.js:364:35) {
  errno: -4058,
  syscall: 'open',
  code: 'ENOENT',
  path: 'Test.dat'
}

Expected Behavior

Well, files should be found and opened without error.

Actual Behavior

There's an "ENOENT" error.

Reproducibility

Always

Add info about character conversion

See cryptomator/cryptomator#938

Update security target

We had a FR/discussion on cryptomator about Cryptomator files should have an extension. Certain points from this discussion should be added to the security target section to make the users aware of it.

See cryptomator/cryptomator#915

[Desktop] Reworking the documentation for 1.5.0

This is a summary issue to indicate which workflows and/or concepts are already updated or created for version 1.5.x for Cryptomator:

• Creating vault
• Removing vault
• Deleting vault
• Changing password of vault
• Use recovery key of vault
• Open vault
• Document vault options
• Known issues
• Setup of Cryptomator

Add error support section

See crptomator/cryptomator#3060

Security Architecture: Details about versionMac calculation

It is noteworthy that when calculating the HMAC of the version field, version shall always be represented as 32 bit big endian integer, regardless of the system architecture.

Error while adding a vault

Hello,

I am trying to add a new vault, but getting this error after clicking on "Create Vault"

java.nio.file.FileAlreadyExistsException: C:\Users\prach\Google Drive\Vault
at java.base/sun.nio.fs.WindowsException.translateToIOException(Unknown Source)
at java.base/sun.nio.fs.WindowsException.rethrowAsIOException(Unknown Source)
at java.base/sun.nio.fs.WindowsException.rethrowAsIOException(Unknown Source)
at java.base/sun.nio.fs.WindowsFileSystemProvider.createDirectory(Unknown Source)
at java.base/java.nio.file.Files.createDirectory(Unknown Source)
at org.cryptomator.ui.addvaultwizard.CreateNewVaultPasswordController.next(CreateNewVaultPasswordController.java:113)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(Unknown Source)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.base/java.lang.reflect.Method.invoke(Unknown Source)
at com.sun.javafx.reflect.Trampoline.invoke(MethodUtil.java:76)
at jdk.internal.reflect.GeneratedMethodAccessor23.invoke(Unknown Source)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.base/java.lang.reflect.Method.invoke(Unknown Source)
at com.sun.javafx.reflect.MethodUtil.invoke(MethodUtil.java:273)
at com.sun.javafx.fxml.MethodHelper.invoke(MethodHelper.java:83)
at javafx.fxml.FXMLLoader$MethodHandler.invoke(FXMLLoader.java:1859)
at javafx.fxml.FXMLLoader$ControllerMethodEventHandler.handle(FXMLLoader.java:1729)
at com.sun.javafx.event.CompositeEventHandler.dispatchBubblingEvent(CompositeEventHandler.java:86)
at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:234)
at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:191)
at com.sun.javafx.event.CompositeEventDispatcher.dispatchBubblingEvent(CompositeEventDispatcher.java:59)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:58)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.EventUtil.fireEventImpl(EventUtil.java:74)
at com.sun.javafx.event.EventUtil.fireEvent(EventUtil.java:49)
at javafx.event.Event.fireEvent(Event.java:198)
at javafx.scene.Node.fireEvent(Node.java:8886)
at javafx.scene.control.Button.fire(Button.java:203)
at com.sun.javafx.scene.control.behavior.ButtonBehavior.mouseReleased(ButtonBehavior.java:208)
at com.sun.javafx.scene.control.inputmap.InputMap.handle(InputMap.java:274)
at com.sun.javafx.event.CompositeEventHandler$NormalEventHandlerRecord.handleBubblingEvent(CompositeEventHandler.java:247)
at com.sun.javafx.event.CompositeEventHandler.dispatchBubblingEvent(CompositeEventHandler.java:80)
at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:234)
at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:191)
at com.sun.javafx.event.CompositeEventDispatcher.dispatchBubblingEvent(CompositeEventDispatcher.java:59)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:58)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
at com.sun.javafx.event.EventUtil.fireEventImpl(EventUtil.java:74)
at com.sun.javafx.event.EventUtil.fireEvent(EventUtil.java:54)
at javafx.event.Event.fireEvent(Event.java:198)
at javafx.scene.Scene$MouseHandler.process(Scene.java:3856)
at javafx.scene.Scene.processMouseEvent(Scene.java:1851)
at javafx.scene.Scene$ScenePeerListener.mouseEvent(Scene.java:2584)
at com.sun.javafx.tk.quantum.GlassViewEventHandler$MouseEventNotification.run(GlassViewEventHandler.java:409)
at com.sun.javafx.tk.quantum.GlassViewEventHandler$MouseEventNotification.run(GlassViewEventHandler.java:299)
at java.base/java.security.AccessController.doPrivileged(Unknown Source)
at com.sun.javafx.tk.quantum.GlassViewEventHandler.lambda$handleMouseEvent$2(GlassViewEventHandler.java:447)
at com.sun.javafx.tk.quantum.QuantumToolkit.runWithoutRenderLock(QuantumToolkit.java:412)
at com.sun.javafx.tk.quantum.GlassViewEventHandler.handleMouseEvent(GlassViewEventHandler.java:446)
at com.sun.glass.ui.View.handleMouseEvent(View.java:556)
at com.sun.glass.ui.View.notifyMouse(View.java:942)
at com.sun.glass.ui.win.WinApplication._runLoop(Native Method)
at com.sun.glass.ui.win.WinApplication.lambda$runLoop$3(WinApplication.java:174)
at java.base/java.lang.Thread.run(Unknown Source)

Revise Documentation for 'Add Vault' Button Changes

See cryptomator/cryptomator#3082

Add Getting-Started Guides for the mobile applications

Currently only the desktop section has a getting started document.

If the docs are meant to be also step-by-step instructions, it would be nice if such documents also exist for the mobile applications to give the user a starting point into the software.

How to check installer signatures

We should document how to verify the integrity of an installer for

• .exe
• .dmg
• .AppImage

Unable to use a vault saved in macOS Finder's Favorites

I use Cryptomator on macOS 11.7.10 (Big Sur) with macFUSE. I'd like to know if there is a way to keep a usable Favorite in the Finder of one of my vaults.

Although I can create a Favorite (see Screenshot 1) that works initially, once I lock the vault, it cannot be used again after unlocking. Instead, attempting to use the Favorite will result in an error message saying that "the original item can't be found."

I realize that this may be a macFUSE problem, but I thought I would open this issue here to see if someone can shed light on it.

Screenshot 1

Screenshot 2

Windows + Python 3.8: Live Preview feature fails

This is a known bug in the sphinx-autobuild tool:
sphinx-doc/sphinx-autobuild#77

Document `dirId.c9r` file

With Cryptomator desktop release 1.6.9, on every directory creation the dirid.c9r file is created. We should document the purpose of it for the vault structure.