source: server/major/apache.xml@ a774a7f3

lazarus
Last change on this file since a774a7f3 was a774a7f3, checked in by Thomas Trepl <thomas@…>, 14 months ago

Upgrade fpc/Lazarus version; Add 'uacme' tool
  • Property mode set to 100644
File size: 17.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY apache-download-http
8 "https://archive.apache.org/dist/httpd/httpd-&apache-version;.tar.bz2">
9 <!ENTITY apache-download-ftp " ">
10 <!ENTITY apache-md5sum "34575e92f91fb625f3842d6ca382caa5">
11 <!ENTITY apache-size "7.2 MB">
12 <!ENTITY apache-buildsize "87 MB">
13 <!ENTITY apache-time "0.3 SBU (Using parallelism=4)">
14]>
15
16<sect1 id="apache" xreflabel="Apache-&apache-version;">
17 <?dbhtml filename="apache.html"?>
18
19
20 <title>Apache-&apache-version;</title>
21
22 <indexterm zone="apache">
23 <primary sortas="a-Apache">Apache</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Apache HTTPD</title>
28
29 <para>
30 The <application>Apache HTTPD</application> package contains an open-source HTTP
31 server. It is useful for creating local intranet web sites or running huge
32 web serving operations.
33 </para>
34
35 &lfs120_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&apache-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&apache-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &apache-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &apache-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &apache-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &apache-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch:
76 <ulink url="&patch-root;/httpd-&apache-version;-blfs_layout-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80
81 <bridgehead renderas="sect3">Apache HTTPD Dependencies</bridgehead>
82
83 <bridgehead renderas="sect4">Required</bridgehead>
84 <para role="required">
85 <xref linkend="apr-util"/> and
86 <xref linkend="pcre2"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="brotli"/>,
92 <xref linkend="db"/>,
93 <xref linkend="doxygen"/>,
94 <xref linkend="jansson"/>,
95 <xref linkend="libxml2"/>,
96 <xref linkend="lua"/>,
97 <xref linkend="lynx"/> or
98 <xref linkend="Links"/> or
99 <ulink url="&elinks-url;">ELinks</ulink>,
100 <xref linkend="nghttp2"/>,
101 <xref linkend="openldap"/> (<xref linkend="apr-util"/> needs to be
102 installed with ldap support),
103 <xref linkend="rsync"/>, and
104 <ulink url="https://sourceforge.net/projects/distcache">Distcache</ulink>
105 </para>
106
107 <para condition="html" role="usernotes">
108 Editor Notes: <ulink url="&blfs-wiki;/apache"/>
109 </para>
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Apache HTTPD</title>
114
115 <para>
116 For security reasons, running the server as an unprivileged user and group
117 is strongly encouraged. Create the following group and user using the
118 following commands as <systemitem class="username">root</systemitem>:
119 </para>
120
121<screen role="root"><userinput>groupadd -g 25 apache &amp;&amp;
122useradd -c "Apache Server" -d /srv/www -g apache \
123 -s /bin/false -u 25 apache</userinput></screen>
124
125 <para>
126 Build and install <application>Apache HTTPD</application> by running the
127 following commands:
128 </para>
129
130<screen><userinput>patch -Np1 -i ../httpd-&apache-version;-blfs_layout-1.patch &amp;&amp;
131
132sed '/dir.*CFG_PREFIX/s@^@#@' -i support/apxs.in &amp;&amp;
133
134sed -e '/HTTPD_ROOT/s:${ap_prefix}:/etc/httpd:' \
135 -e '/SERVER_CONFIG_FILE/s:${rel_sysconfdir}/::' \
136 -e '/AP_TYPES_CONFIG_FILE/s:${rel_sysconfdir}/::' \
137 -i configure &amp;&amp;
138
139./configure --enable-authnz-fcgi \
140 --enable-layout=BLFS \
141 --enable-mods-shared="all cgi" \
142 --enable-mpms-shared=all \
143 --enable-suexec=shared \
144 --with-apr=/usr/bin/apr-1-config \
145 --with-apr-util=/usr/bin/apu-1-config \
146 --with-suexec-bin=/usr/lib/httpd/suexec \
147 --with-suexec-caller=apache \
148 --with-suexec-docroot=/srv/www \
149 --with-suexec-logfile=/var/log/httpd/suexec.log \
150 --with-suexec-uidmin=100 \
151 --with-suexec-userdir=public_html &amp;&amp;
152make</userinput></screen>
153
154 <para>
155 This package does not come with a test suite.
156 </para>
157
158 <para>
159 Now, as the <systemitem class="username">root</systemitem> user:
160 </para>
161<!-- changing the patch allows doing DESTDIR install as a normal user
162 <note>
163 <para>
164 This package does not install properly using <envar>DESTDIR</envar>
165 techniques as an unpriviledged user.
166 </para>
167 </note>
168-->
169<screen role="root"><userinput>make install &amp;&amp;
170
171mv -v /usr/sbin/suexec /usr/lib/httpd/suexec &amp;&amp;
172chgrp apache /usr/lib/httpd/suexec &amp;&amp;
173chmod 4754 /usr/lib/httpd/suexec &amp;&amp;
174
175chown -v -R apache:apache /srv/www</userinput></screen>
176
177 </sect2>
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <para>
183 <command>sed '/dir.*CFG_PREFIX/s@^@#@'...</command>: Forces the
184 <application>apxs</application> utility to use absolute pathnames for
185 modules, when instructed to do so.
186 </para>
187
188 <para>
189 <parameter>--enable-authnz-fcgi</parameter>: Build FastCGI
190 authorizer-based authentication and authorization (mod_authnz_fcgi.so
191 fast CGI module).
192 </para>
193
194 <para>
195 <parameter>--enable-mods-shared="all cgi"</parameter>: The modules should be
196 compiled and used as Dynamic Shared Objects (DSOs) so they can be included
197 and excluded from the server using the run-time configuration directives.
198 </para>
199
200 <para>
201 <parameter>--enable-mpms-shared=all</parameter>: This switch ensures that
202 all MPM (Multi Processing Modules) are built as Dynamic Shared Objects
203 (DSOs), so the user can choose which one to use at runtime.
204 </para>
205
206 <para>
207 <parameter>--enable-suexec</parameter>: This switch enables building of the
208 <application>Apache</application> suEXEC module which can be used to allow
209 users to run CGI and SSI scripts under user IDs different from the user ID
210 of the calling web server.
211 </para>
212
213 <para>
214 <parameter>--with-suexec-*</parameter>: These switches control suEXEC module
215 behavior, such as default document root, minimal UID that can be used to
216 run the script under the suEXEC. Please note that with minimal UID 100, you
217 can't run CGI or SSI scripts under suEXEC as the
218 <systemitem class="username">apache</systemitem> user.
219 </para>
220
221 <para>
222 <command>... /usr/lib/httpd/suexec</command>: These commands put
223 <command>suexec</command> wrapper into proper location, since it
224 is not meant to be run directly. They also adjust proper
225 permissions of the binary, making it setgid
226 <systemitem class="username">apache</systemitem>.
227 </para>
228
229 <para>
230 <command>chown -R apache:apache /srv/www</command>: By default, the
231 installation process installs files (documentation, error messages,
232 default icons, etc.) with the ownership of the user that extracted the
233 files from the tar file. If you want to change the ownership to another
234 user, you should do so at this point. The only requirement is that the
235 document directories need to be accessible by the <command>httpd</command>
236 process with (r-x) permissions and files need to be readable (r--) by the
237 <systemitem class="username">apache</systemitem> user.
238 </para>
239
240 </sect2>
241
242 <sect2 role="configuration">
243 <title>Configuring Apache</title>
244
245 <sect3 id="apache-config">
246 <title>Config Files</title>
247
248 <para>
249 <filename>/etc/httpd/httpd.conf</filename> and
250 <filename>/etc/httpd/extra/*</filename>
251 </para>
252
253 <indexterm zone="apache apache-config">
254 <primary sortas="e-etc-httpd-httpd.conf">/etc/httpd/httpd.conf</primary>
255 </indexterm>
256
257 <indexterm zone="apache apache-config">
258 <primary sortas="e-etc-httpd-extra-star">/etc/httpd/extra/*</primary>
259 </indexterm>
260
261 </sect3>
262
263 <sect3>
264 <title>Configuration Information</title>
265
266 <para>
267 See <ulink url="file:///usr/share/httpd/manual/configuring.html"/>
268 for detailed instructions on customising your
269 <application>Apache</application> HTTP server configuration file.
270 </para>
271
272 </sect3>
273
274 <sect3 id="httpd-init">
275 <title><phrase revision="sysv">Boot Script</phrase>
276 <phrase revision="systemd">Systemd Unit</phrase></title>
277
278 <para>
279 If you want the <application>Apache</application> server to
280 start automatically when the system is booted, install the
281 <phrase revision="sysv"><filename>/etc/rc.d/init.d/httpd</filename>
282 init script</phrase>
283 <phrase revision="systemd"><filename>httpd.service</filename>
284 unit</phrase> included in the
285 <xref linkend="bootscripts" revision="sysv"/>
286 <xref linkend="systemd-units" revision="systemd"/> package:
287 </para>
288
289 <indexterm zone="apache httpd-init">
290 <primary sortas="f-apache">apache</primary>
291 </indexterm>
292
293<screen role="root"><userinput>make install-httpd</userinput></screen>
294
295 <para>To secure the applications served by <application>Apache</application>
296 it is recommended to use SSL encyption (https). To create SSL
297 certificated for this web server, see <xref linkend="uacme"/> for
298 an easy-to-use tool to create LetsEncrypt certificates.</para>
299
300 </sect3>
301
302 </sect2>
303
304 <sect2 role="content">
305 <title>Contents</title>
306
307 <segmentedlist>
308 <segtitle>Installed Programs</segtitle>
309 <segtitle>Installed Libraries</segtitle>
310 <segtitle>Installed Directories</segtitle>
311
312 <seglistitem>
313 <seg>
314 ab, apachectl, apxs, checkgid, dbmmanage, fcgistarter,
315 htcacheclean, htdbm, htdigest, htpasswd, httpd,
316 httxt2dbm, logresolve, and rotatelogs
317 <!-- not executable from path, and suexec -->
318 </seg>
319 <seg>
320 Several libraries under /usr/lib/httpd/modules/
321 </seg>
322 <seg>
323 /etc/httpd,
324 /srv/www,
325 /usr/include/httpd,
326 /usr/lib/httpd,
327 /usr/share/httpd,
328 /var/log/httpd, and
329 /var/run/httpd
330 </seg>
331 </seglistitem>
332 </segmentedlist>
333
334 <variablelist>
335 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
336 <?dbfo list-presentation="list"?>
337 <?dbhtml list-presentation="table"?>
338
339 <varlistentry id="ab">
340 <term><command>ab</command></term>
341 <listitem>
342 <para>
343 is a tool for benchmarking your <application>Apache</application>
344 HTTP server
345 </para>
346 <indexterm zone="apache ab">
347 <primary sortas="b-ab">ab</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="apachectl">
353 <term><command>apachectl</command></term>
354 <listitem>
355 <para>
356 is a front end to the <application>Apache</application> HTTP server
357 which is designed to help the administrator control the functioning
358 of the <application>Apache</application> httpd daemon
359 </para>
360 <indexterm zone="apache apachectl">
361 <primary sortas="b-apachectl">apachectl</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="apxs">
367 <term><command>apxs</command></term>
368 <listitem>
369 <para>
370 is a tool for building and installing extension modules for the
371 <application>Apache</application> HTTP server
372 </para>
373 <indexterm zone="apache apxs">
374 <primary sortas="b-apxs">apxs</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="checkgid">
380 <term><command>checkgid</command></term>
381 <listitem>
382 <para>
383 is a program that checks whether it can setgid to the group
384 specified. This is to see if it is a valid group for Apache2 to use
385 at runtime. If the user (should be run as superuser) is in that
386 group, or can setgid to it, it will return 0
387 </para>
388 <indexterm zone="apache checkgid">
389 <primary sortas="b-checkgid">checkgid</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="dbmmanage">
395 <term><command>dbmmanage</command></term>
396 <listitem>
397 <para>
398 is used to create and update the DBM format files used to store
399 usernames and passwords for basic authentication of HTTP users
400 </para>
401 <indexterm zone="apache dbmmanage">
402 <primary sortas="b-dbmmanage">dbmmanage</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="fcgistarter">
408 <term><command>fcgistarter</command></term>
409 <listitem>
410 <para>
411 is a tool to start a FastCGI program
412 </para>
413 <indexterm zone="apache fcgistarter">
414 <primary sortas="b-fcgistarter">fcgistarter</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="htcacheclean">
420 <term><command>htcacheclean</command></term>
421 <listitem>
422 <para>
423 is used to clean up the disk cache
424 </para>
425 <indexterm zone="apache htcacheclean">
426 <primary sortas="b-htcacheclean">htcacheclean</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="htdbm">
432 <term><command>htdbm</command></term>
433 <listitem>
434 <para>
435 is used to manipulate the DBM password databases
436 </para>
437 <indexterm zone="apache htdbm">
438 <primary sortas="b-htdbm">htdbm</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="htdigest">
444 <term><command>htdigest</command></term>
445 <listitem>
446 <para>
447 is used to create and update the flat-files used to store usernames,
448 realms and passwords for digest authentication of HTTP users
449 </para>
450 <indexterm zone="apache htdigest">
451 <primary sortas="b-htdigest">htdigest</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="htpasswd">
457 <term><command>htpasswd</command></term>
458 <listitem>
459 <para>
460 is used to create and update the flat-files used to store usernames
461 and passwords for basic authentication of HTTP users
462 </para>
463 <indexterm zone="apache htpasswd">
464 <primary sortas="b-htpasswd">htpasswd</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="httpd">
470 <term><command>httpd</command></term>
471 <listitem>
472 <para>
473 is the <application>Apache</application> HTTP server program
474 </para>
475 <indexterm zone="apache httpd">
476 <primary sortas="b-httpd">httpd</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="httxt2dbm">
482 <term><command>httxt2dbm</command></term>
483 <listitem>
484 <para>
485 is used to generate DBM files from text, for use in RewriteMap
486 </para>
487 <indexterm zone="apache httxt2dbm">
488 <primary sortas="b-httxt2dbm">httxt2dbm</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry id="logresolve">
494 <term><command>logresolve</command></term>
495 <listitem>
496 <para>
497 is a post-processing program to resolve IP-addresses in
498 <application>Apache</application>'s access log files
499 </para>
500 <indexterm zone="apache logresolve">
501 <primary sortas="b-logresolve">logresolve</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="rotatelogs">
507 <term><command>rotatelogs</command></term>
508 <listitem>
509 <para>
510 is a simple program for use in conjunction with
511 <application>Apache</application>'s piped log file feature
512 </para>
513 <indexterm zone="apache rotatelogs">
514 <primary sortas="b-rotatelogs">rotatelogs</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
519 <varlistentry id="suexec">
520 <term><command>suexec</command></term>
521 <listitem>
522 <para>
523 allows users to run CGI and SSI applications as a different user
524 </para>
525 <indexterm zone="apache suexec">
526 <primary sortas="b-suexec">suexec</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530
531 </variablelist>
532
533 </sect2>
534
535</sect1>
Note: See TracBrowser for help on using the repository browser.