/[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.8
1<?xml version="1.0" encoding="utf-8" ?> 1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- 4
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 11 -- Web Application Installation</title> 8 <title>GLEP 11 -- Web Application Installation</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
… …
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<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>] 20[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0011.txt">GLEP Source</a></b>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0011.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 24<col class="field-name" />
30<col class="field-body" /> 25<col class="field-body" />
31<tbody valign="top"> 26<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">11</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">11</td>
33</tr> 28</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Web Application Installation</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Web Application Installation</td>
35</tr> 30</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.6</td>
37</tr> 32</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> 33<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> 34</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> 35<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> 36</tr>
37<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>
38</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> 39<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> 40</tr>
44<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
45</tr> 42</tr>
46<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
47</tr> 44</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> 45<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> 46</tr>
50<tr class="field"><th class="field-name">Created:</th><td class="field-body">02 August 2003</td> 47<tr class="field"><th class="field-name">Created:</th><td class="field-body">02-August-2003</td>
51</tr> 48</tr>
52<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">07 Aug 2003</td> 49<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> 50</tr>
54</tbody> 51</tbody>
55</table> 52</table>
56<hr /> 53<hr />
57<div class="contents topic" id="contents"> 54<div class="contents topic">
58<p class="topic-title"><a name="contents">Contents</a></p> 55<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
59<ul class="simple"> 56<ul class="simple">
57<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> 58<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> 59<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> 60<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> 61<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> 62<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> 63<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> 64<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> 65<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> 66<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> 67<li><a class="reference" href="#apache-2" id="id17" name="id17">1.2 Apache 2</a></li>
70</ul>
71</li> 68</ul>
69</li>
70<li><a class="reference" href="#application-installation" id="id18" name="id18">2. Application Installation</a><ul>
71<li><a class="reference" href="#application-slots" id="id19" name="id19">2.1 Application SLOTs</a></li>
72<li><a class="reference" href="#installation-paths" id="id20" name="id20">2.2 Installation Paths</a></li>
73</ul>
74</li>
72<li><a class="reference" href="#virtual-host-flexibility" id="id15" name="id15">2. Virtual Host Flexibility</a><ul> 75<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> 76<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> 77<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> 78<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> 79<li><a class="reference" href="#virtual-host-installation" id="id25" name="id25">3.4 Virtual Host Installation</a></li>
80</ul> 80<li><a class="reference" href="#configuration-files" id="id26" name="id26">3.5 Configuration Files</a></li>
81</li> 81</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> 82</li>
85</li>
86<li><a class="reference" href="#application-permissions" id="id23" name="id23">5. Application Permissions</a></li> 83<li><a class="reference" href="#application-permissions" id="id27" name="id27">4. Application Permissions</a></li>
87</ul>
88</li> 84</ul>
85</li>
89<li><a class="reference" href="#backwards-compatibility" id="id24" name="id24">Backwards Compatibility</a></li> 86<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> 87<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> 88<li><a class="reference" href="#copyright" id="id30" name="id30">Copyright</a></li>
92</ul> 89</ul>
93</div> 90</div>
94<div class="section" id="credits"> 91<div class="section">
92<h1><a class="toc-backref" href="#id7" id="status" name="status">Status</a></h1>
93<p>As of 2006-09-03 the webapp eclass has existed for some time.</p>
94</div>
95<div class="section">
95<h1><a class="toc-backref" href="#id5" name="credits">Credits</a></h1> 96<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> 97<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> 98<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> 99<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;, 100Stuart 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> 101Robin H.Johnson &lt;robbat2 at gentoo.org&gt; and others</blockquote>
101</div> 102</div>
102<div class="section" id="definitions"> 103<div class="section">
103<h1><a class="toc-backref" href="#id6" name="definitions">Definitions</a></h1> 104<h1><a class="toc-backref" href="#id9" id="definitions" name="definitions">Definitions</a></h1>
104<blockquote> 105<blockquote>
105<dl> 106<dl class="docutils">
106<dt><em>Web Application</em></dt> 107<dt><em>Web Application</em></dt>
107<dd>an application that requires a web server to function and interacts with 108<dd>an application that requires a web server to function and interacts with
108the user via a browser</dd> 109the user via a browser</dd>
109<dt><em>Web Application Instance</em></dt> 110<dt><em>Web Application Instance</em></dt>
110<dd>An apparent install of the Web Application that is served up via the 111<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 119<dd>a location in the file system that forms the main document tree visible from
119the web</dd> 120the web</dd>
120</dl> 121</dl>
121</blockquote> 122</blockquote>
122</div> 123</div>
123<div class="section" id="conventions"> 124<div class="section">
124<h1><a class="toc-backref" href="#id7" name="conventions">Conventions</a></h1> 125<h1><a class="toc-backref" href="#id10" id="conventions" name="conventions">Conventions</a></h1>
125<blockquote> 126<blockquote>
126<p>When describing the location of a directory in the file system it 127<p>When describing the location of a directory in the file system it
127wil be shown <em>with</em> a trailing slash, eg:</p> 128wil be shown <em>with</em> a trailing slash, eg:</p>
128<pre class="literal-block"> 129<pre class="literal-block">
129/foo/bar/ 130/foo/bar/
… …
133<pre class="literal-block"> 134<pre class="literal-block">
134/foo/blah 135/foo/blah
135</pre> 136</pre>
136</blockquote> 137</blockquote>
137</div> 138</div>
138<div class="section" id="abstract"> 139<div class="section">
139<h1><a class="toc-backref" href="#id8" name="abstract">Abstract</a></h1> 140<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> 141<p>To define where and how web based applications should be installed by Gentoo.</p>
141</div> 142</div>
142<div class="section" id="motivation"> 143<div class="section">
143<h1><a class="toc-backref" href="#id9" name="motivation">Motivation</a></h1> 144<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 145<p>Currently there is no standard defined regarding the installation of web
145based applicaitons in Gentoo. This leads to ebuild authors creating a 146based applicaitons in Gentoo. This leads to ebuild authors creating a
146variety of methods to determine:</p> 147variety of methods to determine:</p>
147<blockquote> 148<blockquote>
148<ul class="simple"> 149<ul class="simple">
… …
155<p>Due to a lack of standard install method configuration files are at 156<p>Due to a lack of standard install method configuration files are at
156risk of being overwritten during upgrade, potentially causing system 157risk of being overwritten during upgrade, potentially causing system
157administrators down tine as they have to reconfigure web applications 158administrators down tine as they have to reconfigure web applications
158after an upgrade.</p> 159after an upgrade.</p>
159</div> 160</div>
160<div class="section" id="rationale"> 161<div class="section">
161<h1><a class="toc-backref" href="#id10" name="rationale">Rationale</a></h1> 162<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 163<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 164following points regarding how Gentoo handles the installation of web based
164applications:</p> 165applications:</p>
165<blockquote> 166<blockquote>
166<ol class="arabic"> 167<ol class="arabic">
… …
169</li> 170</li>
170<li><p class="first">Web applications should not have their configuration files installed 171<li><p class="first">Web applications should not have their configuration files installed
171under the Document Root of a web server.</p> 172under the Document Root of a web server.</p>
172<blockquote> 173<blockquote>
173<ol class="lowerroman simple"> 174<ol class="lowerroman simple">
174<li>Web Application must be slotted by their major version numbers to 175<li>Web Application must be slotted by their full version numbers to
175further avoid downtime when true configuration changes are required.</li> 176further avoid downtime when true configuration changes are required.</li>
176</ol> 177</ol>
177</blockquote> 178</blockquote>
178</li> 179</li>
179<li><p class="first">Web applications should not be owned by the same user as the web server.</p> 180<li><p class="first">Web applications should not be owned by the same user as the web server.</p>
… …
185application.</p> 186application.</p>
186</li> 187</li>
187</ol> 188</ol>
188</blockquote> 189</blockquote>
189</div> 190</div>
190<div class="section" id="implementation"> 191<div class="section">
191<h1><a class="toc-backref" href="#id11" name="implementation">Implementation</a></h1> 192<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 193<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> 194implements 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> 195<p>Stuart Herbert &lt;stuart at gentoo.org&gt; has committed:</p>
195<pre class="literal-block"> 196<pre class="literal-block">
196webapp-apache.eclass 197webapp-apache.eclass
197</pre> 198</pre>
198<p>to CVS, this is a stop-gap measure whilst this GLEP is being finalised.</p> 199<p>to CVS, this is a stop-gap measure whilst this GLEP is being finalised.</p>
199<div class="section" id="web-server"> 200<div class="section">
200<h2><a class="toc-backref" href="#id12" name="web-server">1. Web Server</a></h2> 201<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 202<p>A common default web server should be selected. Selection of a default web
202ensure that their applications contain configuration directives suitable for 203server 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 204<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> 205selected as the Gentoo default web server.</p>
205<p>Whilst it is acknowledged that other web servers do exist and are used, there 206<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 207different web servers, thus enabling web applications to be installed on a
207other than the default have enough knowledge to adapt configurations 208Gentoo system irrespective of the installed web server.</p>
208accordingly.</p> 209<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> 210<h3><a class="toc-backref" href="#id16" id="default-document-root" name="default-document-root">1.1 Default Document Root</a></h3>
211<p>The current default Document Root for Gentoo is /home/httpd/, this is
212unsuitable for a couple of reasons:</p>
213<blockquote>
214<ul class="simple">
215<li>/home/ may be exported via nfs to numerous other hosts, it is not
216acceptable to share publically accessible files with numerous hosts.</li>
217<li>there is a potential (all be it small) for a user name clash</li>
218</ul>
219</blockquote>
211<p>To ensure the greatest flexibility when installing applications the following 220<p>To ensure the greatest flexibility when installing applications the following
212<em>Document Root</em> locations are to be used:</p> 221<em>Document Root</em> locations are to be used:</p>
213<blockquote> 222<blockquote>
214<ul> 223<ul>
215<li><p class="first">For single host installations:</p> 224<li><p class="first">For single host installations:</p>
216<pre class="literal-block"> 225<pre class="literal-block">
217/var/www/localhost/htdocs/ 226/var/www/localhost/
218</pre> 227</pre>
219</li> 228</li>
220<li><p class="first">For multiple virtual host installastions:</p> 229<li><p class="first">For multiple virtual host installations:</p>
221<pre class="literal-block"> 230<pre class="literal-block">
222/var/www/&lt;fully qualified domain name&gt;/htdocs/ 231/var/www/&lt;fully qualified domain name&gt;/
232
223eg: 233eg:
224 /var/www/www.gentoo.org/htdocs/ 234 /var/www/www.gentoo.org/
225</pre> 235</pre>
226</li>
227</ul> 236</li>
237</ul>
228</blockquote> 238</blockquote>
239<p>Additionally the chosen location ( /var/www/ ) appears to be becoming a defacto
240standard for Linux distributions.</p>
229</div> 241</div>
230<div class="section" id="apache-2"> 242<div class="section">
231<h3><a class="toc-backref" href="#id14" name="apache-2">1.2 Apache 2</a></h3> 243<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 244<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> 245add support for Apache 2 as well as supporting Apache 1 installations.</p>
234</div> 246</div>
235</div> 247</div>
236<div class="section" id="virtual-host-flexibility"> 248<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> 249<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 250<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 251discussion suggest that this is not the best location to install web based
274applications.</p> 252applications.</p>
253<div class="section">
254<h3><a class="toc-backref" href="#id19" id="application-slots" name="application-slots">2.1 Application SLOTs</a></h3>
255<p>All ebuilds are to set the SLOT variable as follows:</p>
256<pre class="literal-block">
257SLOT=&quot;${PV}&quot;
258</pre>
259<p>Setting the SLOT variable as shown will enable different versions of the same
260web application to be served concurrently by one server.</p>
261</div>
262<div class="section">
263<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 264<p>Web applications should be installed outside of the Document Root using the following
276defaults:</p> 265defaults:</p>
277<blockquote> 266<blockquote>
278<ul> 267<ul>
279<li><p class="first">for files to be served to clients:</p> 268<li><p class="first">for files to be served to clients:</p>
280<pre class="literal-block"> 269<pre class="literal-block">
281/usr/share/webapps/${PF}/ 270/usr/share/webapps/${PF}/htdocs/
282 271
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 272/usr/share/webapps/${PF}/cgi-bin/
286</pre> 273</pre>
287</li> 274</li>
288<li><p class="first">install configuration files in:</p> 275<li><p class="first">install <em>site default</em> configuration files in:</p>
289<pre class="literal-block"> 276<pre class="literal-block">
290/etc/webapps/${PF}/ 277/etc/webapps/${PF}/
291</pre> 278</pre>
292</li> 279</li>
293<li><p class="first">for documentation files (not served to clients):</p> 280<li><p class="first">for documentation files (not served to clients):</p>
… …
295/usr/share/doc/${PF}/ 282/usr/share/doc/${PF}/
296</pre> 283</pre>
297</li> 284</li>
298</ul> 285</ul>
299</blockquote> 286</blockquote>
300<div class="section" id="single-host-installation"> 287</div>
288</div>
289<div class="section">
290<h2><a class="toc-backref" href="#id21" id="virtual-host-support" name="virtual-host-support">3. Virtual Host Support</a></h2>
291<p>The ability to easily configure and administer multiple virtual hosts is a
292must.</p>
293<div class="section">
294<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>
295<p>To enable support for multiple virtual host installations a new USE flag is
296to be added to Portage. The use flag will be:</p>
297<pre class="literal-block">
298vhost
299</pre>
300<p>When <em>vhost</em> is _set_ the installation location and configuration for the web
301application will be effected, see below for more details.</p>
302</div>
303<div class="section">
304<h3><a class="toc-backref" href="#id23" id="vhost-configuration-tool" name="vhost-configuration-tool">3.2 VHost Configuration Tool</a></h3>
305<p>To assist administration of multiple virtual hosts a &quot;VHost Configuration Tool&quot;
306needs to be developed and implemented. Initial discussion regarding the VHost
307Config 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>
308<p>It's the job of the VHost Config toolset to make a local instance of the web
309application run under a specific web server.</p>
310<p>The VHost Configuration Utility will need to be a seperate package, maintained by Gentoo.</p>
311<p>Web Server .ebuilds will require the VHost Config tool as a dependency (DEPEND).</p>
312<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
313Configuration Tool.</p>
314<p>The vhost-config must do three main things:</p>
315<blockquote>
316<ul class="simple">
317<li>creates directories (copies a skeleton directory for the most part).</li>
318<li>create web server vhost config files.</li>
319<li>HUP web server so it reads in the new config without stopping.</li>
320</ul>
321</blockquote>
322<p>Initially the VHost Config tool should provide support for the Apache web
323server. As the tool matures support for other web servers can be added.</p>
324</div>
325<div class="section">
301<h3><a class="toc-backref" href="#id19" name="single-host-installation">3.1 Single Host Installation</a></h3> 326<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 327<p>For single host installations the .ebuild will make the required
303configurations changes and symlinks using the VHost Config tool to ensure 328configurations changes and symlinks using the VHost Config tool to ensure
304that the web application is available to be served from:</p> 329that the web application is available to be served from:</p>
305<pre class="literal-block"> 330<pre class="literal-block">
306/var/www/localhost/htdocs/${PN} 331/var/www/localhost/htdocs/${PF}/
307</pre> 332</pre>
333<p>In this case it may be feasible for the VHost Config tool to simply symlink the
334directories from /usr/share/webapps/${PF}/ as is appropriate.</p>
308</div> 335</div>
309<div class="section" id="virtual-host-installation"> 336<div class="section">
310<h3><a class="toc-backref" href="#id20" name="virtual-host-installation">3.2 Virtual Host Installation</a></h3> 337<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 338<p>For installations that support multiple virtual hosts the .ebuild will
312install the web application into the default location and then leave configuration 339install the web application into the default location and then leave configuration
313to the user through the VHost Config tool.</p> 340to the user through the VHost Config tool.</p>
314<p>&lt;&lt; TO BE EXPANDED UPON &gt;&gt;</p> 341<p>In this case the web application files will be copied from
342/usr/share/webapps/${PF}/ to /var/www/&lt;FQDN&gt;/ by the VHost Config tool.</p>
315</div> 343</div>
316</div> 344<div class="section">
317<div class="section" id="application-configuration"> 345<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> 346<p>As stated above web application <em>site default</em> configuration files are to be
347installed into:</p>
324<pre class="literal-block"> 348<pre class="literal-block">
325/etc/webapps/${PF}/ 349/etc/webapps/${PF}/
326</pre> 350</pre>
327<p>By installing application configuration files in /etc Portage CONFIG_PROTECT 351<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> 352Config tool to the Document Root for each instance of the app that is installed.</p>
329<div class="section" id="virtual-host-support"> 353<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> 354behaviour for the web applications.</p>
331<p>&lt;&lt; TO BE EXPANDED UPON &gt;&gt;</p>
332</div> 355</div>
333</div> 356</div>
334<div class="section" id="application-permissions"> 357<div class="section">
335<h2><a class="toc-backref" href="#id23" name="application-permissions">5. Application Permissions</a></h2> 358<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 359<p>Installing web applications and giving the web server ownership of the files
337is a security risk. This can possibly lead to application configuration 360is a security risk. This can possibly lead to application configuration
338files being accessed by unwanted third parties.</p> 361files being accessed by unwanted third parties.</p>
339<p>All web applications should be owned by <em>root</em> unless the application 362<p>All web applications should be owned by <em>root</em> unless the application
340absolutely requires write access to its installation directories at execution 363absolutely requires write access to its installation directories at execution
341time.</p> 364time.</p>
342</div> 365</div>
343</div> 366</div>
344<div class="section" id="backwards-compatibility"> 367<div class="section">
345<h1><a class="toc-backref" href="#id24" name="backwards-compatibility">Backwards Compatibility</a></h1> 368<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 369<p>There may be some issues regarding compatibility with existing installs of
347web applications. This is particularly true if the default Document Root is 370web applications. This is particularly true if the default Document Root is
348moved from what is accepted as the current standard (/home/httpd).</p> 371moved from what is accepted as the current standard (/home/httpd).</p>
349<dl> 372<dl class="docutils">
350<dt>The main issues are:</dt> 373<dt>The main issues are:</dt>
351<dd><ul class="first last simple"> 374<dd><ul class="first last simple">
352<li>transition of existing configuration files to the 375<li>transition of existing configuration files to the
353/etc/webapps/${PF}/ directory.</li> 376/etc/webapps/${PF}/ directory.</li>
354<li>modification/reconfiguration of applications so that they 377<li>modification/reconfiguration of applications so that they
355are aware of the location of configuration files.</li> 378are aware of the location of configuration files.</li>
356<li>creating approriate Apache configuration snippets for inclusion 379<li>creating the VHost Config toolset to enable installation and
357in the Apache configuration files.</li> 380configuration of web applications irrespective of web server.</li>
358</ul> 381</ul>
359</dd> 382</dd>
360</dl> 383</dl>
361</div> 384</div>
362<div class="section" id="references"> 385<div class="section">
363<h1><a class="toc-backref" href="#id25" name="references">References</a></h1> 386<h1><a class="toc-backref" href="#id29" id="references" name="references">References</a></h1>
364<table class="footnote" frame="void" id="webapppost1" rules="none"> 387<table class="docutils footnote" frame="void" id="webapppost1" rules="none">
365<colgroup><col class="label" /><col /></colgroup> 388<colgroup><col class="label" /><col /></colgroup>
366<tbody valign="top"> 389<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> 390<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> 391</tbody>
369</table> 392</table>
370<table class="footnote" frame="void" id="webapppost2" rules="none"> 393<table class="docutils footnote" frame="void" id="webapppost2" rules="none">
371<colgroup><col class="label" /><col /></colgroup> 394<colgroup><col class="label" /><col /></colgroup>
372<tbody valign="top"> 395<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> 396<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> 397</tbody>
375</table> 398</table>
376<table class="footnote" frame="void" id="webapppost3" rules="none"> 399<table class="docutils footnote" frame="void" id="webapppost3" rules="none">
377<colgroup><col class="label" /><col /></colgroup> 400<colgroup><col class="label" /><col /></colgroup>
378<tbody valign="top"> 401<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> 402<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> 403</tbody>
381</table> 404</table>
405<table class="docutils footnote" frame="void" id="id5" rules="none">
406<colgroup><col class="label" /><col /></colgroup>
407<tbody valign="top">
408<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>
409</tbody>
410</table>
382</div> 411</div>
383<div class="section" id="copyright"> 412<div class="section">
384<h1><a class="toc-backref" href="#id26" name="copyright">Copyright</a></h1> 413<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> 414<p>This document has been placed in the public domain.</p>
386</div> 415</div>
387</div>
388 416
389<hr class="footer"/> 417</div>
390<div class="footer"> 418<div class="footer">
419<hr class="footer" />
391<a class="reference" href="glep-0011.txt">View document source</a>. 420<a class="reference" href="glep-0011.txt">View document source</a>.
392Generated on: 2003-08-07 19:02 UTC. 421Generated on: 2007-10-13 13:39 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. 422Generated 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.
423
394</div> 424</div>
395</body> 425</body>
396</html> 426</html>
397 427
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.8
  ViewVC Help
Powered by ViewVC 1.1.13