Apache: Модуль Apache mod

RU EN

Пункт 163. Модуль Apache mod_macro

Предоставляет макросы в файлах конфигурации времени выполнения Apache httpd, чтобы упростить процесс создания множества похожих блоков конфигурации. Когда сервер запускается, макросы раскрываются с использованием предоставленных параметров, а результат обрабатывается вместе с остальной частью файла конфигурации.

Применение

Макросы определяются с помощью <Macro> блоков, которые содержат часть вашей конфигурации, которую необходимо повторить, вместе с переменными для тех частей, которые нужно будет заменить.

Например, вы можете использовать макрос для определения <VirtualHost> блока, чтобы определить несколько похожих виртуальных хостов:

 <Макро VHost $имя $домен>
<Виртуальный хост *:80>
 имя_сервера $domain
 Псевдоним сервера www.$domain
 DocumentRoot "/var/www/vhosts/$имя"
 ErrorLog "/var/log/httpd/$name.error_log"
 CustomLog "/var/log/httpd/$name.access_log" в сочетании
</ виртуальный хост>
</Макрос>

Имена макросов нечувствительны к регистру, как директивы конфигурации httpd. Однако имена переменных чувствительны к регистру.

Затем вы должны несколько раз вызвать этот макрос для создания виртуальных хостов:

 Используйте пример VHost example.com
Используйте VHost myhost hostname.org
Используйте виртуальный хост apache apache.org
UndefMacro VHost

Во время запуска сервера каждый из этих Use вызовов будет расширен до полного виртуального хоста, как описано в <Macro> определении.

Директива UndefMacro используется для того, чтобы более поздние макросы, использующие те же имена переменных, не приводили к конфликтующим определениям.

Более сложную версию этого примера можно увидеть ниже в разделе «Примеры».

Советы

Имена параметров должны начинаться с символа, такого как $ , % , или @ , чтобы их можно было четко идентифицировать, а также для облегчения взаимодействия с другими директивами, такими как основная Define директива. Невыполнение этого требования приведет к предупреждению. Тем не менее, вам рекомендуется хорошо знать всю конфигурацию вашего сервера, чтобы избежать повторного использования одних и тех же переменных в разных областях, что может вызвать путаницу.

Параметры с префиксом $ или % не экранируются. Префиксы параметров @ заключены в кавычки.

Избегайте использования параметра, который содержит другой параметр в качестве префикса (например, $win и $winter ), так как это может привести к путанице во время вычисления выражения. В случае такой путаницы используется максимально длинное имя параметра.

Если вы хотите использовать значение в другой строке, полезно заключить параметр в фигурные скобки, чтобы избежать путаницы:

 <Макрокорень документа ${docroot}>
 DocumentRoot "/var/www/${docroot}/htdocs"
</Макрос>

Примеры

Определение виртуального хоста

Обычно используется mod_macro для создания динамически генерируемых виртуальных хостов.

 ## Определите макрос VHost для повторяющихся конфигураций
<Macro VHost $host $port $dir>
 Прослушать $ порт
 <Виртуальный хост *:$port>
 имя_сервера $host
 DocumentRoot "$ каталог"
 # Публичный корень документа
 <Каталог "$dir">
 Требовать все предоставленные
 </Каталог>
 # ограничить доступ к подкаталогу интрасети.
 <Каталог "$dir/интрасеть">
 Требовать ip 10.0.0.0/8
 </Каталог>
 </ виртуальный хост>
</Макрос>
## Использование VHost с разными аргументами.
Используйте VHost www.apache.org 80 /vhosts/apache/htdocs
Используйте VHost example.org 8080 /vhosts/example/htdocs
Используйте VHost www.example.fr 1234 /vhosts/example.fr/htdocs

Удаление определения макроса

Рекомендуется отменить определение макроса после его использования. Это позволяет избежать путаницы в сложном файле конфигурации, где могут быть конфликты имен переменных.

 <Группа каталогов макроса $dir $group>
 <Каталог "$dir">
 Требовать группу $группа
 </Каталог>
</Макрос>
Используйте DirGroup /www/apache/private private
Используйте DirGroup /www/apache/server admin
UndefМакрокаталогГруппа

Директива <Макрос>

Описание:	Определить макрос файла конфигурации
Синтаксис:	`<Macro name [par1 .. parN]> ... </Macro>`
Контекст:	конфигурация сервера, виртуальный хост, каталог
Положение дел:	База
Модуль:	mod_macro

Директива <Macro> управляет определением макроса в файлах конфигурации среды выполнения сервера. Первый аргумент — это имя макроса. Другие аргументы являются параметрами макроса. Хорошей практикой является использование префикса имени параметра с любым из символов ' $%@ ', а не имен макросов с такими символами.

 <Политика локального доступа к макросу>
 Требовать ip 10.2.16.0/24
</Макрос>
<Macro RestrictedAccessPolicy $ipnumbers>
 Требовать ip $ipnumbers
</Макрос>

Директива UndefMacro

Описание:	Отменить определение макроса
Синтаксис:	`UndefMacro name`
Контекст:	конфигурация сервера, виртуальный хост, каталог
Положение дел:	База
Модуль:	mod_macro

Директива UndefMacro отменяет определение макроса, который был определен ранее.

 UndefMacro LocalAccessPolicy
UndefMacro RestrictedAccessPolicy

Использовать директиву

Описание:	Использовать макрос
Синтаксис:	`Use name [value1 ... valueN]`
Контекст:	конфигурация сервера, виртуальный хост, каталог
Положение дел:	База
Модуль:	mod_macro

Директива Use управляет использованием макроса. Указанный макрос развернут. Ему должно быть присвоено то же количество аргументов, что и в определении макроса. Предоставленные значения связаны с соответствующими начальными параметрами и заменяются перед обработкой.

 Использовать локальную политику доступа
...
Используйте политику ограниченного доступа "192.54.172.0/24 192.54.148.0/24"

с макросами, определенными выше, эквивалентно:

 Требовать ip 10.2.16.0/24
...
Требуется ip 192.54.172.0/24 192.54.148.0/24