libcryfs/README.md

84 lines
2.3 KiB
Markdown
Raw Normal View History

2016-02-11 19:58:02 +01: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.
2016-01-31 21:44:32 +01:00
See [https://www.cryfs.org](https://www.cryfs.org).
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-11-24 15:13:02 +01:00
- GCC version >= 4.8 or Clang (TODO which minimal version?)
2016-01-27 12:15:21 +01:00
- CMake version >= 3.3
- libcurl4 (including development headers)
- Boost libraries version >= 1.56 (including development headers)
- filesystem
- system
- chrono
- program_options
- thread
- Crypto++ version >= 5.6.3 (including development headers) (TODO Lower minimal version possible?)
- libFUSE version >= 2.8.6 (including development headers)
You can use the following commands to install these requirements
2015-09-29 15:47:05 +02:00
# Ubuntu
$ sudo apt-get install libcurl4-openssl-dev libboost-filesystem-dev libboost-system-dev libboost-chrono-dev libboost-program-options-dev libboost-thread-dev libcrypto++-dev libfuse-dev
# Fedora
TODO
# Macintosh
TODO
2015-09-29 15:47:05 +02:00
Build
-----
1. Clone repository
2016-02-11 19:58:55 +01:00
$ git clone https://github.com/cryfs/cryfs.git cryfs
2015-09-29 15:47:05 +02:00
$ cd cryfs
2. Build
$ mkdir cmake && cd cmake
$ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off
$ make
2015-10-28 22:10:46 +01:00
3. Install
2015-10-26 20:44:00 +01:00
$ sudo make install