<?xml version="1.0"?>

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Директивы модуля ngx_http_auth_basic_module"
        link="/ru/docs/http/ngx_http_auth_basic_module.html"
        lang="ru">

<section id="summary">

<para>
Модуль ngx_http_auth_basic_module позволяет закрыть доступ с проверкой
имени и пароля по протоколу HTTP Basic Authentication.
</para>

</section>


<section name="Пример конфигурации" id="example">

<para>
<example>
    location  /  {
        auth_basic            "closed site";
        auth_basic_user_file  conf/htpasswd;
    }
</example>
</para>

</section>


<section name="Директивы" id="directives">

<directive name="auth_basic">
<syntax><value>строка</value> | <literal>off</literal></syntax>
<default>off</default>
<context>http, server, location, limit_except</context>

<para>
Директива включает проверку имени и пароля по протоколу
HTTP Basic Authentication.
Заданный параметр используется в качестве realm.
Параметр "off" позволяет отменить действие унаследованной с нижележащего
уровня директивы.
</para>

</directive>


<directive name="auth_basic_user_file">
<syntax><value>файл</value></syntax>
<default/>
<context>http, server, location, limit_except</context>

<para>
Директива задаёт файл, в котором хранятся имена и пароли
пользователей. Формат файла следующий:
<example>
# комментарий
имя1:пароль1
имя2:пароль2:комментарий
имя3:пароль3
</example>
</para>

<para>
Пароли должны быть зашифрованы функцией crypt(3).
Для создания файла с паролями можно воспользоваться программой
<command>htpasswd</command> из дистрибутива Apache.
</para>

</directive>

</section>

</module>