diff options
author | Jakob Unterwurzacher | 2018-12-16 18:56:29 +0100 |
---|---|---|
committer | Jakob Unterwurzacher | 2018-12-16 18:56:29 +0100 |
commit | 3f2923f00e33f5f7cc2a4f5edb93e95c4139d9ca (patch) | |
tree | bd0c124cc20621316c3cbc92cee8ab03b7a0ca82 | |
parent | 540621db2a8c1967d8ec8fe4757ce98411d6a2df (diff) |
Simplify compile page
-rw-r--r-- | docs/compile.md | 43 |
1 files changed, 14 insertions, 29 deletions
diff --git a/docs/compile.md b/docs/compile.md index 67da722..1534382 100644 --- a/docs/compile.md +++ b/docs/compile.md @@ -1,48 +1,33 @@ Compile gocryptfs from Source ============================= -You need to have the Go runtime and the OpenSSL headers installed to -compile gocryptfs. +Three-line summary: -On Fedora, + go get -d github.com/rfjakob/gocryptfs + cd $(go env GOPATH)/src/github.com/rfjakob/gocryptfs + ./build.bash - $ sudo dnf install golang openssl-devel +build.bash needs Go 1.7+ and the OpenSSL headers installed +(Debian: `apt install golang libssl-dev`, Fedora: `dnf install golang openssl-devel`). -On Debian and Ubuntu, - - $ sudo apt-get install golang libssl-dev - -Also, `GOPATH` must be set. Usually it is set to the `go` folder in -your home directory: - - $ export GOPATH=$HOME/go - -Download Source Code --------------------- - -Download the gocryptfs source code and dependencies using `go get`: - - $ go get -d github.com/rfjakob/gocryptfs - -And `cd` into the gocryptfs source directory: +If successful, `build.bash` copies the `gocryptfs` binary to `~/bin`. - $ cd $GOPATH/src/github.com/rfjakob/gocryptfs +Alternatively, you can compile a static binary without OpenSSL using: -Compile -------- + ./build-without-openssl.bash -In the gocryptfs source directory, run: +This is the recommended way to compile on MacOS, and also how the official +[binary releases](https://github.com/rfjakob/gocryptfs/releases) are compiled. - $ ./build.bash - -If successful, `build.bash` copies the `gocryptfs` binary to `~/bin`. +Note that having OpenSSL speeds up encryption on CPUs *without* AES-NI +by a factor of 4. Run `gocryptfs -speed` to check your CPU. Test ---- In the gocryptfs source directory, run: - $ ./test.bash + ./test.bash The tests run about 1 minute and should produce the following output: |