2015-01-11 21:53:19 +01:00
|
|
|
This document provides generic information for compiling EncFS.
|
|
|
|
|
|
|
|
|
|
If you are looking for specific instructions for your distribution,
|
2015-06-16 06:00:45 +02:00
|
|
|
take a look at the page
|
2015-01-11 21:53:19 +01:00
|
|
|
**[Installing EncFS](https://github.com/vgough/encfs/wiki/Installing-Encfs)**
|
|
|
|
|
in the wiki.
|
|
|
|
|
|
|
|
|
|
Compiling EncFS
|
|
|
|
|
===============
|
|
|
|
|
|
2015-06-14 07:47:09 +02:00
|
|
|
EncFS uses the CMake toolchain to create makefiles.
|
2015-01-11 21:53:19 +01:00
|
|
|
|
2017-08-08 17:50:44 +02:00
|
|
|
Quickest way to build and test EncFS :
|
|
|
|
|
|
|
|
|
|
./build.sh
|
|
|
|
|
|
|
|
|
|
Or following are the detailed steps to build EncFS:
|
2015-01-11 21:53:19 +01:00
|
|
|
|
2015-06-14 07:47:09 +02:00
|
|
|
mkdir build
|
|
|
|
|
cd build
|
|
|
|
|
cmake ..
|
2015-01-11 21:53:19 +01:00
|
|
|
make
|
|
|
|
|
|
2017-08-08 04:49:38 +02:00
|
|
|
Optional, but strongly recommended, is running the unit and integration
|
|
|
|
|
tests to verify that the generated binaries work as expected. Unit
|
|
|
|
|
tests will run almost instantly:
|
2015-01-11 21:53:19 +01:00
|
|
|
|
2017-10-11 08:22:57 +02:00
|
|
|
make unittests
|
2017-07-30 20:52:19 +02:00
|
|
|
make test
|
2015-01-11 21:53:19 +01:00
|
|
|
|
2017-08-08 04:49:38 +02:00
|
|
|
Integration tests will take ~20 seconds to run and will mount an
|
2017-08-26 11:50:01 +02:00
|
|
|
encrypted filesystem and run tests on it:
|
|
|
|
|
*running integration tests from root (or with sudo) will run additional ones*
|
2017-08-08 04:49:38 +02:00
|
|
|
|
|
|
|
|
make integration
|
|
|
|
|
|
2015-01-11 21:53:19 +01:00
|
|
|
The compilation process creates two executables, encfs and encfsctl in
|
2017-08-08 17:50:44 +02:00
|
|
|
the encfs directory. You can install to in a system directory via:
|
2015-01-11 21:53:19 +01:00
|
|
|
|
|
|
|
|
make install
|
|
|
|
|
|
2017-08-08 17:50:44 +02:00
|
|
|
If the default path (`/usr/local`) is not where you want things
|
2015-06-16 06:00:45 +02:00
|
|
|
installed, then set the CMAKE_INSTALL_PREFIX option when running cmake. Eg:
|
|
|
|
|
|
|
|
|
|
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/local
|
2015-01-11 21:53:19 +01:00
|
|
|
|
|
|
|
|
Encfs and encfsctl can also be installed by hand. They need no special
|
|
|
|
|
permissions. You may also want the man pages encfs.1 and encfsctl.1.
|
|
|
|
|
|
|
|
|
|
Dependencies
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
EncFS depends on a number of libraries:
|
|
|
|
|
|
2015-06-18 05:33:57 +02:00
|
|
|
* fuse : the userspace filesystem layer
|
2017-09-30 19:48:15 +02:00
|
|
|
* openssl or libressl : used for cryptographic primitives
|
2015-06-18 05:33:57 +02:00
|
|
|
* tinyxml2 : for reading and writing XML configuration files
|
|
|
|
|
* gettext : internationalization support
|
|
|
|
|
* libintl : internationalization support
|
2017-05-28 16:20:21 +02:00
|
|
|
* cmake : version 3.0.2 (Debian jessie version) or newer
|
2016-11-15 20:17:12 +01:00
|
|
|
* GNU make or ninja-build : to run the build for cmake
|
2015-01-11 21:53:19 +01:00
|
|
|
|
|
|
|
|
Compiling on Debian and Ubuntu
|
|
|
|
|
==============================
|
|
|
|
|
|
2015-06-18 05:33:57 +02:00
|
|
|
See the automated build static in README.md for current build status on Ubuntu systems.
|
2015-01-11 21:53:19 +01:00
|
|
|
|
2016-09-07 13:11:57 +02:00
|
|
|
The build configuration files (circle.yml) always contains up-to-date
|
2015-06-18 05:33:57 +02:00
|
|
|
instructions to build EncFS on Ubuntu distributions.
|
2016-11-15 20:17:12 +01:00
|
|
|
|
|
|
|
|
On Debian Stable, additional installations from Backports branch might be
|
|
|
|
|
required (cmake 3.x for example, see https://backports.debian.org/ for instructions).
|
