https://github.com/fbartels/rclone-encfs-wrapper
Wrapper script that uses an encfs reverse mount to encrypt before upload
https://github.com/fbartels/rclone-encfs-wrapper
Last synced: 8 months ago
JSON representation
Wrapper script that uses an encfs reverse mount to encrypt before upload
- Host: GitHub
- URL: https://github.com/fbartels/rclone-encfs-wrapper
- Owner: fbartels
- License: agpl-3.0
- Created: 2016-08-03T05:53:25.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-09T17:20:34.000Z (almost 10 years ago)
- Last Synced: 2025-05-13T17:39:08.971Z (about 1 year ago)
- Language: Shell
- Size: 22.5 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rclone-encfs-wrapper
Wrapper script that uses an encfs reverse mount to encrypt before upload.
PLEASE NOTICE: EncFS is regarded as potentially unsecure, since an attacker that has multiple copies of the same scnrypted file might be able to calculate the encryption key. Please see https://defuse.ca/audits/encfs.htm for more information.
I have put some words of reasoning behind this wrapper into a [blog post](http://blog.host-consultants.de/2016/08/backups-in-die-amazon-cloud-schieben/) (in german). If you are looking for a way to mount your cloud backup have a look at my [mount-encfs-cloud](https://github.com/fbartels/mount-encfs-cloud) script.
# Setup & usage
The script requires that encfs and [rclone](https://github.com/ncw/rclone) are already installed, [rclone is configured](http://rclone.org/docs/) and will fail if these requirements are not met.
## Configuration
Additionally the ```config-example``` file has to be renamed to ```config``` and adapted to the local environment.
```
SOURCECLEARTEXT=/backup/data # local directory that should be backed up
RCLONE_REMOTE="acd" # name of the remote configured in rclone
RCLONE_PATH="backup" # directory at cloud provider, will be created if it does not exist
ENCFS_PASSWORD=$HOME/.config/encfs-password
ENCFS_CONFIG=$HOME/.config/encfs-cloud.xml
```
```RCLONE_REMOTE``` must be the name of a valid configured storage provider (you can configure multiple storage providers in rclone). Please make a separate Backup of ```ENCFS_PASSWORD``` and ```ENCFS_CONFIG```, since you cannot access your offsite data without these. These both files will be automatically created on the first run of the script.
If you are running multiple backup jobs from the same machine the you can also specify a different configuration at runtime. The syntax is as followed:
```
BACKUP_CONFIG=config-test ./rclone-encfs-wrapper.sh
```