“local_scan
”: Частная опция для функции
“local_scan()
”. Если вы хотите использовать эту возможность, вы должны задать
LOCAL_SCAN_HAS_OPTIONS=yes
|
в
“Local/Makefile
” до сборки exim. Полные данные о средстве
“local_scan()
” даны в разделе 41.
Начальные и замыкающие пробелы в строках конфигурации всегда игнорируются.
Пустые строки в файле, и строки начинающиеся с символа
“#
” (игнорируя начальное пустое пространство) обрабатываются как комментарии и игнорируются. Примечание: Символ
“#
” кроме как в начале строки не обрабатывается специальным образом, и не является комментарием.
Любая строка не являющаяся комментарием может быть продолжена, если её завершить символом обратного слэша (
“\
”). Обратите внимание, что общее правило, для пустого пространства, означает, что появление пробелов после обратного слэша и начальных пробелов в начале строк продолжения игнорируется. Строки комментариев, начинающиеся с
“#
” (но не пустые строки), могут появиться в середине последовательности строк продолжения.
Удобный способ создания конфигурационного файла заключается в том, чтобы начать с дефолтового, представленного в
“src/configure.default
”, и добавлять, удалять или изменять настройки как требуется.
ACL`ы, правила повторов, и правила перезаписи имеют их собственный синтаксис, который описан в разделах 39, 32 и 31 соответственно. Другие части конфигурационного файла имеют некоторые общие синтаксические пункты, и они описаны ниже, от раздела 6.10 и далее. До этого описаны средства включения, макрокоманд и условий средств.
6.3 Включения файлов в конфигурационный файл
Вы можете включать другие файлы внутри файла рабочей конфигурации exim`a, используя этот синтаксис:
.include <file name>
.include_if_exists <file name>
|
в отдельных строках. Двойные кавычки вокруг имени файла - опциональны. Если вы используете первую форму, если файл не существует, происходит ошибка конфигурации; вторая форма, ничего не делает, в случае несуществующих файлов. Во всех случаях, требуются абсолютные имена.
Включенный файл может быть на любой глубине вложенности, но помните, что exim часто читает конфигурационный файл, поэтому хорошей идеей будет хранить их на минимальной глубине. Если вы меняете содержимое инклюженного файла, вы должны дать даемону сигнал HUP, поскольку заинклюженный файл в момент чтения конфигурации в режиме доступа - только на чтение.
Обработка включений происходит рано, на физическом уровне строки, таким образом, как и строки комментариев, включения могут использоваться в середине параметра настройки, например:
hosts_lookup = a.b.c \
.include /some/file
|
Процесс включения происходит после обработки макрокоманд (смотрите ниже). Этот эффект обрабатывает включенные строки так, как будто они находятся в месте, где произошло включение.
6.4 Макросы в конфигурационном файле
Если строка, в основной части конфигурации (т.е. до первой строки
“begin
”), начинается с символа верхнего регистра, она берётся как макроопределение, и должна иметь форму:
<name> = <rest of line><name> = <rest of line>
|
Имя должно состоять из букв, цифр и символов подчёркивания, и нет необходимости, чтобы все они были в верхнем регистре, хотя это рекомендуется. Оставшаяся часть строки, включая любое продолжение, является текстом замены, и из неё удаляется начальное и завершающее пустое пространство. Кавычки не удаляются. Текст замены не может завершаться символом обратного слэша, но это несерьёзное ограничение.
Макрос, также может быть задан между роутером и транспортом, аутентификатором, или определением ACL. Однако, они не могут быть определены внутри определённых драйверов или ACL, или в
“local_scan
”, или секции повторов конфигурации.
6.5 Макроподстановка
Как только макрос определён, все последующие строки файла (и любых заинклюженных файлов) сканируются на предмет имени макроса; если есть несколько макросов, строки сканируются по очереди их опредления, для каждого макроса. Текст замены не сканируется повторно, для текущей макрокоманды, хотя он сканируется для впоследствии заданных макросов. Поэтому, имена макрокоманд, не могут содержать, как подстроку, имя ранее заданного макроса. Например, вы могли бы задать
ABCD_XYZ = <something>
ABCD = <something else>
|
но помещение объявлений в обратном порядке, вызвало бы конфигурационную ошибку. Раскрытие макросов применяется к индивидуальным физическим строкам файла, до проверки продолжения строки или включений (смотрите выше). Если строка состоит лишь из имени макроса, и раскрытие макроса пустое, строка игнорируется. Макрос, в начале строки, может превратить строку в строку комментария, или в строку
“.include
”.
6.6 Переопределение макроса
После определения, значение макроса может быть переопределено позднее, в конфигурации (или в заинклюженом файле). Переопределение задаётся использованием
“==
” вместо
“=
”. Например:
MAC = initial value
...
MAC == updated value
|
Переопределение не меняет порядок в котором макрос применяется к последующим строкам конфигурации. Порядок остаётся тем же самым, в котором макросы были изначально заданы. Всё, что изменяется, - значение макроса. Переопределение позволяет накапливать значения. Например:
MAC = initial value
...
MAC == MAC and something added
|
Это может быть полезным в ситуации, когда конфигурационный файл собирается из множества других файлов.
6.7 Отмена значения макроса
Набор значений для макроса, в конфигурационном файле, может быть отменён опцией
“-D
” командной строки, но при её использовании, exim снимает свои root`овые права, если он вызван не root`ом или пользователем exim`a. Задание опции
“-D
”, в командной строке, заставляет игнорироваться все определения и переопределения в пределах файла.
6.8 Пример использования макроса
Как пример макроса, рассмотрим конфигурацию, где альясы ищутся в ДБ MySQL. Это помогает оставить файл менее беспорядочным, если длинные строки, например SQL-запросы, определены отдельно, как макрос, например:
ALIAS_QUERY = select mailbox from user where \
login=${quote_mysql:$local_part};
|
Тогда это может использоваться в роутере
“redirect
”, устанавливаемом примерно так:
data = ${lookup mysql{ALIAS_QUERY}}
|
В более ранних версиях exim, макрос, иногда, использовался для списков доменов, хостов, или адресов. В exim v4 они лучше обрабатываются именованными списками - смотрите раздел 10.5.
6.9 Условные пропуски в конфигурационном файле
Вы можете использовать директивы
“.ifdef
”,
“.ifndef
”,
“.elifdef
”,
“.elifndef
”,
“.else
” и
“.endif
” для динамического включения или исключения частей конфигурационного файла. Обработка происходит каждый раз, когда файл читается (т.е. когда запускается бинарник exim).
Реализация очень проста. Примеры четырёх первых директив должны сопровождаться текстом, включающим имена одного и более макросов. Условие проверяется, действительно ли происходила подстановка макроса в строке. Таким образом:
.ifdef AAA
message_size_limit = 50M
.else
message_size_limit = 100M
.endif
|
устанавливает ограничение размера сообщения в 50mb, если задан макрос
“AAA
”, и 100mb в ином случае. Если задано более одного имени макроса в строке, условие истинно, если задано любое из них. Таким образом, это условие
“or
” (
“или
”). Чтобы получить условие
“and
”, вам необходимо использовать вложенное
“.ifdefs
”.
Хотя вы можете использовать макрораскрытие для создания одной из этих директив, это не очень полезно, поскольку условие
“в этой строке была макроподстановка
” (
“there was a macro substitution in this line
”) будет всегда истинным.
Текст следующий за
“.else
” и
“.endif
” игнорируется, и может использоваться как комментарий, чтобы сделать пояснения к сложным вложениям.
6.10 Общий синтаксис опции
Для основного набора опций, опций драйвера и опции
“local_scan()
”, каждая настройка находится на отдельной строке, и начинается с имени, состоящего из символов в нижнем регистре, и символов подчёркивания. Многие опции требуют значение с данными, и в этом случае, имя должно сопровождаться символом равно (
“=
”), с опциональными пробелами, и затем значение. Например:
qualify_domain = mydomain.example.com
|
Некоторые параметры настройки могут содержать уязвимые данные, например, пароль для доступа к базам данных. Для недопущения прочтения этих значений неадминистративными пользователями, используя опцию командной строки
“-bP
”, вы можете предварять их словом
“hide
” (
“скрыть
”). Например:
hide mysql_servers = localhost/users/admin/secret-password
|
Для неадминистративных пользователей, такие опции отображаются как в примере:
mysql_servers = <value not displayable>
|
Если
“hide
” используется в опции драйвера, оно скрывает значение этой опции во всех проявлениях этого драйвера.
Следующие разделы описывают синтаксис используемый для различных типов данных, находящихся в параметрах настроек.
6.11 Булевы опции
Опции, тип которых даётся как булева переменная (логическая переменная - прим. lissyara) - переключатели on/off. Возможны два способа определить такие опции: с и без значением данных. Если имя опции указано само по себе, без данных, - это значит
“on
”; если ему предшествует
“no_
” или
“not_
” - это значит
“off
”. Однако, булевы опции могут быть сопровождены символом равно
“=
”, и одним из слов
“true
”,
“false
”,
“yes
”, или
“no
”, как альтернативный синтаксис. Например, следующие два параметра настройки, будут иметь одинаковый эффект:
queue_only
queue_only = true
|
Следующие две строки, также, имеют одинаковый (обратный) эффект:
no_queue_only
queue_only = false
|
Вы можете использовать тот синтаксис, который предпочитаете.
6.12 Целочисленные значения
Если целочисленные элемент данных начинается с символов
“0x
”, оставшаяся его часть интерпретируется как шестнадцатеричное число. Иначе, он обрабатывается как восьмеричный, если начинается с цифры
“0
”, и десятичное - в остальных случаях. Если целочисленное значение сопровождается символом
“K
”, оно умножается на 1024; если оно сопровождается символом
“M
”, оно умножается на 1024x1024.
Когда выводятся значения целочисленных опций, значения, являющиеся точным множителем 1024 или 1024x1024, иногда, но не всегда, печатаются с использованием символов
“K
” и
“M
”. Стиль печати независим от использовавшегося, фактического, входного формата.
6.13 Целочисленные восьмеричные значения
Значение опции, указанной как восьмеричное целое число, всегда интерпретируется в восьмеричном виде, независимо, начинается оно или нет, с цифры ноль. Такие опции всегда выводятся в восьмеричном виде.
6.14 Числовые значения с фиксированной точкой
Число с фиксированной точкой состоит из десятичного целого, опционально сопровождаемого десятичной точкой и до трёх дальнейших цифр.
6.15 Значения временных интервалов
Интервал времени указывается как последовательность чисел, каждое сопровождаемое буквой, без пробелов:
буква
|
значение
|
s
|
секунды
|
м
|
минуты
|
h
|
часы
|
d
|
дни
|
w
|
недели
|
|
Например,
“3h50m
” задаёт 3 часа и 50 минут. Значения временных интервалов выводятся в таком же формате. Exim не ограничивает значения; он допускает, например, указать
“90m
” вместо
“1h30m
”.
6.16 Строковые значения
Если строковые элементы данных не начинаются с символа двойной кавычки, он берётся как состоящий из остатка строки, плюс любые строки продолжения, начинающиеся с первого символа после любых начальных пробелов, с удалением пробелов в конце, и без интерпретации символов в строке. Поскольку exim удаляет строки комментариев (т.е. начинающиеся с
“#
”) на ранней стадии, они могут появляться в середине многостроковых строк. Поэтому следующие настройки эквивалентны:
trusted_users = uucp:mail
trusted_users = uucp:\
# This comment line is ignored
mail
|
Если строка начинается с символа двойной кавычки, она должна завершаться заключительной двойной кавычкой, и любые символы обратного слэша, кроме как используемые для продолжения строки, интерпретируются как специальные символы (escape-последовательность), следующим образом:
последовательность
|
значение
|
\\
|
одиночный обратный слэш
|
\n
|
символ новой строки
|
\r
|
символ возврата каретки
|
\t
|
символ табуляции (TAB)
|
\<octal digits>
|
до трёх восьмеричных цифр определяющих один символ
|
\x<hex digits>
|
до двух шестнадцатеричных цифр определяющих один символ
|
|
Если обратные слэш сопровождается какими-то другими символами, включая двойные кавычки, этот символ заменяет пару (пару обратный слэш и символ - прим. lissyara).
Квотирование (помещение в двойные кавычки - прим. lissyara) необходимо лишь если вы хотите использовать escape-последовательности для вставки специальных символов, или необходимо определить значение с начальными и конечными пробелами. Эти случаи редки, таким образом использование двойных кавычек почти не необходимо в текущих версиях exim`a. В версиях exim до 3.14, двойные кавычки требовались для продолжения строки, таким образом, вы можете натолкнуться на старые конфигурационные файлы, и примеры, в которых применяется излишнее использование двойных кавычек.
6.17 Раскрытие строк
Некоторые строки в конфигурационном файле подвергаются
“раскрытию строки
” (
“string expansion
”), при помощи которого различные части строки могут быть заменены, по обстановке (смотрите раздел 11). Входной синтаксис для таких строк лишь описан; в частности, обработка обратных слэшей внутри квотированных (находящихся внутри двойных кавычек - прим. lissyara) строк производится как часть входного процесса, до того как имеет место раскрытие. Однако, обратный слэш - также символ экранировки для раскрытия, таким образом, любые требуемые обратные слэши должны быть удвоены, если они в пределах конфигурационной строки в кавычках.
6.18 Имена пользователей и групп
Имена пользователей и групп задаются как строки, с использованием синтаксиса описанного выше, но строки интерпретируются специальным образом. Имя пользователя или группы должно состоять полностью из цифр, или именем, которое может быть найдено функциями
“getpwnam()
” или
“getgrnam()
” соответственно.
6.19 Построение списков
Данные для некоторых конфигурационных опций - список элементов, с двоеточием в качестве дефолтового разделителя. Многие из этих опций оказываются типом
“список строк
” (
“string list
”) в описаниях, позже, в этом документе.Другие перечислены как
“domain list
”,
“host list
”,
“address list
”, или
“local part list
”. Синтаксически, они все одинаковы; однако, все, кроме
“string list
”, являются объектами для интерпретации, как описано в разделе 10.
Во всех случаях, весь список обрабатывается как единая длинная строка, как того требует синтаксис. Пример - установка опции
“trusted_users
”, выше, в секции 6.16. Если реально необходимо использовать двоеточие как элемент в списке, оно должно быть введено как два двоеточия. Начальные и конечные пробелы, в каждом элементе списка, игнорируются. Это позволяет включать элементы начинающиеся с двоеточия, в частности, определённые формы адресов IPv6. Например, список:
local_interfaces = 127.0.0.1 : ::::1
|
содержит два IP адреса, адрес IPv4
“127.0.0.1
” и адрес IPv6
“::1
”.
Примечание: Несмотря на то, что начальные и конечные пробелы игнорируются в списке индивидуальных элементов, они не игнорируются при парсинге списка. Пробел после первого двоеточия, в примере выше, необходим. Если бы его там не было, то список интерпретировался бы как два элемента
“127.0.0.1::
” и
“1
”.
Удвоение двоеточий в адресах IPv6 - неприятная рутинная операция, таким образом был предоставлен механизм позволяющий изменить разделитель списка. Если список начинается с левой угловой скобки, сопровождаемой каким-либо символом пунктуации, этот символ используется, вместо двоеточия, как разделитель элементов списка. Для примера, список выше, может быть переписан с использованием точки с запятой в качестве разделителя:
local_interfaces = <; 127.0.0.1 ; ::1
|
Это средство применяется ко всем спискам, за исключением списка в
“log_file_path
”. Рекомендуется, использовать иные символы, кроме двоеточия, было ограничено обстоятельствами, где они реально необходимы.
6.20 Пустые элементы в списках
Пустые элементы в конце списков всегда игнорируются. Другими словами, конечный символ разделителя игнорируется. Таким образом, список в
содержит лишь один элемент. Если вы хотите включить пустую строку в качестве одного из элементов списка, она не должна быть последним элементом списка. Например, этот список содержит три элемента, второй из которых пустой:
senders = user1@domain : : user2@domain
|
Примечание: Должно быть пустое пространство, между этими двумя двоеточиями, иначе они будут интерпретированы как один символ двоеточия (и тогда список содержал бы лишь один элемент). Если вы хотите задать список, содержащий лишь один пустой элемент, вы можете сделать это, как в этом примере:
В этом случае, первый элемент пуст, и второй игнорируется, поскольку он в конце списка.
6.21 Формат конфигурации драйвера
Есть отдельные части в конфигурации, для определения роутеров, транспортов и аутентификаторов. В каждой части, вы определяете множество примеров драйверов, каждый с его собственным набором опций. Каждый пример драйвера задаётся последовательностью строк, такого типа:
<instance name>:
<option>
...
<option>
|
В следующем примере, имя образца -
“localuser
”, и он сопровождается тремя опциями:
localuser:
driver = accept
check_local_user
transport = local_delivery
|
Для каждого образца драйвера, вы определяете, какой модуль кода exim он использует - путём установки опции
“driver
”, и, опционально, некоторые параметры конфигурации. Например, в случае транспортов, если вы хотите чтобы транспорт доставлял по SMTP, вы бы использовали драйвер
“smtp
”; если вы хотите доставлять в локальный файл, вы бы использовали драйвер
“appendfile
”. Каждый из драйверов подробно описан в его собственной главе, позже, в этом руководстве.
Вы можете иметь несколько роутеров, транспортов или аутентификаторов которые основаны на одном и том же основном драйвере (каждый должен иметь своё имя).
Порядок, в котором определены роутеры, важен, потому что адреса передаются на индивидуальные маршрутизаторы по одному, по порядку. Порядок в котором заданы транспорты, не имеет значения. Порядок в котором определены аутентификаторы, используется только когда exim, как клиент, ищет их, чтобы найти тот, который соответствует предлагаемому сервером механизму аутентификации.
В пределах определения образца драйвера, есть два вида опций:
“универсальный
” (
“generic
”) и
“частный
” (
“private
”). Общие опции - те, которые применяются ко всем драйверам, одного типа (т.е. все роутеры, все транспорты, или все аутентификаторы). Опция
“driver
” - общая опция, которая должна появляться в каждом определении. Частные опции являются специальными для каждого драйвера, и ни одна не должна появляться, поскольку все они имеют значения по умолчанию.
Опции могут появляться в любом порядке, за исключением, что опция
“driver
” должна предшествовать частным опциям, поскольку они зависимы от неё. Поэтому, рекомендуется, чтобы опция
“driver
” всегда была первой.
Имена экземпляров драйверов, которые используются для ссылок в логах, и других местах, могут быть любой последовательностью букв, цифр, и подчёркиваний (начинающихся с буквы), и должны быть уникальными среди драйверов того же типа. Роутер и транспорт (для примера), могут иметь одинаковое имя, но никакие два маршрутизатора не могут быть с одним именем. Имя экземпляра драйвера не должно быть перепутано с именем базового модуля драйвера. Например, конфигурационные строки:
remote_smtp:
driver = smtp
|
создают экземпляр драйвера транспорта
“smtp
”, имя которого
“remote_smtp
”. Тот же самый код драйвера может использоваться более одного раза, с различными именами экземпляров и различными параметрами настроек, в каждом случае. Второй экземпляр транспорта
“smtp
”, с другими опциями, может быть задан таким образом:
special_smtp:
driver = smtp
port = 1234
command_timeout = 10s
|
Имена
“remote_smtp
” и
“special_smtp
” использовались бы для ссылки на эти экземпляры транспорта из маршрутизаторов, и эти имена фигурировали бы в строках логов.
Строки комментариев могут присутствовать в середине спецификации драйвера. Полный список опций настройки для любого частного драйвера, включая все дефолтовые значения, может быть создан, используя опцию командной строки
“-bP
”.
=============
translated by lissyara
Ссылка на обсуждение: http://forum.lissyara.su/viewforum.php?f=20.