docs/quickstart.md


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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

Quickstart
==========

Download or Compile gocryptfs
-----------------------------

Precompiled binaries that work on **all** x86_64 Linux systems are
available for download from the
[github releases page](https://github.com/rfjakob/gocryptfs/releases).

On Debian, gocryptfs is available as
[a deb package](https://packages.debian.org/search?keywords=gocryptfs&searchon=names&suite=all&section=all):

    $ apt install gocryptfs

On MacOS, [gocryptfs is available on MacPorts](https://ports.macports.org/port/gocryptfs/details/):

    $ port install gocryptfs

On Fedora, gocryptfs is available as
[an rpm package](https://src.fedoraproject.org/rpms/golang-github-rfjakob-gocryptfs):

    $ sudo dnf install gocryptfs

gocryptfs is available in many other distributions in the following
versions:

[![Packaging status](https://repology.org/badge/vertical-allrepos/gocryptfs.svg?columns=4)](https://repology.org/project/gocryptfs/versions)

[![Packaging status](https://repology.org/badge/vertical-allrepos/go:github-rfjakob-gocryptfs.svg?columns=5&header=Packaging Status II)](https://repology.org/project/go:github-rfjakob-gocryptfs/versions)


If you want to compile from source, see the [Compile](compile.md) page for
instructions.

Once you have gocrypts installed, running

	$ gocryptfs -version

should print a version string like this:

    gocryptfs v1.4.3; go-fuse v20170619-28-g19acbd2; 2018-02-01 go1.9.2

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

	$ mkdir cipher plain
	$ gocryptfs -init cipher
	  [...]
	$ gocryptfs cipher plain
	  [...]

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

Cloud Storage
-------------

When you want to store your encrypted data on cloud storage (Dropbox in this example),
the `cipher` folder should be inside the `Dropbox` folder but the `plain` folder
should be **outside**! Example:

    $ mkdir ~/Dropbox/cipher
    $ mkdir ~/plain
    $ gocryptfs -init ~/Dropbox/cipher
    $ gocryptfs ~/Dropbox/cipher ~/plain

This makes sure that Dropbox only syncs the encrypted version of your data.