https://github.com/bulletmark/encfsui
Encrypted filesystem encfs GUI wrapper.
https://github.com/bulletmark/encfsui
encfs
Last synced: about 1 year ago
JSON representation
Encrypted filesystem encfs GUI wrapper.
- Host: GitHub
- URL: https://github.com/bulletmark/encfsui
- Owner: bulletmark
- Created: 2010-10-16T05:41:54.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2023-12-29T22:52:44.000Z (over 2 years ago)
- Last Synced: 2024-05-09T08:17:24.978Z (about 2 years ago)
- Topics: encfs
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 12
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ENCRYPTED FILESYSTEM [ENCFS](http://www.arg0.net/encfs) GUI WRAPPER
[](https://aur.archlinux.org/packages/encfsui/)
_**Note: This project is still maintained but has essentially been
superceded by [gocryptfs-ui](https://github.com/bulletmark/gocryptfs-ui)
which uses [gocryptfs](https://github.com/rfjakob/gocryptfs) rather than
[encfs](http://www.arg0.net/encfs) because [encfs development is now
dormant](https://github.com/vgough/encfs#status). It is recommended that
users of [encfsui](https://github.com/bulletmark/encfsui)
migrate to
[gocryptfs-ui](https://github.com/bulletmark/gocryptfs-ui)**_.
[Encfsui](https://github.com/bulletmark/encfsui) is a bash script which
provides a simple gui around the
[encfs](http://www.arg0.net/encfs) command line utility to mount
and unmount an encrypted directory. This script requires
[encfs](http://www.arg0.net/encfs),
[zenity](http://live.gnome.org/Zenity), and
[xdg-open](http://portland.freedesktop.org/wiki/).
Whenever you want to mount your private directory, you click on the
desktop launcher. The launcher runs the script with appropriate
directory arguments. The script uses
[zenity](http://live.gnome.org/Zenity) to prompt you for the password
and then mounts the [encfs](http://www.arg0.net/encfs) directory. If you
click on the launcher when the private directory is already mounted,
then you are prompted to unmount it. The prompt windows are [displayed
in the wiki](https://github.com/bulletmark/encfsui/wiki). There are
some other options, see the usage below.
My motivation for creating this utility is to provide:
1. One mouse click and password entry to access and open a single
encrypted personal directory.
2. One mouse click to close the directory.
3. No background application running.
4. No password cached anywhere.
The latest version and documentation is available at
http://github.com/bulletmark/encfsui.
### INSTALLATION
NOTE: Arch users can just install [_encfsui from the
AUR_](https://aur.archlinux.org/packages/encfsui/) and skip to the next
section. Other users can install by running:
# Install encfs zenity xdg-utils
git clone http://github.com/bulletmark/encfsui
cd encfsui
sudo make install (or sudo ./encfsui-setup install)
### USAGE
The installation procedure creates a desktop application _encfsui_ which
you can run from your DE. By default, _encfsui_ mounts your encrypted
`~/.Private` dir to unencrypted `~/Private` with an in-activity timeout
of 60 minutes. So you should first create an
[encfs](http://www.arg0.net/encfs) `~/.Private` directory, or create a
link to there from where you keep your encrypted directory. See [`man
encfs`](https://linux.die.net/man/1/encfs) for details on how to create
a new encrypted directory.
You can also copy the `/usr/share/applications/encfsui.desktop` launcher
to your own Desktop Launcher in `~/.local/share/applications/` to use
different source or target directory names, or to change the timeout,
etc.
The utility can also be run from the command line. The usage is:
encfsui [-options] source_enc_dir target_mount_dir
GUI utility to mount source_enc_dir to target_mount_dir.
If target already mounted then it will be unmounted instead.
Options:
-i specify idle timeout mins
-p (make public mount, can only be done by root)
-o (don't open target dir in gui mode)
### CLEANUP OF OLD CONFIGURATION
Note that _encfsui_ now installs system-wide but old versions installed
as local user files so to ensure that any old user configuration is
removed type the following as your normal user (i.e. not sudo/root).
encfsui-setup clean
You can type this any time so no harm is done running it to make sure.
### UPGRADE
cd encfsui # Source dir, as above
git pull
sudo make install (or sudo ./encfsui-setup install)
### LICENSE
Copyright (C) 2012 Mark Blakeney. This program is distributed under the
terms of the GNU General Public License.
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or any later
version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License at for more details.