aboutsummaryrefslogtreecommitdiff
path: root/docs/quickstart.md
blob: a5dd19fc5dad092008abfa1d6949c7d63bc9ef6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
gocryptfs Quickstart
====================

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=$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

Create and Mount Filesystem
---------------------------

	$ mkdir cipher plain
	$ ~/bin/gocryptfs -init cipher
	  [...]
	$ ~/bin/gocryptfs cipher plain
	  [...]
	$ echo test > plain/test.txt
	$ ls cipher
	  gocryptfs.conf  gocryptfs.diriv  ZSuIZVzYDy5-TbhWKY-ciA==