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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2002-1 (1.68)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>2 Installation</TITLE>
<META NAME="description" CONTENT="2 Installation">
<META NAME="keywords" CONTENT="documentation">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="documentation.css">
<LINK REL="next" HREF="node4.html">
<LINK REL="previous" HREF="node2.html">
<LINK REL="up" HREF="documentation.html">
<LINK REL="next" HREF="node4.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html152"
HREF="node4.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html148"
HREF="documentation.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html142"
HREF="node2.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html150"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html153"
HREF="node4.html">3 Configuration</A>
<B> Up:</B> <A NAME="tex2html149"
HREF="documentation.html">Installing and Running mod_log_sql</A>
<B> Previous:</B> <A NAME="tex2html143"
HREF="node2.html">1 Introduction</A>
<B> <A NAME="tex2html151"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html154"
HREF="node3.html#SECTION00031000000000000000">2.1 Requirements</A>
<LI><A NAME="tex2html155"
HREF="node3.html#SECTION00032000000000000000">2.2 Platform-specific notes</A>
<UL>
<LI><A NAME="tex2html156"
HREF="node3.html#SECTION00032100000000000000">2.2.1 Solaris</A>
<LI><A NAME="tex2html157"
HREF="node3.html#SECTION00032200000000000000">2.2.2 BSD</A>
<LI><A NAME="tex2html158"
HREF="node3.html#SECTION00032300000000000000">2.2.3 Win32</A>
</UL>
<BR>
<LI><A NAME="tex2html159"
HREF="node3.html#SECTION00033000000000000000">2.3 Do I want a DSO or a static module?</A>
<LI><A NAME="tex2html160"
HREF="node3.html#SECTION00034000000000000000">2.4 Installation as an Apache DSO (Preferred) </A>
<LI><A NAME="tex2html161"
HREF="node3.html#SECTION00035000000000000000">2.5 Installation as a static module compiled into
httpd</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<H1><A NAME="SECTION00030000000000000000">
2 Installation</A>
</H1>
<P>
<H2><A NAME="SECTION00031000000000000000">
2.1 Requirements</A>
</H2>
<P>
<UL>
<LI>A compatible system. mod_log_sql was authored and tested on systems
based on Red Hat Linux (Red Hat, Mandrake), but the module should
easily adapt to any modern distribution. mod_log_sql has also been
ported successfully to Solaris and FreeBSD.
</LI>
<LI>Apache 1.2 or 1.3. Ideally you should already have successfully compiled
Apache and understand the process, but this document tries to make
it simple for beginners.
</LI>
<LI>The MySQL development headers. This package is called different things
on different distros. For example, Red Hat 6.x calls this RPM ``MySQL-devel''
whereas Mandrake calls it ``libmysql10-devel.''
</LI>
<LI>MySQL >= 3.23.15 configured, installed and running on either localhost
or an accessible networked machine. You should already have a basic
understanding of MySQL and how it functions.
</LI>
<LI>Optionally, if you want to be able to log SSL information such as
keysize or cipher, you need OpenSSL and mod_ssl installed.
</LI>
</UL>
<P>
<H2><A NAME="SECTION00032000000000000000">
2.2 Platform-specific notes</A>
</H2>
<P>
These installation documents assume a relatively modern GNU/Linux
scenario. mod_log_sql has been ported to other platforms; following
are notes on compiling the module for those platforms.
<P>
<H3><A NAME="SECTION00032100000000000000">
2.2.1 Solaris</A>
</H3>
<P>
The nanosleep() function used in mod_log_sql relies on linking aginst
the librt library. Make the following alterations before proceeding:
<P>
<OL>
<LI>In Makefile, search for the string ``-lmysqlclient -lz'' and change
it to read ``-lmysqlclient -lz -lrt''
</LI>
<LI>In part <A HREF="node3.html#step:Linking">8a</A> of section <A HREF="node3.html#sec:Static">2.5</A> below, change
``-lmysqlclient -lm -lz'' to read ``-lmysqlclient -lm -lz -lrt''
</LI>
</OL>
<P>
<H3><A NAME="SECTION00032200000000000000">
2.2.2 BSD</A>
</H3>
<P>
No notes are available at present, but they are desired. If you have
successfully ported mod_log_sql to BSD, <I>please</I> contact the maintaniner, Chris Powell (chris@grubbybaby.com)
and help fill in this section.
<P>
<H3><A NAME="SECTION00032300000000000000">
2.2.3 Win32</A>
</H3>
<P>
No notes are available at present, but they are desired. If you have
successfully ported mod_log_sql to Win32, <I>please</I> contact
the maintaniner, Chris Powell (chris@grubbybaby.com) and help
fill in this section.
<P>
<H2><A NAME="SECTION00033000000000000000">
2.3 Do I want a DSO or a static module?</A>
</H2>
<P>
You need to know the answer to this question before you proceed. The
answer is pretty straightforward: what have you done in the past?
If you like all your Apache modules to be dynamic, then you should
keep doing that. If you're more of an old-school type and prefer to
compile the modules right into apache, do that. Both methods work
equally well.
<P>
FWIW, the DSO method is more modern and increasing in popularity because
apxs takes care of a lot of dirty little details for you. As you'll
see below, the static-module method is a little more complex.
<P>
<H2><A NAME="SECTION00034000000000000000">
2.4 Installation as an Apache DSO (Preferred) </A>
</H2>
<P>
<OL>
<LI>Perform all the following steps as root so that you have install privs,
etc. Unpack the archive into a working directory.
<P>
<DL COMPACT>
<DT>
<DD># tar zxf mod_log_sql.tar.gz -C /usr/local/src
<P>
# cd /usr/local/src/mod_log_sql
</DD>
</DL>
</LI>
<LI>Edit Makefile and change the values of the variables in the first
section.
<P>
<OL>
<LI>These paths are <B>necessary:</B>
<P>
<DL>
<DT><STRONG>APACHEINSTALLED:</STRONG></DT>
<DD>the location where you installed Apache - usually
/usr/local/apache, 'locate apxs' can help you find it.
</DD>
<DT><STRONG>APACHEHEADERS:</STRONG></DT>
<DD>The location of your Apache header files, find using
'locate httpd.h'
</DD>
<DT><STRONG>MYSQLLIBRARIES:</STRONG></DT>
<DD>The location of your MySQL libraries, find using
'locate libmysqlclient.so'
</DD>
<DT><STRONG>MYSQLHEADERS:</STRONG></DT>
<DD>The location of your MySQL header files, find using
'locate mysql.h'
</DD>
</DL>
</LI>
<LI><B>Optional</B>: if you compiled mod_ssl for Apache and want to
log SSL data such as 'keysize' and 'cipher type':
<P>
<DL>
<DT><STRONG>MODSSLHEADERS:</STRONG></DT>
<DD>the location of your mod_ssl header files, find
using 'locate mod_ssl.h'
</DD>
<DT><STRONG>DB1HEADERS:</STRONG></DT>
<DD>the location of your db1 header files, find using 'locate
ndbm.h'
</DD>
</DL>
</LI>
</OL>
You do <B>not</B> need to compile SSL support into mod_log_sql
in order to simply use it with a secure site. You only need to compile
SSL support into mod_log_sql <B>if you want to log SSL-specific
data</B> such as the cipher type.
<P>
</LI>
<LI>IMPORTANT: If you are not logging SSL info, comment out MODSSLHDRS
by putting a # character in front of it:
<P>
<DL COMPACT>
<DT>
<DD>#MODSSLHDRS=/usr/include/...
</DD>
</DL>
</LI>
<LI>Instruct apxs to compile the module as a DSO.
<P>
<DL COMPACT>
<DT>
<DD># make dso
</DD>
</DL>You should see output similar to the following:
<P>
<DL COMPACT>
<DT>
<DD>/usr/local/Apache/bin/apxs -Wc,-O2 -Wc,-Wall -Wc,-DEAPI -c -I/usr/...
<P>
gcc -DLINUX=22 -DNO_DBM_REWRITEMAP -DMOD_SSL=208111 -DUSE_HS...
<P>
gcc -shared -o mod_log_sql.so mod_log_sql.o -Wc,-O2 -Wc,-Wall -Wc...
</DD>
</DL>You should see no errors and have a new file called "mod_log_sql.so"
in your directory.
<P>
</LI>
<LI>Instruct apxs to install the DSO.
<P>
<DL COMPACT>
<DT>
<DD># make dsoinstall
</DD>
</DL>You should see output similar to the following:
<P>
<DL COMPACT>
<DT>
<DD>/usr/local/Apache/bin/apxs -i mod_log_sql.so
<P>
cp mod_log_sql.so /usr/local/Apache/libexec/mod_log_sql.so
<P>
chmod 755 /usr/local/Apache/libexec/mod_log_sql.so
</DD>
</DL>
</LI>
<LI>Load and activate the module in httpd.conf:
<P>
<OL>
<LI>Insert this line in the same area as other logging modules, e.g. near
``LoadModule config_log_module'':
<P>
<DL COMPACT>
<DT>
<DD>LoadModule sql_log_module libexec/mod_log_sql.so
</DD>
</DL>
</LI>
<LI>Insert this line in the same area as other logging modules, e.g. near
``AddModule mod_log_config.c'':
<P>
<DL COMPACT>
<DT>
<DD>AddModule mod_log_sql.c
</DD>
</DL>
</LI>
</OL>
</LI>
<LI>Module ordering within httpd.conf is important if you are logging
SSL information. Please ensure that
<P>
<DL COMPACT>
<DT>
<DD>LoadModule ssl_module libexec/libssl.so
</DD>
</DL>comes before
<P>
<DL COMPACT>
<DT>
<DD>LoadModule sql_log_module libexec/mod_log_sql.so
</DD>
</DL>in your httpd.conf file. If they are out of order, simply cut-and-paste
the ``ssl_module'' section so that it is at the top. If you do
not, you will get this error when you start Apache:
<P>
<DL COMPACT>
<DT>
<DD>/usr/local/apache/libexec/mod_log_mysql.so: undefined symbol: ssl_var_lookup
<P>
/usr/local/apache/bin/apachectl startssl: httpd could not be started
</DD>
</DL>(mod_log_sql has a dependency on mod_ssl for SSL symbols. If the
statements are out of order, mod_log_sql cannot recognize those
symbols.)
<P>
Now skip below to section <A HREF="node4.html#sec:Configuration">3</A>, <B>Configuration</B>.
<P>
</LI>
</OL>
<P>
<H2><A NAME="SECTION00035000000000000000"></A><A NAME="sec:Static"></A>
<BR>
2.5 Installation as a static module compiled into
httpd
</H2>
<P>
<OL>
<LI>Perform all the following steps as root so that you have install privs,
etc.
</LI>
<LI>Unpack the archive into a working directory.
<P>
<DL COMPACT>
<DT>
<DD># tar zxf mod_log_sql.tar.gz -C /usr/local/src
<P>
# cd /usr/local/src/mod_log_sql
</DD>
</DL>
</LI>
<LI><A NAME="step:editMF"></A>Edit Makefile and change the values of the variables
in the first section.
<P>
<OL>
<LI>These are <B>necessary:</B>
<P>
<DL>
<DT><STRONG>APACHEINSTALLED:</STRONG></DT>
<DD>the location where you installed Apache - usually
/usr/local/apache, 'locate apxs' can help you find it.
</DD>
<DT><STRONG>APACHESOURCE:</STRONG></DT>
<DD>the location of your Apache <B>sources</B>, find
using 'locate ABOUT_APACHE'
</DD>
<DT><STRONG>APACHEHEADERS:</STRONG></DT>
<DD>the location of your Apache header files, find using
'locate httpd.h'
</DD>
<DT><STRONG>MYSQLLIBRARIES:</STRONG></DT>
<DD>the location of your MySQL libraries, find using
'locate libmysqlclient.so'
</DD>
<DT><STRONG>MYSQLHEADERS:</STRONG></DT>
<DD>the location of your MySQL header files, find using
'locate mysql.h'
</DD>
</DL>
</LI>
<LI><B>Optional</B>: if you compiled mod_ssl for Apache and want to
log SSL data such as 'keysize' and 'cipher type':
<P>
<DL>
<DT><STRONG>MODSSLHEADERS:</STRONG></DT>
<DD>the location of your mod_ssl header files, find
using 'locate mod_ssl.h'
</DD>
<DT><STRONG>DB1HEADERS:</STRONG></DT>
<DD>the location of your db1 header files, find using 'locate
ndbm.h'
</DD>
</DL>
</LI>
</OL>
You do <B>not</B> need to compile SSL support into mod_log_sql
in order to simply use it with a secure site. You only need to compile
SSL support into mod_log_sql <B>if you want to log SSL-specific
data</B> such as the cipher type.
<P>
</LI>
<LI>IMPORTANT: If you are not logging SSL info, comment out MODSSLHDRS
by putting a # character in front of it:
<P>
<DL COMPACT>
<DT>
<DD>#MODSSLHDRS=/usr/include/...
</DD>
</DL>
</LI>
<LI>Compile the module.
<P>
<DL COMPACT>
<DT>
<DD># make static
</DD>
</DL>You should see output similar to the following:
<P>
<DL COMPACT>
<DT>
<DD>gcc -fpic -O2 -Wall -I/usr/local/Apache/include -I/usr/include/mysql -I/usr/lo...
</DD>
</DL>You should see no errors and have a new file called "mod_log_sql.o"
in your directory.
<P>
</LI>
<LI>Install the module.
<P>
<DL COMPACT>
<DT>
<DD># make statinstall
</DD>
</DL>
</LI>
<LI>Change to your Apache source directory.
<P>
<DL COMPACT>
<DT>
<DD># cd /usr/local/src/apache-1.3.22/src
</DD>
</DL>
</LI>
<LI>Re-compile your httpd binary as follows.
<P>
<OL>
<LI><A NAME="step:Linking"></A>Make these changes to Configuration.apaci:
<P>
<UL>
<LI>Append the following string to the EXTRA_LIBS= line. ("/usr/lib/mysql"
is from step <A HREF="node3.html#step:editMF">3</A>, and is where your MySQL libraries
live):
</LI>
</UL>
<DL COMPACT>
<DT>
<DD>-L/usr/lib/mysql -lmysqlclient -lm -lz
</DD>
</DL>
<UL>
<LI>Find the mod_log_config.o line, and insert this line immediately
after it:
</LI>
</UL>
<DL COMPACT>
<DT>
<DD>AddModule modules/sql/mod_log_sql.o
</DD>
</DL>
</LI>
<LI># cp Configuration.apaci Configuration
</LI>
<LI># ./Configure
</LI>
<LI># make
</LI>
<LI># strip httpd
</LI>
</OL>
</LI>
<LI>Test your new apache binary:
<P>
<DL COMPACT>
<DT>
<DD># ./httpd -l
</DD>
</DL>You should see something like:
<P>
<DL COMPACT>
<DT>
<DD>Compiled-in modules:
<P>
http_core.c
<P>
mod_log_sql.c <- That's the line you're looking for.
<P>
mod_env.c
<P>
mod_log_config.c
<P>
mod_mime.c
<P>
mod_negotiation.c
<P>
etc...
</DD>
</DL>
</LI>
<LI>Install your httpd binary. Copy it over your old httpd binary, wherever
it lives. You can and should rename your old httpd first so that you
can easily revert to that working version in case of bugs with the
new version.
<P>
<DL COMPACT>
<DT>
<DD># /etc/rc.d/init.d/httpd stop
<P>
# mv /usr/local/Apache/bin/httpd ~/httpd-save
<P>
# cp -f ./httpd /usr/local/Apache/bin/
</DD>
</DL>
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html152"
HREF="node4.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html148"
HREF="documentation.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html142"
HREF="node2.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html150"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html153"
HREF="node4.html">3 Configuration</A>
<B> Up:</B> <A NAME="tex2html149"
HREF="documentation.html">Installing and Running mod_log_sql</A>
<B> Previous:</B> <A NAME="tex2html143"
HREF="node2.html">1 Introduction</A>
<B> <A NAME="tex2html151"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
Chris Powell
2002-12-18
</ADDRESS>
</BODY>
</HTML>
|
