Sebastian Messmer c22a25da73 Add AppVeyor Badge

2018-09-16 03:21:41 -07:00

5.1 KiB

Raw Blame History

CryFS

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.

Install latest release

This only works for Ubuntu 17.04 and later, and Debian Stretch and later. You can also use CryFS on older versions of these distributions by following the Building from source instructions below.

sudo apt install cryfs

GUI

Theres some GUI applications with CryFS support. You usually have to install the GUI and also CryFS itself for it to work.

SiriKali
Plasma Vault in KDE Plasma >= 5.11

Building from source

Requirements

Git (for getting the source code)
GCC version >= 5.0 or Clang >= 4.0
CMake version >= 3.0
libcurl4 (including development headers)
Boost libraries version >= 1.56 (including development headers)
- filesystem
- system
- chrono
- program_options
- thread
SSL development libraries (including development headers, e.g. libssl-dev)
libFUSE version >= 2.8.6 (including development headers), on Mac OS X instead install osxfuse from https://osxfuse.github.io/
Python >= 2.7
OpenMP

You can use the following commands to install these requirements

    # Ubuntu
    $ sudo apt-get install git g++ cmake make libcurl4-openssl-dev libboost-filesystem-dev libboost-system-dev libboost-chrono-dev libboost-program-options-dev libboost-thread-dev libssl-dev libfuse-dev python

    # Fedora
    sudo dnf install git gcc-c++ cmake make libcurl-devel boost-devel boost-static openssl-devel fuse-devel python

    # Macintosh
    brew install cmake boost openssl libomp

Build & Install

Clone repository

$ git clone https://github.com/cryfs/cryfs.git cryfs
$ cd cryfs

Build

$ mkdir cmake && cd cmake
$ cmake ..
$ make

Install
```
$ sudo make install
```

You can pass the following variables to the cmake command (using -Dvariablename=value):

-DCMAKE_BUILD_TYPE=[Release|Debug]: Whether to run code optimization or add debug symbols. Default: Release
-DBUILD_TESTING=[on|off]: Whether to build the test cases (can take a long time). Default: off
-DCRYFS_UPDATE_CHECKS=off: Build a CryFS that doesn't check online for updates and security vulnerabilities.

Building on Windows (experimental)

Build with Visual Studio 2017 and pass in the following flags to CMake:

-DDOKAN_LIB_PATH=[dokan library location, e.g. "C:\Program Files\Dokan\DokanLibrary-1.1.0"] -DCURL_LIBRARY=[path to libcurl.dll.a, e.g. "C:\ProgramData\chocolatey\lib\curl\tools\curl-7.61.1-win64-mingw\lib\libcurl.dll.a"] -DCURL_INCLUDE_DIR=[path to libcurl include files, e.g. "C:\ProgramData\chocolatey\lib\curl\tools\curl-7.61.1-win64-mingw\include"] -DBOOST_ROOT=[path to root of boost installation]

Troubleshooting

On most systems, CMake should find the libraries automatically. However, that doesn't always work.

Boost headers not found

Pass in the boost include path with
```
 cmake .. -DBoost_INCLUDE_DIRS=/path/to/boost/headers
```
If you want to link boost dynamically (e.g. you don't have the static libraries), use the following:
```
 cmake .. -DBoost_USE_STATIC_LIBS=off
```
Fuse/Osxfuse library not found

Pass in the library path with
```
 cmake .. -DFUSE_LIB_PATH=/path/to/fuse/or/osxfuse
```

Fuse/Osxfuse headers not found

Pass in the include path with

 cmake .. -DCMAKE_CXX_FLAGS="-I/path/to/fuse/or/osxfuse/headers"

Openssl headers not found