1
<!-- -*- markdown -*- -->
3
<!-- = Flattr gnome-encfs at https://flattr.com/thing/142770/gnome-encfs = -->
4
<p style="float: right;"><a href="https://flattr.com/thing/142770/gnome-encfs"
5
target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png"
6
alt="Flattr this" title="Flattr this" border="0" /></a></p>
7
<!-- ===================================================================== -->
12
*gnome-encfs* integrates [EncFS][efs] folders into the GNOME desktop by storing
13
their passwords in the [keyring][gkr] and optionally mounting them at login
14
using GNOME's autostart mechanism.
16
*gnome-encfs* allows you to use strong passwords for EncFS folders while still
17
mounting them painlessly (i.e. no password prompt). This is an advantage over
18
automount solutions like *pam-encfs* and *pam-mount* which require to use the
19
same password for EncFS folders as for your local user account. This is bad
20
because local account passwords usually are weaker than those one should use
21
for encrypting online stored data, e.g. in a [Dropbox][dbx].
26
Download the [package][dlp] *or* checkout the source:
28
$ hg clone http://bitbucket.org/obensonne/gnome-encfs
33
$ cd /path/to/gnome-encfs
34
$ install gnome-encfs /usr/local/bin
36
**Note:** You can run *gnome-encfs* right from the extracted package but to
37
make use of the automount feature at GNOME login, it must be placed somewhere
38
in *PATH* (as configured during a login to GNOME). Using the install command
39
above ensures this requirement is fulfilled.
44
### Add an EncFS folder
46
Suppose you have an EncFS folder at `~/.Private.encrypted` which should get
47
mounted to `~/Private`. Make it known to *gnome-encfs*:
49
$ gnome-encfs -a ~/.Private.encrypted ~/Private
50
EncFS password: <enter encfs password>
51
Mount at login [Y/n]: <say 'y' or 'n'>
53
This adds the EncFS path, its mount location and password to the GNOME keyring
54
and sets up a GNOME autostart entry to mount it at GNOME login (if enabled).
56
### Mount an EncFS folder
58
If you said *y* above to the login mount question, the EncFS folder gets
59
mounted automatically at GNOME login. If you prefer to mount on demand, you do
62
$ gnome-encfs -m ~/Private
64
which looks up the password in the keyring and does the mounting without
65
the need to enter the password manually.
67
Unmount as usual, using *fusermount*:
69
$ fusermount -u ~/Private
73
You can also show, edit and remove EncFS folders handled by *gnome-enfs*:
77
Usage: gnome-encfs --list
78
gnome-encfs --mount [ENCFS-PATH-or-MOUNT-POINT]
79
gnome-encfs --add ENCFS-PATH MOUNT-POINT
80
gnome-encfs --edit MOUNT-POINT
81
gnome-encfs --remove MOUNT-POINT
83
Painlessly mount and manage EncFS folders using GNOME's keyring.
86
--version show program's version number and exit
87
-h, --help show this help message and exit
88
-l, --list list all EncFS items stored in keyring
89
-m, --mount mount all or selected EncFS paths stored in keyring
90
-a, --add add a new EncFS item to keyring
91
-e, --edit edit an EncFS item in keyring
92
-r, --remove remove an EncFS item from keyring
95
Usage should be straight forward - otherwise [submit an issue][itr].
97
### Automatically unmount EncFS folders on logout
99
Unfortunately there's no equivalent to GNOME's autostart scripts which could be
100
used to automatically unmount your EncFS folders on logout (without shutting
101
down). However, there's a manual solution using a [GDM hook script][gdm]:
102
`/etc/gdm/PostSession/Default`. Open this file in an editor (requires *root*
103
privileges) and add these lines:
105
mount -t fuse.encfs | grep "user=$USER" | awk '{print $3}' | while read MPOINT ; do
106
sudo -u $USER fusermount -u "$MPOINT"
109
This script is executed whenever you logout from GNOME. With this line, it
110
looks for mounted EncFS folders of the user currently logging out. Then it
111
unmounts each, using the `fusermount` command (note that this command is
112
executed as *root*, that's why there is a `sudo -u $USER` before the
113
`fusermount` command).
115
This works independent of *gnome-encfs*, i.e. it unmounts **any** EncFS folder
116
of the user logging out.
121
*gnome-encfs* is licensed as [GPL][gpl].
123
[dbx]: http://dropbox.com
124
[dlp]: http://bitbucket.org/obensonne/gnome-encfs/get/tip.tar.gz
125
[efs]: http://www.arg0.net/encfs
126
[gdm]: http://library.gnome.org/admin/gdm/stable/configuration.html
127
[gkr]: http://live.gnome.org/GnomeKeyring
128
[gpl]: http://www.gnu.org/licenses/gpl.html
129
[itr]: http://bitbucket.org/obensonne/gnome-encfs/issues/?status=new&status=open
added
removed
README
