-
Notifications
You must be signed in to change notification settings - Fork 4
/
BUILD_INSTRUCTIONS
142 lines (105 loc) · 6.37 KB
/
BUILD_INSTRUCTIONS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
look in "rpm" folder for information on how to build an rpm package of zuluCrypt.
look in "debian" or "debian_package_info" folder for information on how to build a debian package.
below instructions are for those who want to build from source old school style :-)
This tool depends on the following packages installed to build, their precise name may differ in your distro.
1. libpwquality-devel( optional dependency used to check the quality of passwords when creating volumes )
2. libblkid-devel
3. For Qt4 build(libqt4-devel or a package that provides libqt4-network-devel,libqtcore4-devel,libqtgui4-devel)
For Qt5 build(qt5-base-devel or a packages that provides Qt5Core-devel,Qt5Gui-devel,Qt5Network-devel)
Above packages are required if building GUI components.
4. gcc
5. gcc-c++
6. cryptsetup-devel
7. cmake
8.
9. libgcrypt-devel
10.libsecret-devel( optional dependency to store keys in gnome's libsecret )
11.kde-devel( optional dependency to store keys in kde's kwallet )
12.pkg-config
13.libdevmapper-devel aka device-mapper-devel.
14.uuid-devel
The precise names of the above packages in debian are:
1. libpwquality-dev( optional dependency used to check the quality of passwords when creating volumes )
2. libblkid-dev
3. libqt4-dev( optional dependency used when building GUI components )
libqt4-network
libqtcore4
libqtgui4
4. gcc
5. g++
6. libcryptsetup-dev
7. cmake
8.
9. libgcrypt11-dev
10.libsecret-1-dev( optional dependency used to store and retrieve volume keys using gnome's libsecret )
11.not sure of the package name( optional dependency used to store and retrieve volume keys using kde's kwallet )
12.pkg-config
13.libdevmapper-dev
14.uuid-dev
15.libudev-dev
16.chrpath
17.bzip2
18.debhelper
The project is made up of two components,the command line "pure C" based backend components and GUI Qt/C++ based front end components.
After you have above packages installed,run these 5 command to build and install.
The last command depends on your distribution,go with the one recommended by disto.
To build zuluCrypt with default options,run these 5 commands from inside the zuluCrypt source folder.
*****************************************************************************************************
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr -DSHARE_MOUNT_PREFIX=default -DUDEVSUPPORT=true -DNOGUI=false -DQT5=true
-DHOMEMOUNTPREFIX=false -DREUSEMOUNTPOINT=false -DNOGNOME=false -DINTERNAL_ZULUPLAY=false -DNOKDE=false
-DINTERNAL_LXQT_WALLET=false -DUSE_POLKIT=false -DCMAKE_BUILD_TYPE=RELEASE . ..
make
make install( or sudo make install )
*****************************************************************************************************
After you have it installed,run "zuluCrypt-test" to make sure everything is working as expected.
The build system now uses GNUInstallDirs (https://cmake.org/cmake/help/v3.5/module/GNUInstallDirs.html), so pretty much all directories can be controlled properly.
meaning of different options:
-DCMAKE_INSTALL_PREFIX=/usr/
This option tells the build process to install project's files in "/usr/".
-DCMAKE_INSTALL_LIBDIR=lib
This option specifies the base directory where libraries should be installed. Normally, this is automatically detected.
-DCMAKE_BUILD_TYPE=RELEASE
This option tells the build process to build the project in release mode.This mode is most suitable for non developers.
-DUDEVSUPPORT=true
This option tell zuluCrypt to ask for udev's opinion when deciding if a volume is system or not.Section 7 of the
FAQ has more information about udev's problem.Set the option to "false" to ignore udev's opinion.
The FAQ is located at: https://github.com/mhogomchungu/zuluCrypt/wiki/Frequently-Asked-Questions
-DNOGUI=false
This option tells the build process to build GUI components.Set this option to "true" if you do not want GUI components.
-DQT5=false
This option tells the build process to build GUI components using Qt4.Set the option to "true" if you want to build using Qt5.
-DHOMEMOUNTPREFIX=false
This option tells zuluCrypt to create mount paths at "/run/media/private/$USER".Set this option to "true" if you want
mount points to be created in user's home directory.
-DNOGNOME=false
This option tells the build process to add gnome's libsecret secure storage of passwords.Set this option to "true" if
you do not want libsecret's support.
-DNOKDE=false
This option tells the build process to add KDE's secure storage of passwords.Set this option to "true" if you do not
want KDE wallet support.
-DSHARE_MOUNT_PREFIX=default
zuluMount has an ability to create a publicly accessible mount point in addition to the default private one and this
option controls where the public share should be created.The "default" values sets a default value of "/run/media/public".
Set this variable to another path if you want to change the default location of where share mount point should be created.
-DREUSEMOUNTPOINT=false
By default,the project demands exclusive control over the mount point path causing it to complain when it finds
the path to already be taken when mounting and to unconditionally delete it on unmount.
Set this option to "true" if you want to overide the above behavior and this ability seems useful when mounting
volumes in a directory(like home directory) and wanting folder count to remain unchanged between volumes mounts.
-DINTERNAL_LXQT_WALLET=false
This project depends on lxqt_wallet project and it ships with an internal copy of the project. Set this option to "true"
if you want zuluCrypt to unconditionally use the internal copy of the project or to "false" to make the build process
use a system installed version if found.
-DINTERNAL_ZULUPLAY=false
Set this option to "true" if you want to unconditionally an external library of this project.
A value of "false" will cause the build system to to use system wide library if it is found.
-DUSE_POLKIT=false
Set this option to "true" if you want GUI components to start elevated and run in "mixed" mode. Good thing about
this option is that CLI components will not be suid-root. Bad things about setting this option are:
1. zuluMount-gui will loose its ability to unlock encrypted folders.
2. lxqt_wallet wallet functionality will be disabled.
3. GUI components will run from root's account and they will look different.
Build errors/test fails/feature requests/recommendations can be reported at: https://github.com/mhogomchungu/zuluCrypt/issues
or using my private email address at: mhogomchungu@gmail.com