Author

Mike Dirolf <mike@dirolf.com>

nginx-gridfs is an Nginx module to serve content directly from MongoDB's GridFS.

nginx-gridfs requires the Mongo-C-Driver which is a submodule to this repository.

Installing Nginx modules requires rebuilding Nginx from source:

• Grab the Nginx source and unpack it.
• Clone this repository somewhere on your machine.
• Change to the directory containing the Nginx source.

• Now build:

  $ ./configure --add-module=/path/to/nginx-gridfs/source/
  $ make
  $ make install

Here is the relevant section of an nginx.conf:

location /gridfs/ {
    gridfs;
    gridfs_db my_app;

    # these are the default values:
    mongod_host 127.0.0.1:27017;
    gridfs_root_collection fs;
    gridfs_field _id; # Supported {_id, filename} 
    gridfs_type objectid; # Supported {objectid, string, int}
}

The only required configuration variables are gridfs to enable the module for this location and gridfs_db to specify the database in which to store files. mongod_host and gridfs_root_collection can be specified but default to the values given in the configuration above.

This will set up Nginx to serve the file in gridfs with filename foo for any request to /gridfs/foo

• Some issues with large files
• Use mimetype stored in GridFS file (also maybe fall back to guessing by extension?)
• HTTP range support for partial downloads
• Use a single persistent connection
• URL decode filenames
• Better error handling / logging
• Support for getting files by _id (in case there are duplicate filenames)

• Sho Fukamachi (sho) - towards compatibility with newer boost versions
• Olivier Bregeras (stunti) - better handling of binary content
• Chris Heald (cheald) - better handling of binary content
• Chris Triolo (ctriolo) - easier build process

nginx-gridfs is dual licensed under the Apache License, Version 2.0 and the GNU General Public License, either version 2 or (at your option) any later version. See LICENSE for details.