libcryfs/README.md

93 lines
2.7 KiB
Markdown
Raw Normal View History

2015-09-12 21:10:15 +02:00
# cryfs [![Build Status](https://travis-ci.org/cryfs/cryfs.svg?branch=master)](https://travis-ci.org/cryfs/cryfs)
2015-12-17 20:36:15 +01:00
CryFS encrypts your files, so you can safely store them anywhere. It works well together with cloud services like Dropbox, iCloud, OneDrive and others.
See https://www.cryfs.org
This repository contains the filesystem implementation. There are submodules in the following repositores:
- [Blockstore](https://github.com/cryfs/blockstore): Store (encrypted) fixed-size blocks of data in different backends
- [Blobstore](https://github.com/cryfs/blobstore): Store resizeable blobs of data using blocks from a blockstore
- [ParallelAccessStore](https://github.com/cryfs/parallelaccessstore): Concurrency primitive for Blockstore/Blobstore
- [Fs++](https://github.com/cryfs/fspp): Implement a file system against a platform independent interface
2015-09-12 20:57:38 +02:00
Install latest release
2015-12-17 19:49:06 +01:00
======================
Easy install (Ubuntu and Debian)
--------------------------------
2015-12-18 04:27:12 +01:00
wget -O - https://www.cryfs.org/install.sh | sudo bash
2015-12-17 19:49:06 +01:00
Manual install (Ubuntu)
-----------------------
# Add apt key
2015-12-18 04:27:12 +01:00
wget -O - https://www.cryfs.org/apt.key | sudo apt-key add -
2015-12-17 19:49:06 +01:00
# Add apt repository
sudo sh -c "echo \"deb http://apt.cryfs.org/ubuntu `lsb_release -s -c` main\" > /etc/apt/sources.list.d/cryfs.list"
2015-12-17 19:49:06 +01:00
# Install cryfs
sudo apt-get update
sudo apt-get install cryfs
Manual install (Debian)
-----------------------
# Add apt key
2015-12-18 04:27:12 +01:00
wget -O - https://www.cryfs.org/apt.key | sudo apt-key add -
2015-12-17 19:49:06 +01:00
# Add apt repository
sudo sh -c "echo \"deb http://apt.cryfs.org/debian `lsb_release -s -c` main\" > /etc/apt/sources.list.d/cryfs.list"
2015-12-17 19:49:06 +01:00
# Install cryfs
sudo apt-get update
sudo apt-get install cryfs
2015-09-29 15:47:05 +02:00
Building from source
====================
Requirements
------------
2015-10-26 02:32:42 +01:00
- [biicode](https://www.biicode.com/downloads)
2015-09-29 15:47:05 +02:00
2015-10-26 02:32:42 +01:00
# After installing, call
2015-09-29 15:47:05 +02:00
$ bii setup:cpp
2015-11-24 15:13:02 +01:00
- GCC version >= 4.8 or Clang (TODO which minimal version?)
2015-12-17 19:49:06 +01:00
- libFUSE >= 2.8.6 (including development headers)
2015-09-29 15:47:05 +02:00
# Ubuntu
$ sudo apt-get install libfuse-dev
# Fedora
TODO
# Macintosh
TODO
2015-09-29 15:47:05 +02:00
Build
-----
1. Clone repository
$ git clone git@github.com:cryfs/cryfs.git cryfs
$ cd cryfs
2. Build
$ bii init -L
$ bii configure -D CMAKE_BUILD_TYPE=Release
$ bii build
2015-10-28 22:10:46 +01:00
3. (if build failed) Biicode can have a bug sometimes where the first call to configure fails. If that happens, just call it again.
2015-09-29 15:47:05 +02:00
2015-10-28 22:10:46 +01:00
4. Install
2015-10-26 20:44:00 +01:00
$ cd bii/build/messmer_cryfs
$ sudo make install
2015-09-29 15:47:05 +02:00
You can pass normal make parameters after a double dash.
This can for example be used to add "-j5" to compile with 5 build threads in parallel:
$ bii build -- -j5