Apache Module mod_macro
Define a VHost Macro for repetitive configurations Listen $port ServerName $host DocumentRoot $dir
Public document root Require all granted
limit access to intranet subdir. Require ip 10.0.0.0/8
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/exa
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.
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.
block, in order to define multiple similar virtual hosts:
Macro names are case-insensitive, like httpd configuration directives. However, variable names are case sensitive.
You would then invoke this macro several times to create virtual hosts:
Use VHost example example.com Use VHost myhost hostname.org Use VHost apache apache.org UndefMacro VHost
At server startup time, each of these Use
invocations would be expanded into a full virtualhost, as described by the Macro
directive is used so that later macros using the same variable names don't result in conflicting definitions.
A more elaborate version of this example may be seen below in the Examples section.
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.Define
Parameters prefixed with either $
are not escaped. Parameters prefixes with @
Avoid using a parameter which contains another parameter as a prefix, (For example, $win
) as this may cause confusion at expression evaluation time. In the event of such confusion, the longest possible parameter name is used.
If you want to use a value within another string, it is useful to surround the parameter in braces, to avoid confusion:
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.
Use name [value1 ... valueN]
is equivalent, with the macros defined above, to:
Modules | Directives | FAQ | Glossary | Sitemap
Apache HTTP Server Version 2.4
Apache Module mod_macro
Available Languages: en | fr
Tips
Parameter names should begin with a sigil such as $, %, or @, so that they are clearly identifiable, and also in order to help deal with interactions with other directives, such as the core Define directive. Failure to do so will result in a warning. Nevertheless, you are encouraged to have a good k
Examples
A common usage of mod_macro is for the creation of dynamically-generated virtual hosts.
Directive
The Macro 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 '$%@', and not macro names with such characters.
UndefMacro Directive
The UndefMacro directive undefines a macro which has been defined before hand.
Use Directive
The Use 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.