gnome-encfs / README

-*- markdown -*-

gnome-encfs
===========

*gnome-encfs* integrates [EncFS][1] folders into the GNOME desktop by storing
their passwords in the [keyring][2] and optionally mounting them at login using
GNOME's autostart mechanism.

*gnome-encfs* allows you to use strong passwords for EncFS folder while still
mounting them painlessly (i.e. no password prompt).
This is an advantage over automount solutions like *pam-encfs* and *pam-mount*
which require to use the same password for EncFS folders as for your local user
account. This is bad because local account passwords usually are weaker than
those one should use for encrypting online stored data, e.g. in a [Dropbox][5].

Download
--------

Download the [package][3] *or* checkout the source:

    $ hg clone http://bitbucket.org/obensonne/gnome-encfs

Installation
------------

    $ cd /path/to/gnome-encfs
    $ install gnome-encfs /usr/local/bin
    
**Note:** You can run *gnome-encfs* right from the extracted package but to make
use of the automount feature at GNOME login, it must be placed in your *PATH*
as it is configured during a login to GNOME. Using the install command above
ensures this requirement is fulfilled.

Usage
-----

It is expected that you already created one or more EncFS folders.

### Add an EncFS folder 

Add an EncFS folder at `~/.Private.encrypted` which should get mounted to
`~/Private`.

    $ gnome-encfs -a ~/.Private.encrypted ~/Private
    > EncFS password: <enter encfs password>
    > Mount at login [Y/n]: <say 'y' or 'n'>
    
This adds the encfs path, its mount location and password to the GNOME keyring
and sets up a GNOME autostart item to mount it at GNOME login (if enabled).  

### Mount an EncFS folder

If you said *y* above to the login mount question, the EncFS folder
gets mounted automatically at GNOME login. If you prefer to mount on demand,
you do that with

     $ gnome-encfs -m ~/Private

which looks up the password in the keyring and does the mounting without
the need to enter the password manually.

### Other stuff

You can also  show, edit and remove EncFS folders handled by *gnome-enfs*.
Inspect

    $ gnome -h
    
for some instructions. Usage should be straight forward - if not,
[submit an issue][7].

License
-------

*gnome-encfs* is licensed as [GPL][6].

[1]: http://www.arg0.net/encfs
[2]: http://live.gnome.org/GnomeKeyring
[3]: 
[4]: 
[5]: http://dropbox.com
[6]: http://www.gnu.org/licenses/gpl.html
[7]: http://bitbucket.org/obensonne/gnome-encfs/issues/?status=new&status=open
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.