Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mhogomchungu committed Dec 1, 2020
1 parent ba7368c commit 1c9a652
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@

To make SiriKali aware of cryptomator-cli, download cryptomator-cli.jar file from the release page and put it
in "$HOME/.bin" folder if you want to place it in your home directory or in traditional paths for executables
like "/usr/bin" or "/usr/local/bin".

This project is a fork of https://github.com/cryptomator/cli and currently, it adds the following functionality:-

1. "--version" argument to print version information.
2. "--mountFlags" argument to add FUSE options.
3. "--foreground" argument to cause the program to run in the foreground.
Not adding the feature causes the program to run daemonized(currently not supported)
Not adding the feature causes the program to run daemonized(currently not supported).
4. A preffered way to lock a vault is by using "fusermount -u $MOUNT_POINT_PATH" and not sending SIGTERM signal.
The benefit of this approach is fusermount's ability to notice if the mount point is in use or not and to refuse to
unmount if it is. The SIGTERM approach just nukes the process even when mount points are in use and this may
Expand Down

0 comments on commit 1c9a652

Please sign in to comment.