mirror of
https://github.com/apache/httpd.git
synced 2025-04-18 22:24:07 +03:00
01055edef2
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1907148 13f79535-47bb-0310-9956-ffa450edef68
330 lines
18 KiB
XML
330 lines
18 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
<!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_macro - Apache HTTP Server Version 2.5</title>
|
||
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
||
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
||
<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" />
|
||
<script src="../style/scripts/prettify.min.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<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>
|
||
<p class="apache">Apache HTTP Server Version 2.5</p>
|
||
<img alt="" src="../images/feather.png" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_macro</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_macro.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides macros within apache httpd runtime configuration files</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>macro_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_macro.c</td></tr>
|
||
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.5 and later</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
|
||
<p>Provides macros within Apache httpd runtime configuration files,
|
||
to ease the process of creating numerous similar configuration
|
||
blocks. When the server starts up, the macros are expanded using the
|
||
provided parameters, and the result is processed as along with the
|
||
rest of the configuration file.</p>
|
||
|
||
</div>
|
||
<div id="quickview"><h3>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#usage">Usage</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#tips">Tips</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
|
||
</ul><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#macro"><Macro></a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#macroignorebadnesting">MacroIgnoreBadNesting</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#macroignoreemptyargs">MacroIgnoreEmptyArgs</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#undefmacro">UndefMacro</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#use">Use</a></li>
|
||
</ul>
|
||
<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_macro">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_macro">Report a bug</a></li></ul><h3>See also</h3>
|
||
<ul class="seealso">
|
||
<li><a href="#comments_section">Comments</a></li></ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="usage" id="usage">Usage</a> <a title="Permanent link" href="#usage" class="permalink">¶</a></h2>
|
||
|
||
<p>Macros are defined using <code class="directive"><a href="#macro"><Macro></a></code> blocks, which contain the portion of
|
||
your configuration that needs to be repeated, complete with variables
|
||
for those parts that will need to be substituted.</p>
|
||
|
||
<p>For example, you might use a macro to define a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> block, in order to define
|
||
multiple similar virtual hosts:</p>
|
||
|
||
<pre class="prettyprint lang-config"><Macro VHost $name $domain>
|
||
<VirtualHost *:80>
|
||
ServerName $domain
|
||
ServerAlias www.$domain
|
||
|
||
DocumentRoot "/var/www/vhosts/$name"
|
||
ErrorLog "/var/log/httpd/$name.error_log"
|
||
CustomLog "/var/log/httpd/$name.access_log" combined
|
||
</VirtualHost>
|
||
</Macro></pre>
|
||
|
||
|
||
<p>Macro names are case-insensitive, like httpd configuration
|
||
directives. However, variable names are case sensitive.</p>
|
||
|
||
<p>You would then invoke this macro several times to create virtual
|
||
hosts:</p>
|
||
|
||
<pre class="prettyprint lang-config">Use VHost example example.com
|
||
Use VHost myhost hostname.org
|
||
Use VHost apache apache.org
|
||
|
||
UndefMacro VHost</pre>
|
||
|
||
|
||
<p>At server startup time, each of these <code class="directive"><a href="#use">Use</a></code>
|
||
invocations would be expanded into a full virtualhost, as
|
||
described by the <code class="directive"><a href="#macro"><Macro></a></code>
|
||
definition.</p>
|
||
|
||
<p>The <code class="directive"><a href="#undefmacro">UndefMacro</a></code> directive is
|
||
used so that later macros using the same variable names don't result in
|
||
conflicting definitions.</p>
|
||
|
||
<p>A more elaborate version of this example may be seen below in the
|
||
Examples section.</p>
|
||
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="tips" id="tips">Tips</a> <a title="Permanent link" href="#tips" class="permalink">¶</a></h2>
|
||
|
||
<p>Parameter names should begin with a sigil such as <code>$</code>,
|
||
<code>%</code>, or <code>@</code>, so that they are clearly
|
||
identifiable, and also in order to help deal with interactions with
|
||
other directives, such as the core <code class="directive"><a href="../mod/core.html#define">Define</a></code> directive. Failure to do so will
|
||
result in a warning. Nevertheless, you are encouraged to have a good
|
||
knowledge of your entire server configuration in order to avoid reusing
|
||
the same variables in different scopes, which can cause confusion.</p>
|
||
|
||
<p>Parameters prefixed with either <code>$</code> or <code>%</code> are
|
||
not escaped. Parameters prefixes with <code>@</code> are escaped in
|
||
quotes.</p>
|
||
|
||
<p>Avoid using a parameter which contains another parameter as a prefix,
|
||
(For example, <code>$win</code> and <code>$winter</code>) as this may
|
||
cause confusion at expression evaluation time. In the event of such
|
||
confusion, the longest possible parameter name is used.</p>
|
||
|
||
<p>If you want to use a value within another string, it is useful to
|
||
surround the parameter in braces, to avoid confusion:</p>
|
||
|
||
<pre class="prettyprint lang-config"><Macro DocRoot ${docroot}>
|
||
DocumentRoot "/var/www/${docroot}/htdocs"
|
||
</Macro></pre>
|
||
|
||
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="examples" id="examples">Examples</a> <a title="Permanent link" href="#examples" class="permalink">¶</a></h2>
|
||
|
||
|
||
<h3>Virtual Host Definition</h3>
|
||
|
||
|
||
<p>A common usage of <code class="module"><a href="../mod/mod_macro.html">mod_macro</a></code> is for the creation of
|
||
dynamically-generated virtual hosts.</p>
|
||
|
||
<pre class="prettyprint lang-config">## Define a VHost Macro for repetitive configurations
|
||
|
||
<Macro VHost $host $port $dir>
|
||
Listen $port
|
||
<VirtualHost *:$port>
|
||
|
||
ServerName $host
|
||
DocumentRoot "$dir"
|
||
|
||
# Public document root
|
||
<Directory "$dir">
|
||
Require all granted
|
||
</Directory>
|
||
|
||
# limit access to intranet subdir.
|
||
<Directory "$dir/intranet">
|
||
Require ip 10.0.0.0/8
|
||
</Directory>
|
||
</VirtualHost>
|
||
</Macro>
|
||
|
||
## Use of VHost with different arguments.
|
||
|
||
Use VHost www.apache.org 80 /vhosts/apache/htdocs
|
||
Use VHost example.org 8080 /vhosts/example/htdocs
|
||
Use VHost www.example.fr 1234 /vhosts/example.fr/htdocs</pre>
|
||
|
||
|
||
|
||
<h3>Removal of a macro definition</h3>
|
||
|
||
|
||
<p>It's recommended that you undefine a macro once you've used it. This
|
||
avoids confusion in a complex configuration file where there may be
|
||
conflicts in variable names.</p>
|
||
|
||
<pre class="prettyprint lang-config"><Macro DirGroup $dir $group>
|
||
<Directory "$dir">
|
||
Require group $group
|
||
</Directory>
|
||
</Macro>
|
||
|
||
Use DirGroup /www/apache/private private
|
||
Use DirGroup /www/apache/server admin
|
||
|
||
UndefMacro DirGroup</pre>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="Macro" id="Macro"><Macro></a> <a name="macro" id="macro">Directive</a> <a title="Permanent link" href="#macro" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a configuration file macro</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>
|
||
<Macro <var>name</var> [<var>par1</var> .. <var>parN</var>]>
|
||
... </Macro></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
|
||
</table>
|
||
<p>The <code class="directive"><Macro></code> directive controls the
|
||
definition of a macro within the server runtime configuration files.
|
||
The first argument is the name of the macro.
|
||
Other arguments are parameters to the macro. It is good practice to prefix
|
||
parameter names with any of '<code>$%@</code>', and not macro names
|
||
with such characters.
|
||
</p>
|
||
|
||
<pre class="prettyprint lang-config"><Macro LocalAccessPolicy>
|
||
Require ip 10.2.16.0/24
|
||
</Macro>
|
||
|
||
<Macro RestrictedAccessPolicy $ipnumbers>
|
||
Require ip $ipnumbers
|
||
</Macro></pre>
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="MacroIgnoreBadNesting" id="MacroIgnoreBadNesting">MacroIgnoreBadNesting</a> <a name="macroignorebadnesting" id="macroignorebadnesting">Directive</a> <a title="Permanent link" href="#macroignorebadnesting" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore warnings, and does not log, about bad nesting of Macros</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MacroIgnoreBadNesting</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
|
||
</table>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="MacroIgnoreEmptyArgs" id="MacroIgnoreEmptyArgs">MacroIgnoreEmptyArgs</a> <a name="macroignoreemptyargs" id="macroignoreemptyargs">Directive</a> <a title="Permanent link" href="#macroignoreemptyargs" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore warnings, and does not log, about empty Macro argument(s)</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MacroIgnoreEmptyArgs</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
|
||
</table>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="UndefMacro" id="UndefMacro">UndefMacro</a> <a name="undefmacro" id="undefmacro">Directive</a> <a title="Permanent link" href="#undefmacro" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine a macro</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UndefMacro <var>name</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">UndefMacro</code> directive undefines a macro
|
||
which has been defined before hand.</p>
|
||
|
||
<pre class="prettyprint lang-config">UndefMacro LocalAccessPolicy
|
||
UndefMacro RestrictedAccessPolicy</pre>
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="Use" id="Use">Use</a> <a name="use" id="use">Directive</a> <a title="Permanent link" href="#use" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use a macro</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Use <var>name</var> [<var>value1</var> ... <var>valueN</var>]
|
||
</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">Use</code> directive controls the use of a macro.
|
||
The specified macro is expanded. It must be given the same number of
|
||
arguments as in the macro definition. The provided values are
|
||
associated to their corresponding initial parameters and are substituted
|
||
before processing.</p>
|
||
|
||
<pre class="prettyprint lang-config">Use LocalAccessPolicy
|
||
...
|
||
Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"</pre>
|
||
|
||
|
||
<p>is equivalent, with the macros defined above, to:</p>
|
||
|
||
<pre class="prettyprint lang-config">Require ip 10.2.16.0/24
|
||
...
|
||
Require ip 192.54.172.0/24 192.54.148.0/24</pre>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_macro.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</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&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
|
||
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
var comments_shortname = 'httpd';
|
||
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_macro.html';
|
||
(function(w, d) {
|
||
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
|
||
d.write('<div id="comments_thread"><\/div>');
|
||
var s = d.createElement('script');
|
||
s.type = 'text/javascript';
|
||
s.async = true;
|
||
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
|
||
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
||
}
|
||
else {
|
||
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
|
||
}
|
||
})(window, document);
|
||
//--><!]]></script></div><div id="footer">
|
||
<p class="apache">Copyright 2023 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>
|
||
<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[//><!--
|
||
if (typeof(prettyPrint) !== 'undefined') {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |