Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 3.43 KB

README.md

File metadata and controls

73 lines (55 loc) · 3.43 KB
Raw

node-fastcgi

Build Status Coverage Status Dependency Status devDependency Status MIT License

NPM

This module is a replacement for node's http module (server only). It can be used to build FastCGI applications or to convert existing node applications to FastCGI.

The implementation is fully compliant with FastCGI 1.0 Specification.

Example

var fcgi = require('node-fastcgi');

fcgi.createServer(function(req, res) {
  if (req.method === 'GET') {
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    res.end("It's working");
  } else {
    res.writeHead(501);
    res.end();
  }
}).listen();

http module compatibility

The API is almost compatible with http module api v0.10.23

Differences:

  • A FastCGI server will never emit 'checkContinue' and 'connect' events because CONNECT method and Expect: 100-continue headers should be handled by the front-end http server
  • The 'upgrade' event is not currently implemented. Typically upgrade/websocket requests won't work with FastCGI applications because of input/output buffering.
  • server.listen() can be called without arguments to listen on the default FastCGI socket { fd: 0 }
  • server.maxHeadersCount is useless
  • request.socket is not a real socket. It's an object containing HTTP server and client address and port (localAddress, localPort, remoteAddress, remotePort properties)
  • request.trailers will always be empty: CGI scripts never receive trailers
  • response.writeContinue() works as expected but should not be used. See first item

License

The MIT License (MIT)

Copyright (c) 2013 Fabio Massaioli

Code from Node http module: Copyright Joyent, Inc. and other Node contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.