Commit fc790def authored by Sander Temme's avatar Sander Temme
Browse files

Document r399947, addition of optional scheme:// to ServerName directive

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@406697 13f79535-47bb-0310-9956-ffa450edef68
parent 25300ab7
Loading
Loading
Loading
Loading
+19 −8
Changes for docs/manual/mod/core.html.en: 19 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -2567,7 +2567,7 @@ to name-virtual hosts</td></tr>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
itself</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
@@ -2575,7 +2575,8 @@ itself</td></tr>
     directive supersedes the functionality of the <code class="directive">Port</code>
     directive from version 1.3.</td></tr>
</table>
    <p>The <code class="directive">ServerName</code> directive sets the hostname and
    <p>The <code class="directive">ServerName</code> directive sets the
    request scheme, hostname and
    port that the server uses to identify itself.  This is used when
    creating redirection URLs. For example, if the name of the
    machine hosting the web server is <code>simple.example.com</code>,
@@ -2590,11 +2591,10 @@ itself</td></tr>
    <p>If no <code class="directive">ServerName</code> is specified, then the
    server attempts to deduce the hostname by performing a reverse
    lookup on the IP address. If no port is specified in the
    <code class="directive">ServerName</code>, then the server will use the port
    from the incoming
    request. For optimal reliability and predictability, you should
    specify an explicit hostname and port using the
    <code class="directive">ServerName</code> directive.</p>
    <code class="directive">ServerName</code>, then the server will use the
    port from the incoming request. For optimal reliability and
    predictability, you should specify an explicit hostname and port
    using the <code class="directive">ServerName</code> directive.</p>

    <p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>,
    the <code class="directive">ServerName</code> inside a
@@ -2602,14 +2602,25 @@ itself</td></tr>
    section specifies what hostname must appear in the request's
    <code>Host:</code> header to match this virtual host.</p>


    <p>Sometimes, the server runs behind a device that processes SSL,
    such as a reverse proxy, load balancer or SSL offload
    appliance. When this is the case, specify the
    <code>https://</code> scheme and the port number to which the
    clients connect in the <code class="directive">ServerName</code> directive
    to make sure that the server generates the correct
    self-referential URLs. 
    </p>

    <p>See the description of the
    <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and
    <code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code>directives for
    settings which determine whether self-referential URL's (e.g., by the
    settings which determine whether self-referential URLs (e.g., by the
    <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module) will refer to the
    specified port, or to the port number given in the client's request.
    </p>


<h3>See also</h3>
<ul>
<li><a href="../dns-caveats.html">Issues Regarding DNS and
+19 −8
Changes for docs/manual/mod/core.xml: 19 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -2555,7 +2555,7 @@ to name-virtual hosts</description>
<name>ServerName</name>
<description>Hostname and port that the server uses to identify
itself</description>
<syntax>ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
<syntax>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<compatibility>In version 2.0, this
@@ -2563,7 +2563,8 @@ itself</description>
     directive from version 1.3.</compatibility>

<usage>
    <p>The <directive>ServerName</directive> directive sets the hostname and
    <p>The <directive>ServerName</directive> directive sets the
    request scheme, hostname and
    port that the server uses to identify itself.  This is used when
    creating redirection URLs. For example, if the name of the
    machine hosting the web server is <code>simple.example.com</code>,
@@ -2578,11 +2579,10 @@ itself</description>
    <p>If no <directive>ServerName</directive> is specified, then the
    server attempts to deduce the hostname by performing a reverse
    lookup on the IP address. If no port is specified in the
    <directive>ServerName</directive>, then the server will use the port
    from the incoming
    request. For optimal reliability and predictability, you should
    specify an explicit hostname and port using the
    <directive>ServerName</directive> directive.</p>
    <directive>ServerName</directive>, then the server will use the
    port from the incoming request. For optimal reliability and
    predictability, you should specify an explicit hostname and port
    using the <directive>ServerName</directive> directive.</p>

    <p>If you are using <a
    href="../vhosts/name-based.html">name-based virtual hosts</a>,
@@ -2591,13 +2591,24 @@ itself</description>
    section specifies what hostname must appear in the request's
    <code>Host:</code> header to match this virtual host.</p>


    <p>Sometimes, the server runs behind a device that processes SSL,
    such as a reverse proxy, load balancer or SSL offload
    appliance. When this is the case, specify the
    <code>https://</code> scheme and the port number to which the
    clients connect in the <directive>ServerName</directive> directive
    to make sure that the server generates the correct
    self-referential URLs. 
    </p>

    <p>See the description of the
    <directive module="core">UseCanonicalName</directive> and
    <directive module="core">UseCanonicalPhysicalPort</directive>directives for
    settings which determine whether self-referential URL's (e.g., by the
    settings which determine whether self-referential URLs (e.g., by the
    <module>mod_dir</module> module) will refer to the
    specified port, or to the port number given in the client's request.
    </p>

</usage>

<seealso><a href="../dns-caveats.html">Issues Regarding DNS and
+1 −1
Changes for docs/manual/mod/quickreference.html.en: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -625,7 +625,7 @@ messages sent to the client</td></tr>
<tr><td><a href="core.html#serveralias">ServerAlias <var>hostname</var> [<var>hostname</var>] ...</a></td><td></td><td>v</td><td>C</td></tr><tr><td class="descr" colspan="4">Alternate names for a host used when matching requests
to name-virtual hosts</td></tr>
<tr class="odd"><td><a href="mpm_common.html#serverlimit">ServerLimit <var>number</var></a></td><td></td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Upper limit on configurable number of processes</td></tr>
<tr><td><a href="core.html#servername">ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</a></td><td></td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Hostname and port that the server uses to identify
<tr><td><a href="core.html#servername">ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</a></td><td></td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Hostname and port that the server uses to identify
itself</td></tr>
<tr class="odd"><td><a href="core.html#serverpath">ServerPath <var>URL-path</var></a></td><td></td><td>v</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Legacy URL pathname for a name-based virtual host that
is accessed by an incompatible browser</td></tr>