]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_unixd.html.en
ye gods what have I done
[apache] / docs / manual / mod / mod_unixd.html.en
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5               This file is generated from xml source: DO NOT EDIT
6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7       -->
8 <title>mod_unixd - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
13 </script>
14
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
16 <body>
17 <div id="page-header">
18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
22 <div id="path">
23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_unixd</h1>
26 <div class="toplang">
27 <p><span>Available Languages: </span><a href="../en/mod/mod_unixd.html" title="English">&nbsp;en&nbsp;</a> |
28 <a href="../tr/mod/mod_unixd.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
29 </div>
30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Basic (required) security for Unix-family platforms.</td></tr>
31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>unixd_module</td></tr>
33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_unixd.c</td></tr></table>
34 </div>
35 <div id="quickview"><h3 class="directives">Directives</h3>
36 <ul id="toc">
37 <li><img alt="" src="../images/down.gif" /> <a href="#chrootdir">ChrootDir</a></li>
38 <li><img alt="" src="../images/down.gif" /> <a href="#group">Group</a></li>
39 <li><img alt="" src="../images/down.gif" /> <a href="#suexec">Suexec</a></li>
40 <li><img alt="" src="../images/down.gif" /> <a href="#user">User</a></li>
41 </ul>
42 <h3>See also</h3>
43 <ul class="seealso">
44 <li><a href="../suexec.html">suEXEC support</a></li>
45 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
46
47 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
48 <div class="directive-section"><h2><a name="ChrootDir" id="ChrootDir">ChrootDir</a> <a name="chrootdir" id="chrootdir">Directive</a></h2>
49 <table class="directive">
50 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory for apache to run chroot(8) after startup.</td></tr>
51 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ChrootDir <var>/path/to/directory</var></code></td></tr>
52 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
53 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
54 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
55 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_unixd.html">mod_unixd</a></code></td></tr>
56 </table>
57     <p>This directive tells the server to <var>chroot(8)</var> to the
58     specified directory after startup, but before accepting requests
59     over the 'net.</p>
60     <p>Note that running the server under chroot is not simple,
61     and requires additional setup, particularly if you are running
62     scripts such as CGI or PHP.  Please make sure you are properly
63     familiar with the operation of chroot before attempting to use
64     this feature.</p>
65
66 </div>
67 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
68 <div class="directive-section"><h2><a name="Group" id="Group">Group</a> <a name="group" id="group">Directive</a></h2>
69 <table class="directive">
70 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Group under which the server will answer
71 requests</td></tr>
72 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Group <var>unix-group</var></code></td></tr>
73 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Group #-1</code></td></tr>
74 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
75 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
76 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_unixd</td></tr>
77 </table>
78     <p>The <code class="directive">Group</code> directive sets the group under
79     which the server will answer requests. In order to use this
80     directive, the server must be run initially as <code>root</code>. If
81     you start the server as a non-root user, it will fail to change to the
82     specified group, and will instead continue to run as the group of the
83     original user. <var>Unix-group</var> is one of:</p>
84
85     <dl>
86       <dt>A group name</dt>
87       <dd>Refers to the given group by name.</dd>
88
89       <dt><code>#</code> followed by a group number.</dt>
90       <dd>Refers to a group by its number.</dd>
91     </dl>
92
93     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
94       Group www-group
95       </pre>
96 </div>
97
98     <p>It is recommended that you set up a new group specifically for
99     running the server. Some admins use user <code>nobody</code>,
100     but this is not always possible or desirable.</p>
101
102     <div class="warning"><h3>Security</h3>
103       <p>Don't set <code class="directive">Group</code> (or <code class="directive"><a href="#user">User</a></code>) to <code>root</code> unless
104       you know exactly what you are doing, and what the dangers are.</p>
105     </div>
106
107
108 <h3>See also</h3>
109 <ul>
110 <li><code class="directive"><a href="../mod/mod_privileges.html#vhostgroup">VHostGroup</a></code></li>
111 <li><code class="directive"><a href="../mod/mod_suexec.html#suexecusergroup">SuexecUserGroup</a></code></li>
112 </ul>
113 </div>
114 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
115 <div class="directive-section"><h2><a name="Suexec" id="Suexec">Suexec</a> <a name="suexec" id="suexec">Directive</a></h2>
116 <table class="directive">
117 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable or disable the suEXEC feature</td></tr>
118 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Suexec On|Off</code></td></tr>
119 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>On if suexec binary exists with proper owner and mode,
120 Off otherwise</code></td></tr>
121 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
122 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
123 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_unixd</td></tr>
124 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.3.9 and later</td></tr>
125 </table>
126     <p>When On, startup will fail if the suexec binary doesn't exist
127     or has an invalid owner or file mode.</p>
128     <p>When Off, suEXEC will be disabled even if the suexec binary exists
129     and has a valid owner and file mode.</p>
130
131 </div>
132 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
133 <div class="directive-section"><h2><a name="User" id="User">User</a> <a name="user" id="user">Directive</a></h2>
134 <table class="directive">
135 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The userid under which the server will answer
136 requests</td></tr>
137 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>User <var>unix-userid</var></code></td></tr>
138 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>User #-1</code></td></tr>
139 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
140 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
141 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_unixd</td></tr>
142 </table>
143     <p>The <code class="directive">User</code> directive sets the user ID as
144     which the server will answer requests. In order to use this
145     directive, the server must be run initially as <code>root</code>.
146     If you start the server as a non-root user, it will fail to change
147     to the lesser privileged user, and will instead continue to run as
148     that original user. If you do start the server as <code>root</code>,
149     then it is normal for the parent process to remain running as root.
150     <var>Unix-userid</var> is one of:</p>
151
152     <dl>
153       <dt>A username</dt>
154       <dd>Refers to the given user by name.</dd>
155
156       <dt># followed by a user number.</dt>
157       <dd>Refers to a user by its number.</dd>
158     </dl>
159
160     <p>The user should have no privileges that result in it being
161     able to access files that are not intended to be visible to the
162     outside world, and similarly, the user should not be able to
163     execute code that is not meant for HTTP requests. It is
164     recommended that you set up a new user and group specifically for
165     running the server. Some admins use user <code>nobody</code>, but
166     this is not always desirable, since the <code>nobody</code> user
167     can have other uses on the system.</p>
168
169     <div class="warning"><h3>Security</h3>
170       <p>Don't set <code class="directive">User</code> (or <code class="directive"><a href="#group">Group</a></code>) to <code>root</code> unless
171       you know exactly what you are doing, and what the dangers are.</p>
172     </div>
173
174
175 <h3>See also</h3>
176 <ul>
177 <li><code class="directive"><a href="../mod/mod_privileges.html#vhostuser">VHostUser</a></code></li>
178 <li><code class="directive"><a href="../mod/mod_suexec.html#suexecusergroup">SuexecUserGroup</a></code></li>
179 </ul>
180 </div>
181 </div>
182 <div class="bottomlang">
183 <p><span>Available Languages: </span><a href="../en/mod/mod_unixd.html" title="English">&nbsp;en&nbsp;</a> |
184 <a href="../tr/mod/mod_unixd.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
185 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
186 <script type="text/javascript"><!--//--><![CDATA[//><!--
187 var comments_shortname = 'httpd';
188 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_unixd.html';
189 (function(w, d) {
190     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
191         d.write('<div id="comments_thread"><\/div>');
192         var s = d.createElement('script');
193         s.type = 'text/javascript';
194         s.async = true;
195         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
196         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
197     }
198     else {
199         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
200     }
201 })(window, document);
202 //--><!]]></script></div><div id="footer">
203 <p class="apache">Copyright 2013 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
204 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
205 if (typeof(prettyPrint) !== 'undefined') {
206     prettyPrint();
207 }
208 //--><!]]></script>
209 </body></html>