Skip to content

Commit c6e40a3

Browse files
committed
updated README
[ci skip]
1 parent 9d67cce commit c6e40a3

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

README.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33

44
# Cryptomator CLI
55

6-
This is a minimal command-line program that unlocks vaults of vault format 8.
7-
After the unlock the vault content can then be accessed via an embedded WebDAV server.
8-
The minium required Java version is JDK 17.
6+
This is a minimal command-line application that unlocks vaults of vault format 8.
7+
After unlocking the vaults, its vault content can be accessed via an embedded WebDAV server.
8+
The minimum required Java version is JDK 17.
99

1010
## Disclaimer
1111

12-
This project is in an early stage and not ready for production use. We recommend to use it only for testing and evaluation purposes.
12+
:warning: This project is in an early stage and not ready for production use. We recommend using it only for testing and evaluation purposes.
1313

1414
## Download and Usage
1515

16-
Download the jar file via [GitHub Releases](https://github.com/cryptomator/cli/releases).
16+
Download the JAR file via [GitHub Releases](https://github.com/cryptomator/cli/releases).
1717

1818
Cryptomator CLI requires that at least JDK 17 is present on your system.
1919

@@ -23,64 +23,67 @@ java -jar cryptomator-cli-x.y.z.jar \
2323
--vault otherVault=/path/to/differentVault --passwordfile otherVault=/path/to/fileWithPassword \
2424
--vault thirdVault=/path/to/thirdVault \
2525
--bind 127.0.0.1 --port 8080
26-
# You can now mount http://localhost:8080/demoVault/,
27-
# The password for the thirdVault is read from stdin.
28-
# Be aware that passing the password on the commandline typically makes it visible to anyone on your system!
26+
# You can now mount http://localhost:8080/demoVault/
27+
# The password for the third vault is read from stdin
28+
# Be aware that passing the password on the command-line typically makes it visible to anyone on your system!
2929
```
3030

31-
## Filesystem integration
31+
## Filesystem Integration
3232

33-
Once the vault is unlocked and the webserver started, you can access the vault by any webdav client or directly mounting it in your filesystem.
33+
Once the vault is unlocked and the WebDAV server started, you can access the vault by any WebDAV client or directly mounting it in your filesystem.
3434

35-
### Windows via the Windows Explorer GUI
35+
### Windows via Windows Explorer
3636

3737
Open the File Explorer, right click on "This PC" and click on the menu item "Map network drive...".
38-
In the window opening up, select a free drive letter as the mounting point, enter in the Folder text box the url logged by the cli application to the terminal window and click the "Finish" button.
38+
39+
1. In the Drive list, select a drive letter. (Any available letter will do.)
40+
2. In the Folder box, enter the URL logged by the Cryptomator CLI application.
41+
3. Select Finish.
3942

4043
### Linux via davfs2
4144

42-
First, you need to create a mount point for your vault
45+
First, you need to create a mount point for your vault:
4346

4447
```sh
4548
sudo mkdir /media/your/mounted/folder
4649
```
4750

48-
Then you can mount the vault
51+
Then you can mount the vault:
4952

5053
```sh
5154
echo | sudo mount -t davfs -o username=,user,gid=1000,uid=1000 http://localhost:8080/demoVault/ /media/your/mounted/folder
5255
# Replace gid/uid with your gid/uid. The echo is used to skip over the password query from davfs
5356
```
5457

55-
To unmount the vault, run
58+
To unmount the vault, run:
5659

5760
```sh
5861
sudo umount /media/your/mounted/folder
5962
```
6063

6164
### macOS via AppleScript
6265

63-
Mount the vault with
66+
Mount the vault with:
6467

6568
```sh
6669
osascript -e 'mount volume "http://localhost:8080/demoVault/"'
6770
```
6871

69-
Unmount the vault with
72+
Unmount the vault with:
7073

7174
```sh
7275
osascript -e 'tell application "Finder" to if "demoVault" exists then eject "demoVault"'
7376
```
7477

75-
## Using as a docker image
78+
## Using as a Docker image
7679

77-
### Bridge networking with port forward:
80+
### Bridge Network with Port Forwarding
7881

7982
:warning: **WARNING: This approach should only be used to test the containerized approach, not in production.** :warning:
8083

81-
The reason is that with port forwarding you need to listen on all interfaces, and potencially other devices on the network could also access your WebDAV server exposing your secret files.
84+
The reason is that with port forwarding, you need to listen on all interfaces. Other devices on the network could also access your WebDAV server and potentially expose your secret files.
8285

83-
Ideally you would run this in a private docker network with trusted containers built by yourself communicating with each other. **Again, the below example is for testing purposes only to understand how the container would behave in production.**
86+
Ideally, you would run this in a private Docker network with trusted containers built by yourself communicating with each other. **Again, the below example is for testing purposes only to understand how the container would behave in production.**
8487

8588
```sh
8689
docker run --rm -p 8080:8080 \
@@ -91,10 +94,10 @@ docker run --rm -p 8080:8080 \
9194
--bind 0.0.0.0 --port 8080 \
9295
--vault demoVault=/vaults/vault --password demoVault=topSecret \
9396
--vault otherVault=/vaults/differentVault --passwordfile otherVault=/passwordFile
94-
# you can now mount http://localhost:8080/demoVault/
97+
# You can now mount http://localhost:8080/demoVault/
9598
```
9699

97-
### Host networking:
100+
### Host Network
98101

99102
```sh
100103
docker run --rm --network=host \
@@ -105,12 +108,11 @@ docker run --rm --network=host \
105108
--bind 127.0.0.1 --port 8080 \
106109
--vault demoVault=/vaults/vault --password demoVault=topSecret \
107110
--vault otherVault=/vaults/differentVault --passwordfile otherVault=/passwordFile
108-
# you can now mount http://localhost:8080/demoVault/
111+
# You can now mount http://localhost:8080/demoVault/
109112
```
110113

111114
Then you can access the vault using any WebDAV client.
112115

113-
114116
## License
115117

116118
This project is dual-licensed under the AGPLv3 for FOSS projects as well as a commercial license derived from the LGPL for independent software vendors and resellers. If you want to use this library in applications, that are *not* licensed under the AGPL, feel free to contact our [support team](https://cryptomator.org/help/).

0 commit comments

Comments
 (0)