Nginx mogilefs module (v 1.0.4)文档

Nginx mogilefs module (v 1.0.4)
这是nginx第三方模块中mogilefs模块,这个是官方文档具体地址在
http://www.grid.net.ru/nginx/mogilefs.en.html

---

MogileFS client for nginx web server.

Description

The module queries MogileFS tracker specified by mogilefs_tracker directive and uses first path returned by tracker to fetch requested file. The file key is specified by mogilefs_pass directive. If no domain or no file with specified key is found by tracker “404 Not found” status is retuned. If file is found but zero paths are returned by tracker “503 Service unavailable” status is retuned. If tracker has returned successful response the modules tries to fetch file using path with the greatest priority.

Configuration directives

syntax: mogilefs_pass [] {}
default: none
severity: mandatory
context: server, location, limit_except
Specifies key of the file to query from MogileFS tracker. The key can contain any variables. If key is omitted, the part of request URI will be uses as key, which remains after stripping the name of mathced location.

        location /download/ {
            mogilefs_pass {
                [...]
            }
        }

In this example if request URI is /download/example.jpg, the tracker will be queried for file with the key example.jpg.

The fetch block contains configuration which will be used to fetch file from storage node. In this block it is necessary to use proxy_pass directive with $mogilefs_path as an argument. Example:

        mogilefs_pass {
            proxy_pass $mogilefs_path;
            proxy_hide_header Content-Type;
            proxy_buffering off;
        }

The variable $mogilefs_path contains absolute URL to the file on storage node. The fetch block creates a hidden internal location with the name /mogilefs_fetch_XXXXXXXX, where redirected will be performed after successful tracker response.

The variables $mogilefs_path1 ..$mogilefs_path9 contain backup URLs of the file on storage nodes.

syntax: mogilefs_methods <[[method 1] method 2 … ]>
default: GET
severity: optional
context: main, server, location
Specifies which methods will be allowed to access MogileFS. GET retrieves a resource from MogileFS, PUT creates or replaces, DELETE deletes a resource in MogileFS.

syntax: mogilefs_domain
default: default
severity: optional
context: main, server, location
Specifies the name of MogileFS domain to query. The specification may contain variables.

syntax: mogilefs_class [ [ … ] ]
default: N/A
severity: optional
context: main, server, location
This directive specifies what to use as “class” parameter when making a request to tracker. The arguments of this directives will be evaluated and first non-empty value will be used as class. Arguments can contain variables.

syntax: mogilefs_tracker  <IP|IP:port|upstream>
default: none
severity: mandatory
context: main, server, location
Specifies address of MogileFS tracker to query.

syntax: mogilefs_noverify <on/off>
default: off
severity: optional
context: main, server, location
Enables sending of noverify argument to MogileFS.

syntax: mogilefs_connect_timeout <time>
default: 60s
severity: optional
context: main, server, location
Specifies a timeout to be used to connect to mogilefs tracker. Could not be longer than 75 seconds.

syntax: mogilefs_send_timeout <time>
default: 60s
severity: optional
context: main, server, location
Specifies a timeout to be used to send data to mogilefs tracker. If no data will be received by mogilefs tracker during this time interval, nginx will close the connection.

syntax: mogilefs_read_timeout <time>
default: 60s
severity: optional
context: main, server, location
Specifies a timeout to be used to receive data from mogilefs tracker. If no data will be sent by mogilefs tracker during this time interval, nginx will close the connection.

Example configuration

error_log logs/error.log notice;

working_directory /usr/local/nginx;

http {
include mime.types;
default_type application/octet-stream;

server {
    listen       80;

    #
    # This location could be used to retrieve files from MogileFS.
    # It is publicly available.
    #
    location /download/ {
        #
        # Query tracker at 192.168.2.2 for a file with the key
        # equal to remaining part of request URI
        #
        mogilefs_tracker 192.168.2.2;
        mogilefs_domain example_domain;

        mogilefs_pass {
            proxy_pass $mogilefs_path;
            proxy_hide_header Content-Type;
            proxy_buffering off;
        }
    }

    #
    # This location could be used to store or delete files in MogileFS.
    # It may be configured to be accessable only from local network.
    #
    location /upload/ {
        allow 192.168.2.0/24;
        deny all;

        mogilefs_tracker 192.168.2.2;
        mogilefs_domain example_domain;
        mogilefs_methods PUT DELETE;

        mogilefs_pass {
            proxy_pass $mogilefs_path;
            proxy_hide_header Content-Type;
            proxy_buffering off;
        }
    }
}

}

Requirements

nginx 0.7.1 or above is required to compile this module.

Download

Latest version 1.0.4:
File MD5 SHA1
nginx_mogilefs_module-1.0.4.tar.gz 2466aa02b225ad2aa1af22e6e50a9d2f 4f6b774096a77aa8c550d8fd6a3f5d39a661d8ed
nginx_mogilefs_module-1.0.4.zip 4667d8b805aa4ecc94c7353d79a1020a 8d86fa4f0fcb60cdd73195f77fbadf45ac51a875
or go to download area

Browse repository

http://github.com/vkholodkov/nginx-mogilefs-module/tree/master

How to use

Download sources from one of the links above. Unpack the archive:

tar xvzf nginx_mogilefs_module-1.0.4.tar.gz
Configure nginx with additional module:

cd
./configure –add-module=
make
make install
Nginx

nginx – is a web-server, developed by Igor Sysoev.

Licence

The above-described module is an addition to nginx web-server, nevertheless they are independent products. The licence of above-described module is BSD You should have received a copy of license along with the source code. By using the materials from this site you automatically agree to the terms and conditions of this license. If you don’t agree to the terms and conditions of this license, you must immediately remove from your computer all materials downloaded from this site.

Contact author

Valery Kholodkov valery+nginx@grid.net.ru
Please use address extension while composing an Email to me.

Copyright (C) 2009 Valery Kholodkov