Module ngx_http_dav_module

The ngx_http_dav_module module is intended for file management automation via the WebDAV protocol. The module processes HTTP and WebDAV methods PUT, DELETE, MKCOL, COPY, and MOVE.

This module is not built by default, it should be enabled with the --with-http_dav_module configuration parameter.

WebDAV clients that require additional WebDAV methods to operate will not work with this module.

Example Configuration

location / {
    root                  /data/www;

    client_body_temp_path /data/client_temp;

    dav_methods PUT DELETE MKCOL COPY MOVE;

    create_full_put_path  on;
    dav_access            group:rw  all:r;

    limit_except GET {
        allow 192.168.1.0/32;
        deny  all;
    }
}

Directives

Syntax: create_full_put_path on | off;
Default: create_full_put_path off;
Context: http, server, location

The WebDAV specification only allows creating files in already existing directories. This directive allows creating all needed intermediate directories.

Syntax: dav_access users:permissions ...;
Default: dav_access user:rw;
Context: http, server, location

Sets access permissions for newly created files and directories, e.g.:

dav_access user:rw group:rw all:r;

If any group or all access permissions are specified then user permissions may be omitted:

dav_access group:rw all:r;
Syntax: dav_methods off | method ...;
Default: dav_methods off;
Context: http, server, location

Allows the specified HTTP and WebDAV methods. The parameter off denies all methods processed by this module. The following methods are supported: PUT, DELETE, MKCOL, COPY, and MOVE.

A file uploaded with the PUT method is first written to a temporary file, and then the file is renamed. Starting from version 0.8.9, temporary files and the persistent store can be put on different file systems. However, be aware that in this case a file is copied across two file systems instead of the cheap renaming operation. It is thus recommended that for any given location both saved files and a directory holding temporary files, set by the client_body_temp_path directive, are put on the same file system.

When creating a file with the PUT method, it is possible to specify the modification date by passing it in the “Date” header field.

Syntax: min_delete_depth number;
Default: min_delete_depth 0;
Context: http, server, location

Allows the DELETE method to remove files provided that the number of elements in a request path is not less than the specified number. For example, the directive

min_delete_depth 4;

allows removing files on requests

/users/00/00/name
/users/00/00/name/pic.jpg
/users/00/00/page.html

and denies the removal of

/users/00/00

© 2002-2021 Igor Sysoev
© 2011-2021 Nginx, Inc.
Licensed under the BSD License.
https://nginx.org/en/docs/http/ngx_http_dav_module.html