Description

Nginx has a mechanism whereby, by returning an X-Accel-Redirect header, a web app may convince nginx to serve a static file directly. PEP 333 defines a mechanism whereby an app server (or middleware) can offer to serve files directly by providing wsgi.file_wrapper in the environ. This package provides a piece of WSGI middleware to take advantage of those two mechanisms.

Despite the name of the package, currently this middleware only works with nginx’s X-Accel-Redirect mechanism. (It would probably be straightforward to generalize it so that it works X-Sendfile, but at the moment, I have no need for that.)

Download & Source

The source repository is on github. You may submit bug reports and pull requests there.

It is also available via PyPI.

Usage

The middleware is xsendfile_middleware.xsendfile_middleware. You can call it directly, e.g.:

from xsendfile_middleware import xsendfile_middleware

def main(**settings):
    """ Construct and return a filtered app.
    """
    def my_app(environ, start_response):
        # ...
        return app_iter

    # wrap middleware around app
    return xsendfile_middleware(my_app)

There is also a suitable entry point provided so that you can instantiate the middleware from a PasteDeploy .ini file, e.g.:

[app:myapp]
use = egg:MyEgg

[pipeline:main]
pipeline = egg:xsendfile_middleware myapp

Configuration

location /app {
  uwsgi_pass 127.0.0.1:6543;
  include uwsgi_params;

  uwsgi_param X_REDIRECT_MAP /path/to/files/=/_redir_/;
}

location /_redir_/ {
  internal;
  alias /path/to/files/;
}

Author

This package was written by Jeff Dairiki.

0.1.1 (2016-10-28)

(Release 0.1 does not exist. It had corrupt rST in its PKG-INFO causing the README on PyPI not to be formatted.)

No changes (other than test configuration) from 0.1a3. This package has been used in production for years now — might as well drop the “alpha” designation.

0.1a3 (2015-05-08)

Brown bag. The previous release was unusable do to this bug:

• Make sure not to include unicode strings in the headers passed to start_response.

0.1a2 (2015-05-08)

• Py3k, pypy compatibility: the tests now run under python 2.6, 2.7, 3.2, 3.3, 3.4, pypy and pypy3.

0.1a1 (2013-12-11)

Initial Release