diff options
| -rw-r--r-- | docs/comparison.md | 17 | ||||
| -rw-r--r-- | docs/compile.md | 43 | ||||
| -rw-r--r-- | docs/quickstart.md | 40 |
3 files changed, 71 insertions, 29 deletions
diff --git a/docs/comparison.md b/docs/comparison.md index 014b87d..69ac11a 100644 --- a/docs/comparison.md +++ b/docs/comparison.md @@ -122,11 +122,12 @@ Disk Space Efficiency (all file sizes in bytes) -| | gocryptfs | encfs default | encfs paranoia | ecryptfs | cryptomator | -| -------------------- | --------- | ------------- | -------------- | --------- | --------------------- | -| Empty file | 0 | 0 | 0 | 8,192 | 104 - 4,231 | -| 1 byte file | 51 | 9 | 17 | 12,288 | 104 - 4,231 | -| 1,000,000 bytes file | 1,007,858 | 1,000,008 | 1,007,888 | 1,011,712 | 1,001,096 - 1,101,192 | -| | | | | | | - -Note: cryptomator adds a random padding which is why the resulting size is non-deterministic. +| | gocryptfs | encfs default | encfs paranoia | ecryptfs | cryptomator | +| -------------------- | --------- | ------------- | -------------- | --------- | ------------------------- | +| Empty file | 0 | 0 | 0 | 8,192 | 104 - 4,231 | +| 1 byte file | 51 | 9 | 17 | 12,288 | 104 - 4,231 | +| 1,000,000 bytes file | 1,007,858 | 1,000,008 | 1,007,888 | 1,011,712 | 1,001,096 - 1,101,192 [1] | + +Notes: cryptomator adds a random padding which is why the resulting size is non-deterministic. + +[[1]](https://github.com/cryptomator/cryptomator/issues/128#issuecomment-169056079) diff --git a/docs/compile.md b/docs/compile.md new file mode 100644 index 0000000..b79a0d4 --- /dev/null +++ b/docs/compile.md @@ -0,0 +1,43 @@ +Compile gocryptfs from Source +============================= + +You need to have the Go runtime and the OpenSSL headers installed to +compile gocryptfs. + +On Fedora, + + $ sudo dnf install golang openssl-devel + +On Debian and Ubuntu, + + $ sudo apt-get install golang libssl-dev + +Also, GOPATH must be set. Usually it is simply set to the home directory: + + $ export GOPATH=~ + +Download Source Code +-------------------- + + $ go get -d github.com/rfjakob/gocryptfs + +Compile +------- + + $ ~/src/github.com/rfjakob/gocryptfs/build.bash + +If successful, build.bash will copy the gocryptfs binary to ~/bin. + +Test +---- + + $ ~/src/github.com/rfjakob/gocryptfs/test.bash + +The tests run about 1 minute and should produce the following output: + + ok github.com/rfjakob/gocryptfs/cryptfs 1.174s + gocryptfs v0.7-15-gf01f599; on-disk format 2 + ok github.com/rfjakob/gocryptfs/integration_tests 12.409s + +You can run "test.bash -v" to see the execution of individual tests. Note that +the tests also check error cases that produce error messages. diff --git a/docs/quickstart.md b/docs/quickstart.md index a5dd19f..47c2d67 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,31 +1,25 @@ gocryptfs Quickstart ==================== -You need to have the Go runtime and the OpenSSL headers installed to -compile gocryptfs. +Download or Compile gocryptfs +----------------------------- -On Fedora, +If you are running Fedora or a Debian-based Linux distribution like Ubuntu, +chances are that the precompiled binaries will work on your system. +Download the corresponding binary for your system from the +[github releases page](https://github.com/rfjakob/gocryptfs/releases) and +extract the archive into `~/bin`. - $ sudo dnf install golang openssl-devel +If you want or need to compile from source, see the [Compile](compile.md) page for +instructions. -On Debian and Ubuntu, +Once you have gocrypts in `~/bin`, running - $ sudo apt-get install golang libssl-dev + $ ~/bin/gocryptfs -version -Also, GOPATH must be set. Usually it is simply set to the home directory: +should print a version string like this: - $ export GOPATH=$HOME - -Download -------- - - $ go get -d github.com/rfjakob/gocryptfs - -Compile -------- - - $ ~/src/github.com/rfjakob/gocryptfs/build.bash - $ mkdir -p ~/bin && cp ~/src/github.com/rfjakob/gocryptfs/gocryptfs ~/bin + gocryptfs v0.x; on-disk format 2 Create and Mount Filesystem --------------------------- @@ -35,7 +29,11 @@ Create and Mount Filesystem [...] $ ~/bin/gocryptfs cipher plain [...] - $ echo test > plain/test.txt + +You should now have a working gocryptfs that is stored in `cipher` and mounted to `plain`. +You can verify it by creating a test file in the `plain` directory. This file will show +up encrypted in the `cipher` directory. + + $ touch plain/test.txt $ ls cipher gocryptfs.conf gocryptfs.diriv ZSuIZVzYDy5-TbhWKY-ciA== - |