/[gentoo]/xml/htdocs/proj/en/glep/glep-0011.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0011.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.6
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 11 -- Web Application Installation</title> 12 <title>GLEP 11 -- Web Application Installation</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/10/10 20:25:14 $
19:version: $Revision: 1.6 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0011.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0011.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 271<col class="field-name" />
30<col class="field-body" /> 272<col class="field-body" />
31<tbody valign="top"> 273<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">11</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">11</td>
33</tr> 275</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Web Application Installation</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Web Application Installation</td>
35</tr> 277</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.6</td>
37</tr> 279</tr>
38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0011.txt?cvsroot=gentoo">2003/08/07 19:02:40</a></td> 280<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0011.txt?cvsroot=gentoo">2006/09/04 03:12:43</a></td>
39</tr> 281</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Troy Dack &lt;tad&#32;&#97;t&#32;gentoo.org&gt;</td> 282<tr class="field"><th class="field-name">Author:</th><td class="field-body">Troy Dack &lt;tad&#32;&#97;t&#32;gentoo.org&gt;</td>
41</tr> 283</tr>
284<tr class="field"><th class="field-name">Author:</th><td class="field-body">Stuart Herbert &lt;stuart&#32;&#97;t&#32;gentoo.org&gt;</td>
285</tr>
42<tr class="field"><th class="field-name">Discussions-To:</th><td class="field-body"><a class="reference" href="mailto:gentoo-dev&#64;gentoo.org?subject=PEP%2011">gentoo-dev&#32;&#97;t&#32;gentoo.org</a></td> 286<tr class="field"><th class="field-name">Discussions-To:</th><td class="field-body"><a class="reference" href="mailto:gentoo-dev&#64;gentoo.org?subject=PEP%2011">gentoo-dev&#32;&#97;t&#32;gentoo.org</a></td>
43</tr> 287</tr>
44<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 288<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
45</tr> 289</tr>
46<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 290<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
47</tr> 291</tr>
48<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> 292<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
49</tr> 293</tr>
50<tr class="field"><th class="field-name">Created:</th><td class="field-body">02 August 2003</td> 294<tr class="field"><th class="field-name">Created:</th><td class="field-body">02-August-2003</td>
51</tr> 295</tr>
52<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">07 Aug 2003</td> 296<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">07-Aug-2003, 12-Aug-2003, 13-Aug-2003, 3-Sep-2006</td>
53</tr> 297</tr>
54</tbody> 298</tbody>
55</table> 299</table>
56<hr /> 300<hr />
57<div class="contents topic" id="contents"> 301<div class="contents topic">
58<p class="topic-title"><a name="contents">Contents</a></p> 302<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
59<ul class="simple"> 303<ul class="simple">
304<li><a class="reference" href="#status" id="id7" name="id7">Status</a></li>
60<li><a class="reference" href="#credits" id="id5" name="id5">Credits</a></li> 305<li><a class="reference" href="#credits" id="id8" name="id8">Credits</a></li>
61<li><a class="reference" href="#definitions" id="id6" name="id6">Definitions</a></li> 306<li><a class="reference" href="#definitions" id="id9" name="id9">Definitions</a></li>
62<li><a class="reference" href="#conventions" id="id7" name="id7">Conventions</a></li> 307<li><a class="reference" href="#conventions" id="id10" name="id10">Conventions</a></li>
63<li><a class="reference" href="#abstract" id="id8" name="id8">Abstract</a></li> 308<li><a class="reference" href="#abstract" id="id11" name="id11">Abstract</a></li>
64<li><a class="reference" href="#motivation" id="id9" name="id9">Motivation</a></li> 309<li><a class="reference" href="#motivation" id="id12" name="id12">Motivation</a></li>
65<li><a class="reference" href="#rationale" id="id10" name="id10">Rationale</a></li> 310<li><a class="reference" href="#rationale" id="id13" name="id13">Rationale</a></li>
66<li><a class="reference" href="#implementation" id="id11" name="id11">Implementation</a><ul> 311<li><a class="reference" href="#implementation" id="id14" name="id14">Implementation</a><ul>
67<li><a class="reference" href="#web-server" id="id12" name="id12">1. Web Server</a><ul> 312<li><a class="reference" href="#web-server" id="id15" name="id15">1. Web Server</a><ul>
68<li><a class="reference" href="#default-document-root" id="id13" name="id13">1.1 Default Document Root</a></li> 313<li><a class="reference" href="#default-document-root" id="id16" name="id16">1.1 Default Document Root</a></li>
69<li><a class="reference" href="#apache-2" id="id14" name="id14">1.2 Apache 2</a></li> 314<li><a class="reference" href="#apache-2" id="id17" name="id17">1.2 Apache 2</a></li>
70</ul>
71</li> 315</ul>
316</li>
317<li><a class="reference" href="#application-installation" id="id18" name="id18">2. Application Installation</a><ul>
318<li><a class="reference" href="#application-slots" id="id19" name="id19">2.1 Application SLOTs</a></li>
319<li><a class="reference" href="#installation-paths" id="id20" name="id20">2.2 Installation Paths</a></li>
320</ul>
321</li>
72<li><a class="reference" href="#virtual-host-flexibility" id="id15" name="id15">2. Virtual Host Flexibility</a><ul> 322<li><a class="reference" href="#virtual-host-support" id="id21" name="id21">3. Virtual Host Support</a><ul>
73<li><a class="reference" href="#new-vhost-use-flag" id="id16" name="id16">2.1 New &quot;vhost&quot; USE Flag</a></li> 323<li><a class="reference" href="#new-vhost-use-flag" id="id22" name="id22">3.1 New &quot;vhost&quot; USE Flag</a></li>
74<li><a class="reference" href="#vhost-configuration-tool" id="id17" name="id17">2.2 VHost Configuration Tool</a></li> 324<li><a class="reference" href="#vhost-configuration-tool" id="id23" name="id23">3.2 VHost Configuration Tool</a></li>
75</ul>
76</li>
77<li><a class="reference" href="#application-installation-location" id="id18" name="id18">3. Application Installation Location</a><ul>
78<li><a class="reference" href="#single-host-installation" id="id19" name="id19">3.1 Single Host Installation</a></li> 325<li><a class="reference" href="#single-host-installation" id="id24" name="id24">3.3 Single Host Installation</a></li>
79<li><a class="reference" href="#virtual-host-installation" id="id20" name="id20">3.2 Virtual Host Installation</a></li> 326<li><a class="reference" href="#virtual-host-installation" id="id25" name="id25">3.4 Virtual Host Installation</a></li>
80</ul> 327<li><a class="reference" href="#configuration-files" id="id26" name="id26">3.5 Configuration Files</a></li>
81</li> 328</ul>
82<li><a class="reference" href="#application-configuration" id="id21" name="id21">4. Application Configuration</a><ul>
83<li><a class="reference" href="#virtual-host-support" id="id22" name="id22">4.1 Virtual Host Support</a></li>
84</ul> 329</li>
85</li>
86<li><a class="reference" href="#application-permissions" id="id23" name="id23">5. Application Permissions</a></li> 330<li><a class="reference" href="#application-permissions" id="id27" name="id27">4. Application Permissions</a></li>
87</ul>
88</li> 331</ul>
332</li>
89<li><a class="reference" href="#backwards-compatibility" id="id24" name="id24">Backwards Compatibility</a></li> 333<li><a class="reference" href="#backwards-compatibility" id="id28" name="id28">Backwards Compatibility</a></li>
90<li><a class="reference" href="#references" id="id25" name="id25">References</a></li> 334<li><a class="reference" href="#references" id="id29" name="id29">References</a></li>
91<li><a class="reference" href="#copyright" id="id26" name="id26">Copyright</a></li> 335<li><a class="reference" href="#copyright" id="id30" name="id30">Copyright</a></li>
92</ul> 336</ul>
93</div> 337</div>
94<div class="section" id="credits"> 338<div class="section">
339<h1><a class="toc-backref" href="#id7" id="status" name="status">Status</a></h1>
340<p>As of 2006-09-03 the webapp eclass has existed for some time.</p>
341</div>
342<div class="section">
95<h1><a class="toc-backref" href="#id5" name="credits">Credits</a></h1> 343<h1><a class="toc-backref" href="#id8" id="credits" name="credits">Credits</a></h1>
96<p>Based on comments posted to gentoo-dev mailing list <a class="footnote-reference" href="#webapppost1" id="id1" name="id1">[1]</a> 344<p>Based on comments posted to gentoo-dev mailing list <a class="footnote-reference" href="#webapppost1" id="id1" name="id1">[1]</a>
97<a class="footnote-reference" href="#webapppost2" id="id2" name="id2">[2]</a> <a class="footnote-reference" href="#webapppost3" id="id3" name="id3">[3]</a> by:</p> 345<a class="footnote-reference" href="#webapppost2" id="id2" name="id2">[2]</a> <a class="footnote-reference" href="#webapppost3" id="id3" name="id3">[3]</a> by:</p>
98<blockquote> 346<blockquote>
99Stuart Herbert &lt;<a class="reference" href="mailto:stuart&#64;gentoo.org">stuart&#64;gentoo.org</a>&gt;, Max Kalika &lt;<a class="reference" href="mailto:max&#64;gentoo.org">max&#64;gentoo.org</a>&gt;, 347Stuart Herbert &lt;stuart at gentoo.org&gt;, Max Kalika &lt;max at gentoo.org&gt;,
100Robin H.Johnson &lt;<a class="reference" href="mailto:robbat2&#64;gentoo.org">robbat2&#64;gentoo.org</a>&gt; and others</blockquote> 348Robin H.Johnson &lt;robbat2 at gentoo.org&gt; and others</blockquote>
101</div> 349</div>
102<div class="section" id="definitions"> 350<div class="section">
103<h1><a class="toc-backref" href="#id6" name="definitions">Definitions</a></h1> 351<h1><a class="toc-backref" href="#id9" id="definitions" name="definitions">Definitions</a></h1>
104<blockquote> 352<blockquote>
105<dl> 353<dl class="docutils">
106<dt><em>Web Application</em></dt> 354<dt><em>Web Application</em></dt>
107<dd>an application that requires a web server to function and interacts with 355<dd>an application that requires a web server to function and interacts with
108the user via a browser</dd> 356the user via a browser</dd>
109<dt><em>Web Application Instance</em></dt> 357<dt><em>Web Application Instance</em></dt>
110<dd>An apparent install of the Web Application that is served up via the 358<dd>An apparent install of the Web Application that is served up via the
118<dd>a location in the file system that forms the main document tree visible from 366<dd>a location in the file system that forms the main document tree visible from
119the web</dd> 367the web</dd>
120</dl> 368</dl>
121</blockquote> 369</blockquote>
122</div> 370</div>
123<div class="section" id="conventions"> 371<div class="section">
124<h1><a class="toc-backref" href="#id7" name="conventions">Conventions</a></h1> 372<h1><a class="toc-backref" href="#id10" id="conventions" name="conventions">Conventions</a></h1>
125<blockquote> 373<blockquote>
126<p>When describing the location of a directory in the file system it 374<p>When describing the location of a directory in the file system it
127wil be shown <em>with</em> a trailing slash, eg:</p> 375wil be shown <em>with</em> a trailing slash, eg:</p>
128<pre class="literal-block"> 376<pre class="literal-block">
129/foo/bar/ 377/foo/bar/
133<pre class="literal-block"> 381<pre class="literal-block">
134/foo/blah 382/foo/blah
135</pre> 383</pre>
136</blockquote> 384</blockquote>
137</div> 385</div>
138<div class="section" id="abstract"> 386<div class="section">
139<h1><a class="toc-backref" href="#id8" name="abstract">Abstract</a></h1> 387<h1><a class="toc-backref" href="#id11" id="abstract" name="abstract">Abstract</a></h1>
140<p>To define where and how web based applications should be installed by Gentoo.</p> 388<p>To define where and how web based applications should be installed by Gentoo.</p>
141</div> 389</div>
142<div class="section" id="motivation"> 390<div class="section">
143<h1><a class="toc-backref" href="#id9" name="motivation">Motivation</a></h1> 391<h1><a class="toc-backref" href="#id12" id="motivation" name="motivation">Motivation</a></h1>
144<p>Currently there is no standard defined regarding the installation of web 392<p>Currently there is no standard defined regarding the installation of web
145based applicaitons in Gentoo. This leads to ebuild authors creating a 393based applicaitons in Gentoo. This leads to ebuild authors creating a
146variety of methods to determine:</p> 394variety of methods to determine:</p>
147<blockquote> 395<blockquote>
148<ul class="simple"> 396<ul class="simple">
155<p>Due to a lack of standard install method configuration files are at 403<p>Due to a lack of standard install method configuration files are at
156risk of being overwritten during upgrade, potentially causing system 404risk of being overwritten during upgrade, potentially causing system
157administrators down tine as they have to reconfigure web applications 405administrators down tine as they have to reconfigure web applications
158after an upgrade.</p> 406after an upgrade.</p>
159</div> 407</div>
160<div class="section" id="rationale"> 408<div class="section">
161<h1><a class="toc-backref" href="#id10" name="rationale">Rationale</a></h1> 409<h1><a class="toc-backref" href="#id13" id="rationale" name="rationale">Rationale</a></h1>
162<p>A discussion on the gentoo-dev mailing list <a class="footnote-reference" href="#webapppost1" id="id4" name="id4">[1]</a> raised the 410<p>A discussion on the gentoo-dev mailing list <a class="footnote-reference" href="#webapppost1" id="id4" name="id4">[1]</a> raised the
163following points regarding how Gentoo handles the installation of web based 411following points regarding how Gentoo handles the installation of web based
164applications:</p> 412applications:</p>
165<blockquote> 413<blockquote>
166<ol class="arabic"> 414<ol class="arabic">
169</li> 417</li>
170<li><p class="first">Web applications should not have their configuration files installed 418<li><p class="first">Web applications should not have their configuration files installed
171under the Document Root of a web server.</p> 419under the Document Root of a web server.</p>
172<blockquote> 420<blockquote>
173<ol class="lowerroman simple"> 421<ol class="lowerroman simple">
174<li>Web Application must be slotted by their major version numbers to 422<li>Web Application must be slotted by their full version numbers to
175further avoid downtime when true configuration changes are required.</li> 423further avoid downtime when true configuration changes are required.</li>
176</ol> 424</ol>
177</blockquote> 425</blockquote>
178</li> 426</li>
179<li><p class="first">Web applications should not be owned by the same user as the web server.</p> 427<li><p class="first">Web applications should not be owned by the same user as the web server.</p>
185application.</p> 433application.</p>
186</li> 434</li>
187</ol> 435</ol>
188</blockquote> 436</blockquote>
189</div> 437</div>
190<div class="section" id="implementation"> 438<div class="section">
191<h1><a class="toc-backref" href="#id11" name="implementation">Implementation</a></h1> 439<h1><a class="toc-backref" href="#id14" id="implementation" name="implementation">Implementation</a></h1>
192<p>Max Kalika &lt;<a class="reference" href="mailto:max&#64;gentoo.org">max&#64;gentoo.org</a>&gt; stated that he has a preliminary eclass that 440<p>Max Kalika &lt;max at gentoo.org&gt; stated that he has a preliminary eclass that
193implements a good deal of this GLEP.</p> 441implements a good deal of this GLEP.</p>
194<p>Stuart Herbert &lt;<a class="reference" href="mailto:stuart&#64;gentoo.org">stuart&#64;gentoo.org</a>&gt; has committed:</p> 442<p>Stuart Herbert &lt;stuart at gentoo.org&gt; has committed:</p>
195<pre class="literal-block"> 443<pre class="literal-block">
196webapp-apache.eclass 444webapp-apache.eclass
197</pre> 445</pre>
198<p>to CVS, this is a stop-gap measure whilst this GLEP is being finalised.</p> 446<p>to CVS, this is a stop-gap measure whilst this GLEP is being finalised.</p>
199<div class="section" id="web-server"> 447<div class="section">
200<h2><a class="toc-backref" href="#id12" name="web-server">1. Web Server</a></h2> 448<h2><a class="toc-backref" href="#id15" id="web-server" name="web-server">1. Web Server</a></h2>
201<p>A common default web server will have to be selected and ebuild authors should 449<p>A common default web server should be selected. Selection of a default web
202ensure that their applications contain configuration directives suitable for 450server will help to reduce the number of bugs that are reported.</p>
203that server. Given the popularity of the Apache web server it is suggested 451<p>Given the popularity of the Apache web server it is suggested that Apache be
204that Apache be selected as the Gentoo default web server.</p> 452selected as the Gentoo default web server.</p>
205<p>Whilst it is acknowledged that other web servers do exist and are used, there 453<p>The Virtual Host Configuration tool (see below) will transparently support
206has to be an assumption made somewhere that people who choose to use something 454different web servers, thus enabling web applications to be installed on a
207other than the default have enough knowledge to adapt configurations 455Gentoo system irrespective of the installed web server.</p>
208accordingly.</p> 456<div class="section">
209<div class="section" id="default-document-root">
210<h3><a class="toc-backref" href="#id13" name="default-document-root">1.1 Default Document Root</a></h3> 457<h3><a class="toc-backref" href="#id16" id="default-document-root" name="default-document-root">1.1 Default Document Root</a></h3>
458<p>The current default Document Root for Gentoo is /home/httpd/, this is
459unsuitable for a couple of reasons:</p>
460<blockquote>
461<ul class="simple">
462<li>/home/ may be exported via nfs to numerous other hosts, it is not
463acceptable to share publically accessible files with numerous hosts.</li>
464<li>there is a potential (all be it small) for a user name clash</li>
465</ul>
466</blockquote>
211<p>To ensure the greatest flexibility when installing applications the following 467<p>To ensure the greatest flexibility when installing applications the following
212<em>Document Root</em> locations are to be used:</p> 468<em>Document Root</em> locations are to be used:</p>
213<blockquote> 469<blockquote>
214<ul> 470<ul>
215<li><p class="first">For single host installations:</p> 471<li><p class="first">For single host installations:</p>
216<pre class="literal-block"> 472<pre class="literal-block">
217/var/www/localhost/htdocs/ 473/var/www/localhost/
218</pre> 474</pre>
219</li> 475</li>
220<li><p class="first">For multiple virtual host installastions:</p> 476<li><p class="first">For multiple virtual host installations:</p>
221<pre class="literal-block"> 477<pre class="literal-block">
222/var/www/&lt;fully qualified domain name&gt;/htdocs/ 478/var/www/&lt;fully qualified domain name&gt;/
479
223eg: 480eg:
224 /var/www/www.gentoo.org/htdocs/ 481 /var/www/www.gentoo.org/
225</pre> 482</pre>
226</li>
227</ul> 483</li>
484</ul>
228</blockquote> 485</blockquote>
486<p>Additionally the chosen location ( /var/www/ ) appears to be becoming a defacto
487standard for Linux distributions.</p>
229</div> 488</div>
230<div class="section" id="apache-2"> 489<div class="section">
231<h3><a class="toc-backref" href="#id14" name="apache-2">1.2 Apache 2</a></h3> 490<h3><a class="toc-backref" href="#id17" id="apache-2" name="apache-2">1.2 Apache 2</a></h3>
232<p>All web application .ebuild will honour any USE flags that are intended to 491<p>All web application .ebuilds will honour any USE flags that are intended to
233add support for Apache 2 as well as supporting Apache 1 installations.</p> 492add support for Apache 2 as well as supporting Apache 1 installations.</p>
234</div> 493</div>
235</div> 494</div>
236<div class="section" id="virtual-host-flexibility"> 495<div class="section">
237<h2><a class="toc-backref" href="#id15" name="virtual-host-flexibility">2. Virtual Host Flexibility</a></h2>
238<p>In a similar vein to Gentoo's Zope scripts, namely zope-config, we
239should be able to have multiple instances of a single web application
240without duplicating all of the files.</p>
241<p>This also allows system administrators to control where web applications
242will appear on their system, as well as to customize a file in a single
243instance of a web application without effecting the original material.</p>
244<p>This is easily acheived thru use of Apache configuration directivies and
245symlinks. For PHP instances, see <a class="reference" href="http://tavi.sourceforge.net/VirtualHosts">http://tavi.sourceforge.net/VirtualHosts</a>
246for some details.</p>
247<p>The primary idea here is that to the web-application, it appears that
248all of it's configuration and files are in the instance directory, but
249the files are physicalled located elsewhere.</p>
250<div class="section" id="new-vhost-use-flag">
251<h3><a class="toc-backref" href="#id16" name="new-vhost-use-flag">2.1 New &quot;vhost&quot; USE Flag</a></h3>
252<p>To enable support for multiple virtual host installations a new USE flag is
253to be added to Portage. The use flag will be:</p>
254<pre class="literal-block">
255vhost
256</pre>
257<p>When <em>vhost</em> is _set_ the installation location and configuration for the web
258application will be effected, see below for more details.</p>
259</div>
260<div class="section" id="vhost-configuration-tool">
261<h3><a class="toc-backref" href="#id17" name="vhost-configuration-tool">2.2 VHost Configuration Tool</a></h3>
262<p>To assist administration of multiple virtual hosts a &quot;VHost Configuration Tool&quot;
263needs to be developed and implemented. Initial discussion and regarding the VHost
264Config tool can be found at <a class="reference" href="http://article.gmane.org/gmane.linux.gentoo.devel/10874">http://article.gmane.org/gmane.linux.gentoo.devel/10874</a>.</p>
265<p>The VHost Configuration Utility will need to be a seperate package, maintained by Gentoo.
266Apache .ebuilds will require the VHost Config tool as a dependency (DEPEND).</p>
267<p>&lt;&lt; TO BE EXPANDED UPON &gt;&gt;</p>
268</div>
269</div>
270<div class="section" id="application-installation-location">
271<h2><a class="toc-backref" href="#id18" name="application-installation-location">3. Application Installation Location</a></h2> 496<h2><a class="toc-backref" href="#id18" id="application-installation" name="application-installation">2. Application Installation</a></h2>
272<p>The current accepted standard Document Root in Gentoo is /home/httpd. The 497<p>The current accepted standard Document Root in Gentoo is /home/httpd. The
273discussion suggest that this is not the best location to install web based 498discussion suggest that this is not the best location to install web based
274applications.</p> 499applications.</p>
500<div class="section">
501<h3><a class="toc-backref" href="#id19" id="application-slots" name="application-slots">2.1 Application SLOTs</a></h3>
502<p>All ebuilds are to set the SLOT variable as follows:</p>
503<pre class="literal-block">
504SLOT=&quot;${PV}&quot;
505</pre>
506<p>Setting the SLOT variable as shown will enable different versions of the same
507web application to be served concurrently by one server.</p>
508</div>
509<div class="section">
510<h3><a class="toc-backref" href="#id20" id="installation-paths" name="installation-paths">2.2 Installation Paths</a></h3>
275<p>Web applications should be installed outside of the Document Root using the following 511<p>Web applications should be installed outside of the Document Root using the following
276defaults:</p> 512defaults:</p>
277<blockquote> 513<blockquote>
278<ul> 514<ul>
279<li><p class="first">for files to be served to clients:</p> 515<li><p class="first">for files to be served to clients:</p>
280<pre class="literal-block"> 516<pre class="literal-block">
281/usr/share/webapps/${PF}/ 517/usr/share/webapps/${PF}/htdocs/
282 518
283/usr/share/webapps/${PF}/public_html/ for files served by the web server
284
285/usr/share/webapps/${PF}/cgi-bin/ for CGI-BIN files 519/usr/share/webapps/${PF}/cgi-bin/
286</pre> 520</pre>
287</li> 521</li>
288<li><p class="first">install configuration files in:</p> 522<li><p class="first">install <em>site default</em> configuration files in:</p>
289<pre class="literal-block"> 523<pre class="literal-block">
290/etc/webapps/${PF}/ 524/etc/webapps/${PF}/
291</pre> 525</pre>
292</li> 526</li>
293<li><p class="first">for documentation files (not served to clients):</p> 527<li><p class="first">for documentation files (not served to clients):</p>
295/usr/share/doc/${PF}/ 529/usr/share/doc/${PF}/
296</pre> 530</pre>
297</li> 531</li>
298</ul> 532</ul>
299</blockquote> 533</blockquote>
300<div class="section" id="single-host-installation"> 534</div>
535</div>
536<div class="section">
537<h2><a class="toc-backref" href="#id21" id="virtual-host-support" name="virtual-host-support">3. Virtual Host Support</a></h2>
538<p>The ability to easily configure and administer multiple virtual hosts is a
539must.</p>
540<div class="section">
541<h3><a class="toc-backref" href="#id22" id="new-vhost-use-flag" name="new-vhost-use-flag">3.1 New &quot;vhost&quot; USE Flag</a></h3>
542<p>To enable support for multiple virtual host installations a new USE flag is
543to be added to Portage. The use flag will be:</p>
544<pre class="literal-block">
545vhost
546</pre>
547<p>When <em>vhost</em> is _set_ the installation location and configuration for the web
548application will be effected, see below for more details.</p>
549</div>
550<div class="section">
551<h3><a class="toc-backref" href="#id23" id="vhost-configuration-tool" name="vhost-configuration-tool">3.2 VHost Configuration Tool</a></h3>
552<p>To assist administration of multiple virtual hosts a &quot;VHost Configuration Tool&quot;
553needs to be developed and implemented. Initial discussion regarding the VHost
554Config tool and proposed usage can be found at <a class="reference" href="http://article.gmane.org/gmane.linux.gentoo.devel/10874">http://article.gmane.org/gmane.linux.gentoo.devel/10874</a>.</p>
555<p>It's the job of the VHost Config toolset to make a local instance of the web
556application run under a specific web server.</p>
557<p>The VHost Configuration Utility will need to be a seperate package, maintained by Gentoo.</p>
558<p>Web Server .ebuilds will require the VHost Config tool as a dependency (DEPEND).</p>
559<p><a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=26293">Bug #26293</a> <a class="footnote-reference" href="#id5" id="id6" name="id6">[4]</a> will be used to track the initial progress of the VHost
560Configuration Tool.</p>
561<p>The vhost-config must do three main things:</p>
562<blockquote>
563<ul class="simple">
564<li>creates directories (copies a skeleton directory for the most part).</li>
565<li>create web server vhost config files.</li>
566<li>HUP web server so it reads in the new config without stopping.</li>
567</ul>
568</blockquote>
569<p>Initially the VHost Config tool should provide support for the Apache web
570server. As the tool matures support for other web servers can be added.</p>
571</div>
572<div class="section">
301<h3><a class="toc-backref" href="#id19" name="single-host-installation">3.1 Single Host Installation</a></h3> 573<h3><a class="toc-backref" href="#id24" id="single-host-installation" name="single-host-installation">3.3 Single Host Installation</a></h3>
302<p>For single host installations the .ebuild will make the required 574<p>For single host installations the .ebuild will make the required
303configurations changes and symlinks using the VHost Config tool to ensure 575configurations changes and symlinks using the VHost Config tool to ensure
304that the web application is available to be served from:</p> 576that the web application is available to be served from:</p>
305<pre class="literal-block"> 577<pre class="literal-block">
306/var/www/localhost/htdocs/${PN} 578/var/www/localhost/htdocs/${PF}/
307</pre> 579</pre>
580<p>In this case it may be feasible for the VHost Config tool to simply symlink the
581directories from /usr/share/webapps/${PF}/ as is appropriate.</p>
308</div> 582</div>
309<div class="section" id="virtual-host-installation"> 583<div class="section">
310<h3><a class="toc-backref" href="#id20" name="virtual-host-installation">3.2 Virtual Host Installation</a></h3> 584<h3><a class="toc-backref" href="#id25" id="virtual-host-installation" name="virtual-host-installation">3.4 Virtual Host Installation</a></h3>
311<p>For installations that support multiple virtual hosts the .ebuild will 585<p>For installations that support multiple virtual hosts the .ebuild will
312install the web application into the default location and then leave configuration 586install the web application into the default location and then leave configuration
313to the user through the VHost Config tool.</p> 587to the user through the VHost Config tool.</p>
314<p>&lt;&lt; TO BE EXPANDED UPON &gt;&gt;</p> 588<p>In this case the web application files will be copied from
589/usr/share/webapps/${PF}/ to /var/www/&lt;FQDN&gt;/ by the VHost Config tool.</p>
315</div> 590</div>
316</div> 591<div class="section">
317<div class="section" id="application-configuration"> 592<h3><a class="toc-backref" href="#id26" id="configuration-files" name="configuration-files">3.5 Configuration Files</a></h3>
318<h2><a class="toc-backref" href="#id21" name="application-configuration">4. Application Configuration</a></h2>
319<p>Having application configuration files in the Document Root of a web
320server is a potential security risk. Additionally given the way that many
321ebuilds currently install web applications it can also lead to the
322overwriting of important configuration files.</p>
323<p>As stated above web application configuration files are to be installed into:</p> 593<p>As stated above web application <em>site default</em> configuration files are to be
594installed into:</p>
324<pre class="literal-block"> 595<pre class="literal-block">
325/etc/webapps/${PF}/ 596/etc/webapps/${PF}/
326</pre> 597</pre>
327<p>By installing application configuration files in /etc Portage CONFIG_PROTECT 598<p>The files in this directory are then copied (not symlinked!) by the VHost
328features can be used to ensure that configuration files are not overwritten.</p> 599Config tool to the Document Root for each instance of the app that is installed.</p>
329<div class="section" id="virtual-host-support"> 600<p>This will require the VHost Config toolset to emulate Portage's CONFIG_PROTECT
330<h3><a class="toc-backref" href="#id22" name="virtual-host-support">4.1 Virtual Host Support</a></h3> 601behaviour for the web applications.</p>
331<p>&lt;&lt; TO BE EXPANDED UPON &gt;&gt;</p>
332</div> 602</div>
333</div> 603</div>
334<div class="section" id="application-permissions"> 604<div class="section">
335<h2><a class="toc-backref" href="#id23" name="application-permissions">5. Application Permissions</a></h2> 605<h2><a class="toc-backref" href="#id27" id="application-permissions" name="application-permissions">4. Application Permissions</a></h2>
336<p>Installing web applications and giving the web server ownership of the files 606<p>Installing web applications and giving the web server ownership of the files
337is a security risk. This can possibly lead to application configuration 607is a security risk. This can possibly lead to application configuration
338files being accessed by unwanted third parties.</p> 608files being accessed by unwanted third parties.</p>
339<p>All web applications should be owned by <em>root</em> unless the application 609<p>All web applications should be owned by <em>root</em> unless the application
340absolutely requires write access to its installation directories at execution 610absolutely requires write access to its installation directories at execution
341time.</p> 611time.</p>
342</div> 612</div>
343</div> 613</div>
344<div class="section" id="backwards-compatibility"> 614<div class="section">
345<h1><a class="toc-backref" href="#id24" name="backwards-compatibility">Backwards Compatibility</a></h1> 615<h1><a class="toc-backref" href="#id28" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
346<p>There may be some issues regarding compatibility with existing installs of 616<p>There may be some issues regarding compatibility with existing installs of
347web applications. This is particularly true if the default Document Root is 617web applications. This is particularly true if the default Document Root is
348moved from what is accepted as the current standard (/home/httpd).</p> 618moved from what is accepted as the current standard (/home/httpd).</p>
349<dl> 619<dl class="docutils">
350<dt>The main issues are:</dt> 620<dt>The main issues are:</dt>
351<dd><ul class="first last simple"> 621<dd><ul class="first last simple">
352<li>transition of existing configuration files to the 622<li>transition of existing configuration files to the
353/etc/webapps/${PF}/ directory.</li> 623/etc/webapps/${PF}/ directory.</li>
354<li>modification/reconfiguration of applications so that they 624<li>modification/reconfiguration of applications so that they
355are aware of the location of configuration files.</li> 625are aware of the location of configuration files.</li>
356<li>creating approriate Apache configuration snippets for inclusion 626<li>creating the VHost Config toolset to enable installation and
357in the Apache configuration files.</li> 627configuration of web applications irrespective of web server.</li>
358</ul> 628</ul>
359</dd> 629</dd>
360</dl> 630</dl>
361</div> 631</div>
362<div class="section" id="references"> 632<div class="section">
363<h1><a class="toc-backref" href="#id25" name="references">References</a></h1> 633<h1><a class="toc-backref" href="#id29" id="references" name="references">References</a></h1>
364<table class="footnote" frame="void" id="webapppost1" rules="none"> 634<table class="docutils footnote" frame="void" id="webapppost1" rules="none">
365<colgroup><col class="label" /><col /></colgroup> 635<colgroup><col class="label" /><col /></colgroup>
366<tbody valign="top"> 636<tbody valign="top">
367<tr><td class="label"><a name="webapppost1">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> <a class="reference" href="http://article.gmane.org/gmane.linux.gentoo.devel/10411">http://article.gmane.org/gmane.linux.gentoo.devel/10411</a></td></tr> 637<tr><td class="label"><a name="webapppost1">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> <a class="reference" href="http://article.gmane.org/gmane.linux.gentoo.devel/10411">http://article.gmane.org/gmane.linux.gentoo.devel/10411</a></td></tr>
368</tbody> 638</tbody>
369</table> 639</table>
370<table class="footnote" frame="void" id="webapppost2" rules="none"> 640<table class="docutils footnote" frame="void" id="webapppost2" rules="none">
371<colgroup><col class="label" /><col /></colgroup> 641<colgroup><col class="label" /><col /></colgroup>
372<tbody valign="top"> 642<tbody valign="top">
373<tr><td class="label"><a class="fn-backref" href="#id2" name="webapppost2">[2]</a></td><td><a class="reference" href="http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C1059843010.5023.80.camel%40carbon.internal.lan%3E">http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C1059843010.5023.80.camel%40carbon.internal.lan%3E</a></td></tr> 643<tr><td class="label"><a class="fn-backref" href="#id2" name="webapppost2">[2]</a></td><td><a class="reference" href="http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C1059843010.5023.80.camel%40carbon.internal.lan%3E">http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C1059843010.5023.80.camel%40carbon.internal.lan%3E</a></td></tr>
374</tbody> 644</tbody>
375</table> 645</table>
376<table class="footnote" frame="void" id="webapppost3" rules="none"> 646<table class="docutils footnote" frame="void" id="webapppost3" rules="none">
377<colgroup><col class="label" /><col /></colgroup> 647<colgroup><col class="label" /><col /></colgroup>
378<tbody valign="top"> 648<tbody valign="top">
379<tr><td class="label"><a class="fn-backref" href="#id3" name="webapppost3">[3]</a></td><td><a class="reference" href="http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C86960000.1060038977%40valkyrie.lsit.ucsb.edu%3E">http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C86960000.1060038977%40valkyrie.lsit.ucsb.edu%3E</a></td></tr> 649<tr><td class="label"><a class="fn-backref" href="#id3" name="webapppost3">[3]</a></td><td><a class="reference" href="http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C86960000.1060038977%40valkyrie.lsit.ucsb.edu%3E">http://news.gmane.org/onethread.php?group=gmane.linux.gentoo.devel&amp;root=%3C86960000.1060038977%40valkyrie.lsit.ucsb.edu%3E</a></td></tr>
380</tbody> 650</tbody>
381</table> 651</table>
652<table class="docutils footnote" frame="void" id="id5" rules="none">
653<colgroup><col class="label" /><col /></colgroup>
654<tbody valign="top">
655<tr><td class="label"><a class="fn-backref" href="#id6" name="id5">[4]</a></td><td><a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=26293">http://bugs.gentoo.org/show_bug.cgi?id=26293</a></td></tr>
656</tbody>
657</table>
382</div> 658</div>
383<div class="section" id="copyright"> 659<div class="section">
384<h1><a class="toc-backref" href="#id26" name="copyright">Copyright</a></h1> 660<h1><a class="toc-backref" href="#id30" id="copyright" name="copyright">Copyright</a></h1>
385<p>This document has been placed in the public domain.</p> 661<p>This document has been placed in the public domain.</p>
386</div> 662</div>
387</div>
388 663
389<hr class="footer"/> 664</div>
390<div class="footer"> 665<div class="footer">
666<hr class="footer" />
391<a class="reference" href="glep-0011.txt">View document source</a>. 667<a class="reference" href="glep-0011.txt">View document source</a>.
392Generated on: 2003-08-07 19:02 UTC. 668Generated on: 2006-10-10 20:23 UTC.
393Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 669Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
670
394</div> 671</div>
395</body> 672</body>
396</html> 673</html>
397 674

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.6

  ViewVC Help
Powered by ViewVC 1.1.20