Debian Codegraph @

INSTALL

raw
1
2 NOTE: For v5 - please read notes/NEWIN_v5 first!
3 ------------------------------------------------
4
5 NOTE: A Linux port is recommended - features are limited on FreeBSD.
6 Other ports are not tested!
7
8 HOW TO BUILD:
9 -------------
10 The distribution uses GNU autotools for building.
11
12 Run ./autogen.sh or autoreconf after downloading and unpacking
13 to (re)generate the configure script and Makefile.in files.
14
15 Most users should then follow the standard
16 "./configure; make; make install" process common to UNIX packages.
17
18 Please read the sections below for your OS for the most widely used
19 configuration options.
20
21 *** xBSD users, please ensure you have bash1 installed first ***
22
23 *** Debian and Ubuntu users, please read the Debian section first. ***
24
25
26 1. Run the ./autogen.sh script to generate the configure script.
27 If an error occurs in running autogen.sh or ./configure then
28 make sure you have an up-to-date version of automake tools and
29 then run autoreconf.
30
31 2. Run the configure (./configure --help) script with
32 the help option to see the user selectable settings.
33 Default settings are shown in [].
34
35 3. Run the configure (./configure) script with your
36 options, if any. It is HIGHLY LIKELY that you will
37 want to change some options. Please read down for
38 suggested options for your platform.
39
40 4. "make"** or "gmake" will now build E2Guardian.
41
42 5. "make install" will create the directory structure and install
43 all the files in the chosen paths. For a more efficient
44 install, try "make install-strip" which will strip symbol
45 information to the E2G binary smaller.
46
47 6. "make clean" will remove the now un-needed object files etc.
48
49 7. See the section later called ADDITIONAL SCRIPTS to add
50 log rotation, optional CGI block page, startup scripts etc.
51
52
53 ** You can often use "make -j 2" or "make -j 5" to compile E2G faster,
54 especially on multiple CPU computers. As a general rule of thumb,
55 use the number of CPUs/cores plus one.
56
57
58
59 OPTIONS:
60 --------
61 `configure' configures e2guardian to adapt to many kinds of systems.
62
63 Usage: ./configure [OPTION]... [VAR=VALUE]...
64
65 To assign environment variables (e.g., CC, CFLAGS...), specify them as
66 VAR=VALUE. See below for descriptions of some of the useful variables.
67
68 Defaults for the options are specified in brackets.
69
70 Configuration:
71 -h, --help display help and exit
72 --help=short display options specific to this package
73 --help=recursive display the short help of all the included packages
74 -V, --version display version information and exit
75 -q, --quiet, --silent do not print `checking...' messages
76 --cache-file=FILE cache test results in FILE [disabled]
77 -C, --config-cache alias for `--cache-file=config.cache'
78 -n, --no-create do not create output files
79 --srcdir=DIR find the sources in DIR [configure dir or `..']
80
81 Installation directories:
82 --prefix=PREFIX install architecture-independent files in PREFIX
83 [/usr/local]
84 --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX
85 [PREFIX]
86
87 By default, `make install' will install all the files in
88 `/usr/local/bin', `/usr/local/lib' etc. You can specify
89 an installation prefix other than `/usr/local' using `--prefix',
90 for instance `--prefix=$HOME'.
91
92 For better control, use the options below.
93
94 Fine tuning of the installation directories:
95 --bindir=DIR user executables [EPREFIX/bin]
96 --sbindir=DIR system admin executables [EPREFIX/sbin]
97 --libexecdir=DIR program executables [EPREFIX/libexec]
98 --datadir=DIR read-only architecture-independent data [PREFIX/share]
99 --sysconfdir=DIR read-only single-machine data [PREFIX/etc]
100 --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com]
101 --localstatedir=DIR modifiable single-machine data [PREFIX/var]
102 --libdir=DIR object code libraries [EPREFIX/lib]
103 --includedir=DIR C header files [PREFIX/include]
104 --oldincludedir=DIR C header files for non-gcc [/usr/include]
105 --infodir=DIR info documentation [PREFIX/info]
106 --mandir=DIR man documentation [PREFIX/man]
107
108 Program names:
109 --program-prefix=PREFIX prepend PREFIX to installed program names
110 --program-suffix=SUFFIX append SUFFIX to installed program names
111 --program-transform-name=PROGRAM run sed PROGRAM on installed program names
112
113 System types:
114 --build=BUILD configure for building on BUILD [guessed]
115
116 Optional Features:
117 --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
118 --enable-FEATURE[=ARG] include FEATURE [ARG=yes]
119 --disable-dependency-tracking speeds up one-time build
120 --enable-dependency-tracking do not reject slow dependency extractors
121 --enable-static-zlib[=no]
122 Enable static linking of zlib
123 --enable-pcre[=yes]
124 Enable support for the PCRE library
125 --enable-lfs[=yes]
126 Enable large file support on 32 bit systems
127 --enable-clamd[=no]
128 Enable support for the ClamD content scanner
129 --enable-avastd[=no]
130 Enable support for the AvastD content scanner
131 --enable-icap[=no]
132 Enable support for ICAP AV server content scanner
133 --enable-kavd[=no]
134 Enable support for the Kaspersky AV daemon content
135 scanner
136 --enable-commandline[=no]
137 Enable support for command-line content scanners
138 --enable-dnsauth[=no]
139 Enable support for the DNS auth plugin
140 --enable-email[=no]
141 Enable support for email reporting functionality
142
143 Optional Packages:
144 --with-PACKAGE[=ARG]
145 use PACKAGE [ARG=yes]
146 --without-PACKAGE
147 do not use PACKAGE (same as --with-PACKAGE=no)
148 --with-zlib[=NONE]
149 non-standard search path for zlib library
150 --with-debug_high[=on] switch on high level debug build mode
151 --with-debug_low[=off] switch on low level debug build mode
152 --with-proxyuser[=nobody]
153 name of proxy user
154 --with-proxygroup[=nobody]
155 name of proxy group
156 --with-piddir[=${localstatedir}/run]
157 path for pid file
158 --with-logdir[=${localstatedir}/log/${PACKAGE_NAME}]
159 path for log files
160 --with-libiconv[=NONE]
161 Specify search path on a system which requires an
162 external iconv library (only used in conjunction
163 with NTLM auth plugin).
164 --with-sysconfsubdir[=e2guardian]
165 subdirectory under sysconfdir in which to place
166 config files
167
168 Some influential environment variables:
169 CXX C++ compiler command
170 CXXFLAGS C++ compiler flags
171 LDFLAGS linker flags, e.g. -L<lib dir> if you have libraries in a
172 nonstandard directory <lib dir>
173 CPPFLAGS C/C++ preprocessor flags, e.g. -I<include dir> if you have
174 headers in a nonstandard directory <include dir>
175 CC C compiler command
176 CFLAGS C compiler flags
177 CPP C preprocessor
178 CXXCPP C++ preprocessor
179 PKG_CONFIG path to pkg-config utility
180 PCRE_CFLAGS C compiler flags for PCRE, overriding pkg-config
181 PCRE_LIBS linker flags for PCRE, overriding pkg-config
182
183 Use these variables to override the choices made by `configure' or to help
184 it to find libraries and programs with nonstandard names/locations.
185
186 See ./configure --help for more details.
187
188
189 MACOSX: - Note MACOS is not currently supported in V5
190 -------
191
192 *** Note in order to do any compiling in OS X you need to install ***
193 * the Developer Tools - an additional pkg called BSDSDK.pkg. *
194
195 A standard configure script that should work, provided you have installed
196 MACOSX and the associated programs in their default locations.
197
198 ./configure --localstatedir=/var \
199 --mandir=/usr/share/man/ \
200 --bindir=/usr/local/sbin/
201
202 You might consider changing the location of the log files to
203 '--with-logdir=/usr/local/e2guardian/logs/' and use the provided
204 log rotation script. Alternatively stick with the default
205 (/var/log/e2guardian/) and read newsyslog(8).
206
207
208 DEBIAN:
209 -------
210
211 Build-Depends: base-files, base-passwd, bash, coreutils, dash, debianutils, diffutils, dpkg, e2fsprogs, findutils, grep, gzip, hostname, ncurses-base, libevent_pthreads, libevent-dev, ncurses-bin, perl-base, sed, login, sysvinit-utils, sysvinit, tar, bsdutils, mount, util-linux, libc6-dev , libc-dev, gcc , g++ , make, dpkg-dev , autotools-dev, debhelper , dh-autoreconf, dpatch , libclamav-dev , libpcre3-dev, zlib1g-dev, pkg-config, libssl-dev, libssl1.1 (can be also compiled with libssl1.0)
212 Other packages related to E2guardian : adduser, perl, libbz2, libc6, libgcc1, libpcre3, libstdc++, libtommath0, zlib1g
213 Other Packages suggests to E2guardian: squid, clamav, clamav-freshclam
214 Autogen is needed !
215
216 Eg:
217 ./autogen.sh && ./configure '--prefix=/usr' '--enable-clamd=yes' '--with-proxyuser=e2guardian' '--with-proxygroup=e2guardian' '--sysconfdir=/etc' '--localstatedir=/var' '--enable-icap=yes' '--enable-commandline=yes' '--enable-email=yes' '--enable-ntlm=yes' '--mandir=${prefix}/share/man' '--infodir=${prefix}/share/info' '--enable-pcre=yes' '--enable-sslmitm=yes' 'CPPFLAGS=-mno-sse2 -g -O2' && make
218
219 NETBSD:
220 -------
221
222 A standard configure script that should work, provided you have installed
223 NetBSD and the associated programs in their default locations.
224 ./configure --localstatedir=/var \
225 --prefix=/usr/pkg
226 --sysconfdir=/usr/pkg/etc \
227 --bindir=/usr/pkg/sbin/
228
229 For NetBSD you might consider changing the location of the log files
230 to '--with-logdir=/usr/local/e2guardian/logs/' and use the
231 provided log rotation script. Alternatively stick with the default
232 (/var/log/e2guardian/) and read newsyslog(8).
233 Be sure that /usr/sbin/ is in your PATH before make install (for chown).
234
235
236 FREEBSD:
237 --------
238 A standard configure script that should work, provided you have installed
239 FreeBSD and the associated programs in their default locations.
240
241 ./configure --localstatedir=/var
242
243 For FreeBSD and OpenBSD you might consider changing the location of the
244 log files to '--with-logdir=/usr/local/e2guardian/logs/' and use the
245 provided log rotation script. Alternatively stick with the default
246 (/var/log/e2guardian/) and read newsyslog(8).
247
248
249 OPENBSD:
250 --------
251 A standard configure script that should work, provided you have installed
252 OpenBSD and the associated programs in their default locations.
253
254 ./configure --localstatedir=/var \
255 --bindir=/usr/sbin \
256 --mandir=/usr/share/man \
257 --sysconfdir=/etc
258
259
260 HOW TO CONFIGURE:
261 -----------------
262
263 Edit the e2guardian.conf, e2guardianf1.conf and other files.
264 The files are commented well.
265
266
267
268
269 ADDITIONAL SCRIPTS:
270 -------------------
271
272 In /usr/local/share/e2guardian/scripts (or wherever you configured
273 it to be) you will find at least the following files:
274 bsd-init - a BSD style startup script to be put in your rc.d
275 solaris-init - a Solaris style startup script to be put in your rc.d
276 systemv-init - a Linux style startup script to be put in your rc.d
277 e2guardian.service - a Linux style startup script to be put in your systemd directory
278 e2guardian - a logrotate.d file
279 logrotation - a sh script to rotate the logs
280 ../e2guardian.pl - a cgi script for an access denied page
281
282 The installation of startup scripts is
283 deemed out of the scope of source code and is the playground of
284 packagers and sysadmins.
285
286 This is also true of log rotation scripts. You can choose to use
287 the example logrotate.d file or you could crontab the logrotation
288 script thus:
289 crontab -e
290 59 23 * * sat /usr/local/share/e2guardian/scripts/logrotation
291 (now save)
292 I.e. 23:59 every Saturday. Or change to as pleases you.
293
294 If you wish to use the cgi denied script rather than the template
295 html denied page you will find it in:
296 /usr/local/share/e2guardian/ (or wherever you configured it to
297 be). This is not usually recommended but if you do want to do
298 this copy it to your web servers' cgi-bin directory.
299 E2Guardian.
300
301
302
303 HOW TO RUN:
304 -----------
305
306 You can start it by just running the binary. You can stop it by
307 appending a ' -q' to the end, thus: 'e2guardian -q'. Or you can use
308 the SysV(-like) script provided.
309
310
311
312 HOW TO GET HELP:
313 ----------------
314 http://e2guardian.org/
315
316 Here is the first place to start for getting support. There is a mailing
317 list available for those that do not find the answers to their questions
318 from the url above. The mailing list can be found at the url. Please
319 DO NOT email the authors for support as you will be just directed at the
320 mailing list.
321
322
323