FAQ

Page Discussion History

Difference between revisions of "HttpAuthBasicModule"

(auth_basic_user_file)
(Directives)
(2 intermediate revisions by 2 users not shown)
Line 15: Line 15:
  
 
== auth_basic ==
 
== auth_basic ==
 
+
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_auth_basic_module/auth_basic.txt" />
{{Directive|name=auth_basic|args=realm {{!}} off|default=off|context=http, server, location, limit_except|phase=access|vars=no}}
+
  
 
This directive includes testing name and password with HTTP Basic Authentication.
 
This directive includes testing name and password with HTTP Basic Authentication.
Line 24: Line 23:
  
 
== auth_basic_user_file ==
 
== auth_basic_user_file ==
 
+
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_auth_basic_module/auth_basic_user_file.txt" />
{{Directive|name=auth_basic_user_file|args=file|default=none|context=http, server, location, limit_except|phase=access|vars=no}}
+
  
 
This directive sets the htpasswd filename for the authentication realm. Since version 0.6.7 the filename path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.
 
This directive sets the htpasswd filename for the authentication realm. Since version 0.6.7 the filename path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.
Line 49: Line 47:
  
 
= References =
 
= References =
[http://sysoev.ru/nginx/docs/http/ngx_http_auth_basic_module.html Original Documentation]
+
[http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html Original Documentation]
  
 
[http://kbeezie.com/view/protecting-folders-with-nginx/ Protecting Folders with Auth_Basic]
 
[http://kbeezie.com/view/protecting-folders-with-nginx/ Protecting Folders with Auth_Basic]

Revision as of 19:26, 2 May 2012

Contents

Synopsis

You can use this module to protect your site or parts of it with username and password based on HTTP Basic Authentication.

Example configuration

location  /  {
  auth_basic            "Restricted";
  auth_basic_user_file  htpasswd;
}

Directives

auth_basic

Syntax: auth_basic string | off
Default: off
Context: http
server
location
limit_except
Reference:auth_basic


This directive includes testing name and password with HTTP Basic Authentication. The assigned parameter is used as authentication realm. A value of "off" makes it possible to override the action for the inheritable from a lower-level directive.


auth_basic_user_file

Syntax: auth_basic_user_file file
Default:
Context: http
server
location
limit_except
Reference:auth_basic_user_file


This directive sets the htpasswd filename for the authentication realm. Since version 0.6.7 the filename path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.

The format of file is the following:

user:pass
user2:pass2:comment
user3:pass3

Passwords must be encoded by function crypt(3). If Apache is installed, you can create the password file using the htpasswd program included. Note: Apache uses MD5 for encryption.

Since version 1.0.3 nginx supports "$apr1", "{PLAIN}" and "{SSHA}" password encryption methods.

This file should be readable by workers, running from unprivileged user. E. g. when nginx run from www you can set permissions as

chown root:nobody htpasswd_file
chmod 640 htpasswd_file

See also: How do I generate an htpasswd file without having Apache tools installed?

References

Original Documentation

Protecting Folders with Auth_Basic